Cloud Security Compliance V1 API - Class Google::Cloud::CloudSecurityCompliance::V1::FrameworkDeployment (v0.2.0)

Reference documentation and code samples for the Cloud Security Compliance V1 API class Google::Cloud::CloudSecurityCompliance::V1::FrameworkDeployment.

Framework deployments represent the assignment of a framework to a target resource. Supported target resources are organizations, folders, and projects.

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. The reference includes all the cloud control deployments that are in the framework or in a cloud control group.

    For example, if a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2, then the references are:

    { 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

#cloud_control_metadata=

def cloud_control_metadata=(value) -> ::Array<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlMetadata>
Parameter
Returns

#computed_target_resource

def computed_target_resource() -> ::String
Returns
  • (::String) —

    Output only. The target resource to deploy the framework to, in one the following formats:

    • organizations/{organizationID}
    • folders/{folderID}
    • projects/{projectID}

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#deployment_state

def deployment_state() -> ::Google::Cloud::CloudSecurityCompliance::V1::DeploymentState
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. A user-provided description of the framework deployment.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. A user-provided description of the framework deployment.
Returns
  • (::String) — Optional. A 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 framework deployment. You can also provide the etag when you delete a framework deployment, to help ensure that you're deleting the intended version of the framework deployment.

#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 framework deployment. You can also provide the etag when you delete a framework deployment, to help ensure that you're deleting the intended version of the framework deployment.
Returns
  • (::String) — Optional. To prevent concurrent updates from overwriting each other, always provide the etag when you update a framework deployment. You can also provide the etag when you delete a framework deployment, to help ensure that you're deleting the intended version of the framework deployment.

#framework

def framework() -> ::Google::Cloud::CloudSecurityCompliance::V1::FrameworkReference
Returns

#framework=

def framework=(value) -> ::Google::Cloud::CloudSecurityCompliance::V1::FrameworkReference
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The name of the framework deployment, in the format organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}. The only supported location is global.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The name of the framework deployment, in the format organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}. The only supported location is global.
Returns
  • (::String) — Identifier. The name of the framework deployment, in the format organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}. The only supported location is global.

#target_resource_config

def target_resource_config() -> ::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceConfig
Returns

#target_resource_config=

def target_resource_config=(value) -> ::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceConfig
Parameter
Returns

#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