Reference documentation and code samples for the Cloud Security Compliance V1 API class Google::Cloud::CloudSecurityCompliance::V1::CloudControl.
A CloudControl is the fundamental unit encapsulating the rules to meet a specific security or compliance intent. It can contain various rule types (like Organization Policies, CEL expressions, etc.) enabling different enforcement modes (Preventive, Detective, Audit). CloudControls are often parameterized for reusability and can be either BUILT_IN (provided by Google) or CUSTOM (defined by the user).
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#categories
def categories() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlCategory>
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlCategory>) — Optional. The categories of the cloud control.
#categories=
def categories=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlCategory>
- value (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlCategory>) — Optional. The categories of the cloud control.
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlCategory>) — Optional. The categories of the cloud control.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The last updated time of the cloud control. The create_time is used because a new CC is created whenever we update an existing CC.
#description
def description() -> ::String
- (::String) — Optional. A description of the cloud control. The maximum length is 2000 characters.
#description=
def description=(value) -> ::String
- value (::String) — Optional. A description of the cloud control. The maximum length is 2000 characters.
- (::String) — Optional. A description of the cloud control. The maximum length is 2000 characters.
#display_name
def display_name() -> ::String
- (::String) — Optional. The display name of the cloud control. The maximum length is 200 characters.
#display_name=
def display_name=(value) -> ::String
- value (::String) — Optional. The display name of the cloud control. The maximum length is 200 characters.
- (::String) — Optional. The display name of the cloud control. The maximum length is 200 characters.
#finding_category
def finding_category() -> ::String
- (::String) — Optional. The finding_category of the cloud control. The maximum length is 255 characters.
#finding_category=
def finding_category=(value) -> ::String
- value (::String) — Optional. The finding_category of the cloud control. The maximum length is 255 characters.
- (::String) — Optional. The finding_category of the cloud control. The maximum length is 255 characters.
#major_revision_id
def major_revision_id() -> ::Integer
- (::Integer) — Output only. Major revision of the cloud control incremented in ascending order.
#name
def name() -> ::String
- (::String) — Required. Identifier. The resource name of the cloud control. Format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id}
#name=
def name=(value) -> ::String
- value (::String) — Required. Identifier. The resource name of the cloud control. Format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id}
- (::String) — Required. Identifier. The resource name of the cloud control. Format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id}
#parameter_spec
def parameter_spec() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::ParameterSpec>
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::ParameterSpec>) — Optional. The parameter spec of the cloud control.
#parameter_spec=
def parameter_spec=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::ParameterSpec>
- value (::Array<::Google::Cloud::CloudSecurityCompliance::V1::ParameterSpec>) — Optional. The parameter spec of the cloud control.
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::ParameterSpec>) — Optional. The parameter spec of the cloud control.
#related_frameworks
def related_frameworks() -> ::Array<::String>
- (::Array<::String>) — Output only. The Frameworks that include this CloudControl
#remediation_steps
def remediation_steps() -> ::String
- (::String) — Optional. The remediation steps for the findings generated by the cloud control. The maximum length is 400 characters.
#remediation_steps=
def remediation_steps=(value) -> ::String
- value (::String) — Optional. The remediation steps for the findings generated by the cloud control. The maximum length is 400 characters.
- (::String) — Optional. The remediation steps for the findings generated by the cloud control. The maximum length is 400 characters.
#rules
def rules() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::Rule>
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::Rule>) — Optional. The Policy to be enforced to prevent/detect resource non-compliance.
#rules=
def rules=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::Rule>
- value (::Array<::Google::Cloud::CloudSecurityCompliance::V1::Rule>) — Optional. The Policy to be enforced to prevent/detect resource non-compliance.
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::Rule>) — Optional. The Policy to be enforced to prevent/detect resource non-compliance.
#severity
def severity() -> ::Google::Cloud::CloudSecurityCompliance::V1::Severity
- (::Google::Cloud::CloudSecurityCompliance::V1::Severity) — Optional. The severity of findings generated by the cloud control.
#severity=
def severity=(value) -> ::Google::Cloud::CloudSecurityCompliance::V1::Severity
- value (::Google::Cloud::CloudSecurityCompliance::V1::Severity) — Optional. The severity of findings generated by the cloud control.
- (::Google::Cloud::CloudSecurityCompliance::V1::Severity) — Optional. The severity of findings generated by the cloud control.
#supported_cloud_providers
def supported_cloud_providers() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudProvider>
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudProvider>) — Optional. cloud providers supported
#supported_cloud_providers=
def supported_cloud_providers=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudProvider>
- value (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudProvider>) — Optional. cloud providers supported
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudProvider>) — Optional. cloud providers supported
#supported_enforcement_modes
def supported_enforcement_modes() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::EnforcementMode>
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::EnforcementMode>) — Output only. The supported enforcement mode of the cloud control. Default is DETECTIVE.
#supported_target_resource_types
def supported_target_resource_types() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceType>
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceType>) — Optional. target resource types supported by the CloudControl.
#supported_target_resource_types=
def supported_target_resource_types=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceType>
- value (::Array<::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceType>) — Optional. target resource types supported by the CloudControl.
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceType>) — Optional. target resource types supported by the CloudControl.