Reference documentation and code samples for the Cloud Security Compliance V1 API class Google::Cloud::CloudSecurityCompliance::V1::Framework.
A framework is a collection of cloud controls and regulatory controls that represent security best practices or industry-defined standards such as FedRAMP or NIST.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#category
def category() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkCategory>
Returns
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkCategory>) — Optional. The category of the framework.
#category=
def category=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkCategory>
Parameter
- value (::Array<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkCategory>) — Optional. The category of the framework.
Returns
- (::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>
Returns
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDetails>) — Optional. The cloud control details that are directly added without any grouping in the framework.
#cloud_control_details=
def cloud_control_details=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDetails>
Parameter
- value (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDetails>) — Optional. The cloud control details that are directly added without any grouping in the framework.
Returns
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDetails>) — Optional. The cloud control details that are directly added without any grouping in the framework.
#description
def description() -> ::String
Returns
- (::String) — Optional. The description of the framework. The maximum length is 2000 characters.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. The description of the framework. The maximum length is 2000 characters.
Returns
- (::String) — Optional. The description of the framework. The maximum length is 2000 characters.
#display_name
def display_name() -> ::String
Returns
- (::String) — Optional. The friendly name of the framework. The maximum length is 200 characters.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Optional. The friendly name of the framework. The maximum length is 200 characters.
Returns
- (::String) — Optional. The friendly name of the framework. The maximum length is 200 characters.
#major_revision_id
def major_revision_id() -> ::Integer
Returns
- (::Integer) — Output only. The major version of the framework, which is incremented in ascending order.
#name
def name() -> ::String
Returns
-
(::String) — Required. Identifier. The name of the framework, in the format
organizations/{organization}/locations/{location}/frameworks/{framework_id}. The only supported location isglobal.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. Identifier. The name of the framework, in the format
organizations/{organization}/locations/{location}/frameworks/{framework_id}. The only supported location isglobal.
Returns
-
(::String) — Required. Identifier. The name of the framework, in the format
organizations/{organization}/locations/{location}/frameworks/{framework_id}. The only supported location isglobal.
#supported_cloud_providers
def supported_cloud_providers() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudProvider>
Returns
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudProvider>) — Output only. The cloud providers that are supported by the framework.
#supported_enforcement_modes
def supported_enforcement_modes() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::EnforcementMode>
Returns
- (::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>
Returns
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceType>) — Output only. The target resource types that are supported by the framework.
#type
def type() -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework::FrameworkType
Returns
- (::Google::Cloud::CloudSecurityCompliance::V1::Framework::FrameworkType) — Output only. The type of framework.