Creates a custom constraint. Returns a google.rpc.Status
with google.rpc.Code.NOT_FOUND
if the organization does not exist. Returns a google.rpc.Status
with google.rpc.Code.ALREADY_EXISTS
if the constraint already exists on the given organization.
Scopes
You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform.
You can set the scope for this method like this: orgpolicy2 --scope <scope> organizations custom-constraints-create ...
Required Scalar Argument
- <parent> (string)
- Required. Must be in the following form: *
organizations/{organization_id}
- Required. Must be in the following form: *
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
GoogleCloudOrgpolicyV2CustomConstraint:
action-type: string
condition: string
description: string
display-name: string
method-types: [string]
name: string
resource-types: [string]
update-time: string
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-r . action-type=stet
- Allow or deny type.
condition=kasd
- Org policy condition/expression. For example:
resource.instanceName.matches("[production|test]_.*_(\d)+")
or,resource.management.auto_upgrade == true
The max length of the condition is 1000 characters.
- Org policy condition/expression. For example:
description=et
- Detailed information about this custom policy constraint. The max length of the description is 2000 characters.
display-name=sed
- One line display name for the UI. The max length of the display_name is 200 characters.
method-types=et
- All the operations being applied for this constraint.
- Each invocation of this argument appends the given value to the array.
name=et
- Immutable. Name of the constraint. This is unique within the organization. Format of the name should be *
organizations/{organization_id}/customConstraints/{custom_constraint_id}
Example:organizations/123/customConstraints/custom.createOnlyE2TypeVms
The max length is 70 characters and the minimum length is 1. Note that the prefixorganizations/{organization_id}/customConstraints/
is not counted.
- Immutable. Name of the constraint. This is unique within the organization. Format of the name should be *
resource-types=vero
- Immutable. The resource instance type on which this policy applies. Format will be of the form :
/
Example: *compute.googleapis.com/Instance
. - Each invocation of this argument appends the given value to the array.
- Immutable. The resource instance type on which this policy applies. Format will be of the form :
update-time=erat
- Output only. The last time this custom constraint was updated. This represents the last time that the
CreateCustomConstraint
orUpdateCustomConstraint
RPC was called
- Output only. The last time this custom constraint was updated. This represents the last time that the
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").