REST Resource: organizations.locations.cloudControlDeployments

Resource: CloudControlDeployment

A cloud control deployment represents the deployment of a particular cloud control on a target resource. Supported target resources are organizations/{organizationID}, folders/{folderID}, and projects/{projectID}.

JSON representation 
{
  "name": string,
  "targetResourceConfig": {
    object (TargetResourceConfig)
  },
  "targetResource": string,
  "cloudControlMetadata": {
    object (CloudControlMetadata)
  },
  "description": string,
  "deploymentState": enum (DeploymentState),
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "parameterSubstitutedCloudControl": {
    object (CloudControl)
  },
  "frameworkDeploymentReferences": [
    {
      object (FrameworkDeploymentReference)
    }
  ],
  "targetResourceDisplayName": string
}
Fields
name

string

Identifier. The name for the cloud control deployment, in the format organizations/{organization}/locations/{location}/cloudControlDeployments/{cloudControlDeploymentId}. The only supported location is global.
targetResourceConfig

object (TargetResourceConfig)

Required. The details of the target resource that the cloud control is deployed You can use an existing target resource or create a new target.
targetResource

string

Output only. The resource that the cloud control is deployed on, in one of the following formats:

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

object (CloudControlMetadata)

Required. The deployment mode and parameters for the cloud control.
description

string

Optional. A friendly description for the cloud control deployment.
deploymentState

enum (DeploymentState)

Output only. The state of the cloud control deployment.
createTime

string (Timestamp format)

Output only. The time when the resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time when the resource was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
etag

string

Optional. To prevent concurrent updates from overwriting each other, provide the etag when you update a cloud control deployment. You can also provide the etag when you delete a cloud control deployment to help ensure that you're deleting the intended version of the deployment.
parameterSubstitutedCloudControl

object (CloudControl)

Output only. The cloud control after the given parameters are substituted.
frameworkDeploymentReferences[]

object (FrameworkDeploymentReference)

Output only. The references to the framework deployments that this cloud control deployment is part of. A cloud control deployment can be part of multiple framework deployments.
targetResourceDisplayName

string

Output only. The display name of the target resource.

FrameworkDeploymentReference

The reference to a framework deployment.

JSON representation 
{
  "frameworkDeployment": string,
  "frameworkReference": {
    object (FrameworkReference)
  },
  "frameworkDisplayName": string
}
Fields
frameworkDeployment

string

Output only. The name of the framework deployment, in the format organizations/{org}/locations/{location}/frameworkDeployments/{frameworkDeploymentId}. The only supported location is global.
frameworkReference

object (FrameworkReference)

Optional. The reference to the framework that this deployment is for. For example:

{
  framework:
  "organizations/{org}/locations/{location}/frameworks/{framework}",
  majorRevisionId: 1
}

The only supported location is global.
frameworkDisplayName

string

Optional. The display name of the framework that this framework deployment is for.

Methods

get

 Gets details about a cloud control deployment.

list

 Lists the cloud conrol deployments in a given parent resource.