Reference documentation and code samples for the Cloud Security Compliance V1 API class Google::Cloud::CloudSecurityCompliance::V1::FrameworkDeployment.
FrameworkDeployment represents deployment of a Framework on a target resource. Supported target resources are organizations/{organization}, folders/{folder}, and projects/{project}.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#cloud_control_deployment_references
def cloud_control_deployment_references() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDeploymentReference>
Returns
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDeploymentReference>) — Output only. The references to the cloud control deployments. It has all the CloudControlDeployments which are either directly added in the framework or through a CloudControlGroup. Example: If a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2, then the cloud_control_deployment_references will be: { cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-1" }, cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-2" }
#cloud_control_metadata
def cloud_control_metadata() -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlMetadata>
Returns
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlMetadata>) — Required. Deployment mode and parameters for each of the Cloud Controls in the framework. Every Cloud Control in the framework must have a CloudControlMetadata.
#cloud_control_metadata=
def cloud_control_metadata=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlMetadata>
Parameter
- value (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlMetadata>) — Required. Deployment mode and parameters for each of the Cloud Controls in the framework. Every Cloud Control in the framework must have a CloudControlMetadata.
Returns
- (::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlMetadata>) — Required. Deployment mode and parameters for each of the Cloud Controls in the framework. Every Cloud Control in the framework must have a CloudControlMetadata.
#computed_target_resource
def computed_target_resource() -> ::String
Returns
- (::String) — Output only. The resource on which the Framework is deployed based on the provided TargetResourceConfig in the following format: organizations/{organization}, folders/{folder} or projects/{project}
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which the resource was created.
#deployment_state
def deployment_state() -> ::Google::Cloud::CloudSecurityCompliance::V1::DeploymentState
Returns
- (::Google::Cloud::CloudSecurityCompliance::V1::DeploymentState) — Output only. State of the Framework Deployment
#description
def description() -> ::String
Returns
- (::String) — Optional. User provided description of the Framework deployment
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. User provided description of the Framework deployment
Returns
- (::String) — Optional. User provided description of the Framework deployment
#etag
def etag() -> ::String
Returns
-
(::String) — Optional. To prevent concurrent updates from overwriting each other, always
provide the
etag
when you update a FrameworkDeployment. You can also provide theetag
when you delete a FrameworkDeployment, to help ensure that you're deleting the intended version of the FrameworkDeployment.
#etag=
def etag=(value) -> ::String
Parameter
-
value (::String) — Optional. To prevent concurrent updates from overwriting each other, always
provide the
etag
when you update a FrameworkDeployment. You can also provide theetag
when you delete a FrameworkDeployment, to help ensure that you're deleting the intended version of the FrameworkDeployment.
Returns
-
(::String) — Optional. To prevent concurrent updates from overwriting each other, always
provide the
etag
when you update a FrameworkDeployment. You can also provide theetag
when you delete a FrameworkDeployment, to help ensure that you're deleting the intended version of the FrameworkDeployment.
#framework
def framework() -> ::Google::Cloud::CloudSecurityCompliance::V1::FrameworkReference
Returns
- (::Google::Cloud::CloudSecurityCompliance::V1::FrameworkReference) — Required. Reference to the framework to be deployed.
#framework=
def framework=(value) -> ::Google::Cloud::CloudSecurityCompliance::V1::FrameworkReference
Parameter
- value (::Google::Cloud::CloudSecurityCompliance::V1::FrameworkReference) — Required. Reference to the framework to be deployed.
Returns
- (::Google::Cloud::CloudSecurityCompliance::V1::FrameworkReference) — Required. Reference to the framework to be deployed.
#name
def name() -> ::String
Returns
- (::String) — Identifier. FrameworkDeployment name in the following format: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Identifier. FrameworkDeployment name in the following format: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}
Returns
- (::String) — Identifier. FrameworkDeployment name in the following format: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}
#target_resource_config
def target_resource_config() -> ::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceConfig
Returns
- (::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceConfig) — Required. The details of the target resource on which the Framework is to be deployed. It can either be an existing target resource or a new target resource to be created.
#target_resource_config=
def target_resource_config=(value) -> ::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceConfig
Parameter
- value (::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceConfig) — Required. The details of the target resource on which the Framework is to be deployed. It can either be an existing target resource or a new target resource to be created.
Returns
- (::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceConfig) — Required. The details of the target resource on which the Framework is to be deployed. It can either be an existing target resource or a new target resource to be created.
#target_resource_display_name
def target_resource_display_name() -> ::String
Returns
- (::String) — Output only. The display name of the target resource.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which the resource last updated.