Reference documentation and code samples for the Cloud Security Compliance V1 API class Google::Cloud::CloudSecurityCompliance::V1::Framework.
A Framework is a collection of CloudControls to address security and compliance requirements. Frameworks can be used for prevention, detection, and auditing. They can be either built-in, industry-standard frameworks provided by GCP/AZURE/AWS (e.g., NIST, FedRAMP) or custom frameworks created by users.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#category
def category() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkCategory>
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkCategory>) — Optional. The category of the framework.
#category=
def category=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkCategory>
- value (::Array<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkCategory>) — Optional. The category of the framework.
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkCategory>) — Optional. The category of the framework.
#cloud_control_details
def cloud_control_details() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDetails>
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDetails>) — Optional. The details of the cloud controls directly added without any grouping in the framework.
#cloud_control_details=
def cloud_control_details=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDetails>
- value (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDetails>) — Optional. The details of the cloud controls directly added without any grouping in the framework.
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDetails>) — Optional. The details of the cloud controls directly added without any grouping in the framework.
#description
def description() -> ::String
- (::String) — Optional. The description of the framework. The maximum length is 2000 characters.
#description=
def description=(value) -> ::String
- value (::String) — Optional. The description of the framework. The maximum length is 2000 characters.
- (::String) — Optional. The description of the framework. The maximum length is 2000 characters.
#display_name
def display_name() -> ::String
- (::String) — Optional. Display name of the framework. The maximum length is 200 characters.
#display_name=
def display_name=(value) -> ::String
- value (::String) — Optional. Display name of the framework. The maximum length is 200 characters.
- (::String) — Optional. Display name of the framework. The maximum length is 200 characters.
#major_revision_id
def major_revision_id() -> ::Integer
- (::Integer) — Output only. Major revision of the framework incremented in ascending order.
#name
def name() -> ::String
- (::String) — Required. Identifier. The name of the framework. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}
#name=
def name=(value) -> ::String
- value (::String) — Required. Identifier. The name of the framework. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}
- (::String) — Required. Identifier. The name of the framework. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}
#supported_cloud_providers
def supported_cloud_providers() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudProvider>
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudProvider>) — Output only. 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 modes of the framework.
#supported_target_resource_types
def supported_target_resource_types() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceType>
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceType>) — Output only. target resource types supported by the Framework.
#type
def type() -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework::FrameworkType
- (::Google::Cloud::CloudSecurityCompliance::V1::Framework::FrameworkType) — Output only. The type of the framework. The default is TYPE_CUSTOM.