GoogleApi.OrgPolicy.V2.Model.GoogleCloudOrgpolicyV2Constraint (google_api_org_policy v0.9.1)

View Source

A constraint describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which Google Cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. Constraints can be configured by the organization policy administrator to fit the needs of the organization by setting a policy that includes constraints at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules, see Policy. Constraints have a default behavior determined by the constraint_default field, which is the enforcement behavior that is used in the absence of a policy being defined or inherited for the resource in question.

Attributes

  • booleanConstraint (type: GoogleApi.OrgPolicy.V2.Model.GoogleCloudOrgpolicyV2ConstraintBooleanConstraint.t, default: nil) - Defines this constraint as being a boolean constraint.
  • constraintDefault (type: String.t, default: nil) - The evaluation behavior of this constraint in the absence of a policy.
  • description (type: String.t, default: nil) - Detailed description of what this constraint controls as well as how and where it is enforced. Mutable.
  • displayName (type: String.t, default: nil) - The human readable name. Mutable.
  • listConstraint (type: GoogleApi.OrgPolicy.V2.Model.GoogleCloudOrgpolicyV2ConstraintListConstraint.t, default: nil) - Defines this constraint as being a list constraint.
  • name (type: String.t, default: nil) - Immutable. The resource name of the constraint. Must be in one of the following forms: projects/{project_number}/constraints/{constraint_name} folders/{folder_id}/constraints/{constraint_name} * organizations/{organization_id}/constraints/{constraint_name} For example, "/projects/123/constraints/compute.disableSerialPortAccess".
  • supportsDryRun (type: boolean(), default: nil) - Shows if dry run is supported for this constraint or not.
  • supportsSimulation (type: boolean(), default: nil) - Shows if simulation is supported for this constraint or not.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.OrgPolicy.V2.Model.GoogleCloudOrgpolicyV2Constraint{
  booleanConstraint:
    GoogleApi.OrgPolicy.V2.Model.GoogleCloudOrgpolicyV2ConstraintBooleanConstraint.t()
    | nil,
  constraintDefault: String.t() | nil,
  description: String.t() | nil,
  displayName: String.t() | nil,
  listConstraint:
    GoogleApi.OrgPolicy.V2.Model.GoogleCloudOrgpolicyV2ConstraintListConstraint.t()
    | nil,
  name: String.t() | nil,
  supportsDryRun: boolean() | nil,
  supportsSimulation: boolean() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.