PostureDeployment

JSON representation

Details for a Posture deployment on an organization, folder, or project.

You can deploy at most one posture to each organization, folder, or project. The parent resource for a posture deployment is always the organization, even if the deployment applies to a folder or project.

JSON representation

JSON representation
{ "name": string, "targetResource": string, "state": enum (`State`), "postureId": string, "postureRevisionId": string, "createTime": string, "updateTime": string, "description": string, "etag": string, "annotations": { string: string, ... }, "reconciling": boolean, "desiredPostureId": string, "desiredPostureRevisionId": string, "failureMessage": string, "categories": [ enum (`Category`) ] }

{
  "name": string,
  "targetResource": string,
  "state": enum (State),
  "postureId": string,
  "postureRevisionId": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "reconciling": boolean,
  "desiredPostureId": string,
  "desiredPostureRevisionId": string,
  "failureMessage": string,
  "categories": [
    enum (Category)
  ]
}

Fields
`name`	`string` Required. The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`.
`targetResource`	`string` Required. The organization, folder, or project where the posture is deployed. Uses one of the following formats: `organizations/{organization_number}` `folders/{folder_number}` `projects/{project_number}`
`state`	`enum (State)` Output only. The state of the posture deployment.
`postureId`	`string` Required. The posture used in the deployment, in the format `organizations/{organization}/locations/global/postures/{postureId}`.
`postureRevisionId`	`string` Required. The revision ID of the posture used in the deployment.
`createTime`	`string (Timestamp format)` Output only. The time at which the posture deployment was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`updateTime`	`string (Timestamp format)` Output only. The time at which the posture deployment was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`description`	`string` Optional. A description of the posture deployment.
`etag`	`string` Optional. An opaque identifier for the current version of the posture deployment. To prevent concurrent updates from overwriting each other, always provide the `etag` when you update a posture deployment. You can also provide the `etag` when you delete a posture deployment, to help ensure that you're deleting the intended posture deployment.
`annotations`	`map (key: string, value: string)` Optional. The user-specified annotations for the posture deployment. For details about the values you can use in an annotation, see AIP-148: Standard fields. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`reconciling`	`boolean` Output only. Whether the posture deployment is in the process of being updated.
`desiredPostureId`	`string` Output only. The posture ID that was specified for the deployment. Present only if the posture deployment is in a failed state.
`desiredPostureRevisionId`	`string` Output only. The revision ID of the posture that was specified for the deployment. Present only if the deployment is in a failed state.
`failureMessage`	`string` Output only. A description of why the posture deployment failed. Present only if the deployment is in a failed state.
`categories[]`	`enum (Category)` Output only. The categories that the posture deployment belongs to, as determined by the Security Posture API.