REST Resource: organizations.locations.frameworkDeployments

Resource: FrameworkDeployment

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

JSON representation 
{
  "name": string,
  "targetResourceConfig": {
    object (TargetResourceConfig)
  },
  "computedTargetResource": string,
  "framework": {
    object (FrameworkReference)
  },
  "description": string,
  "cloudControlMetadata": [
    {
      object (CloudControlMetadata)
    }
  ],
  "deploymentState": enum (DeploymentState),
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "targetResourceDisplayName": string,
  "cloudControlDeploymentReferences": [
    {
      object (CloudControlDeploymentReference)
    }
  ]
}
Fields
name

string

Identifier. The name of the framework deployment, in the format organizations/{organization}/locations/{location}/frameworkDeployments/{frameworkDeploymentId}. The only supported location is global.
targetResourceConfig

object (TargetResourceConfig)

Required. The details of the target resource that you want to deploy the framework to. You can specify an existing resource, or create a new one.
computedTargetResource

string

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

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

object (FrameworkReference)

Required. A reference to the framework that you're deploying.
description

string

Optional. A user-provided description of the framework deployment.
cloudControlMetadata[]

object (CloudControlMetadata)

Required. The deployment mode and parameters for each of the cloud controls in the framework. Every cloud control in the framework includes metadata.
deploymentState

enum (DeploymentState)

Output only. The state for the framework deployment.
createTime

string (Timestamp format)

Output only. The time at which 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 at which the resource 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, 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.
targetResourceDisplayName

string

Output only. The display name of the target resource.
cloudControlDeploymentReferences[]

object (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: {
   cloudControlDeployment:
   "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-1"
 },
 cloud_control_deployment_reference: {
  cloudControlDeployment:
  "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-2"
 }

CloudControlDeploymentReference

The reference to a cloud control deployment.

JSON representation 
{
  "cloudControlDeployment": string
}
Fields
cloudControlDeployment

string

Output only. The name of the CloudControlDeployment. The format is organizations/{org}/locations/{location}/cloudControlDeployments/{cloudControlDeploymentId}. The only supported location is global.

Methods

create

 Creates a framework deployment in a given parent resource.

delete

 Deletes a framework deployment.

get

 Gets details about a framework deployment.

list

 Lists the framework deployments in a given parent resource.