gcp_orgpolicy_policy

alternate

Type: STRUCT
Provider name: alternate
Description: Deprecated.

• launch
  Type: STRING
  Provider name: launch
  Description: Reference to the launch that will be used while audit logging and to control the launch. Should be set only in the alternate policy.
  
• spec
  Type: STRUCT
  Provider name: spec
  Description: Specify constraint for configurations of Google Cloud resources.
  
  • etag
    Type: STRING
    Provider name: etag
    Description: An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a CreatePolicy request. When the policy is returned from either a GetPolicy or a ListPolicies request, this etag indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a GetEffectivePolicy request, the etag will be unset.
    
  • inherit_from_parent
    Type: BOOLEAN
    Provider name: inheritFromParent
    Description: Determines the inheritance behavior for this policy. If inherit_from_parent is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.
    
  • reset
    Type: BOOLEAN
    Provider name: reset
    Description: Ignores policies set above this resource and restores the constraint_default enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, rules must be empty and inherit_from_parent must be set to false.
    
  • rules
    Type: UNORDERED_LIST_STRUCT
    Provider name: rules
    Description: In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset. - Boolean policy rules with conditions must set enforced to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence.
    
    • allow_all
      Type: BOOLEAN
      Provider name: allowAll
      Description: Setting this to true means that all values are allowed. This field can be set only in policies for list constraints.
      
    • condition
      Type: STRUCT
      Provider name: condition
      Description: A condition which determines whether this rule is used in the evaluation of the policy. When set, the expression field in the `Expr’ must include from 1 to 10 subexpressions, joined by the “||” or “&&” operators. Each subexpression must be of the form “resource.matchTag(’/tag_key_short_name, ’tag_value_short_name’)”. or “resource.matchTagId(’tagKeys/key_id’, ’tagValues/value_id’)”. where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: “resource.matchTag(‘123456789/environment, ‘prod’)”. or “resource.matchTagId(’tagKeys/123’, ’tagValues/456’)”.
      
      • description
        Type: STRING
        Provider name: description
        Description: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        
      • expression
        Type: STRING
        Provider name: expression
        Description: Textual representation of an expression in Common Expression Language syntax.
        
      • location
        Type: STRING
        Provider name: location
        Description: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        
      • title
        Type: STRING
        Provider name: title
        Description: Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
        
    • deny_all
      Type: BOOLEAN
      Provider name: denyAll
      Description: Setting this to true means that all values are denied. This field can be set only in policies for list constraints.
      
    • enforce
      Type: BOOLEAN
      Provider name: enforce
      Description: If true, then the policy is enforced. If false, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints.
      
    • values
      Type: STRUCT
      Provider name: values
      Description: List of values to be used for this policy rule. This field can be set only in policies for list constraints.
      
      • allowed_values
        Type: UNORDERED_LIST_STRING
        Provider name: allowedValues
        Description: List of values allowed at this resource.
        
      • denied_values
        Type: UNORDERED_LIST_STRING
        Provider name: deniedValues
        Description: List of values denied at this resource.
        
  • update_time
    Type: TIMESTAMP
    Provider name: updateTime
    Description: Output only. The time stamp this was previously updated. This represents the last time a call to CreatePolicy or UpdatePolicy was made for that policy.
    

ancestors

Type: UNORDERED_LIST_STRING

dry_run_spec

Type: STRUCT
Provider name: dryRunSpec
Description: Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it’s enforced.

• etag
  Type: STRING
  Provider name: etag
  Description: An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a CreatePolicy request. When the policy is returned from either a GetPolicy or a ListPolicies request, this etag indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a GetEffectivePolicy request, the etag will be unset.
  
• inherit_from_parent
  Type: BOOLEAN
  Provider name: inheritFromParent
  Description: Determines the inheritance behavior for this policy. If inherit_from_parent is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.
  
• reset
  Type: BOOLEAN
  Provider name: reset
  Description: Ignores policies set above this resource and restores the constraint_default enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, rules must be empty and inherit_from_parent must be set to false.
  
• rules
  Type: UNORDERED_LIST_STRUCT
  Provider name: rules
  Description: In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset. - Boolean policy rules with conditions must set enforced to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence.
  
  • allow_all
    Type: BOOLEAN
    Provider name: allowAll
    Description: Setting this to true means that all values are allowed. This field can be set only in policies for list constraints.
    
  • condition
    Type: STRUCT
    Provider name: condition
    Description: A condition which determines whether this rule is used in the evaluation of the policy. When set, the expression field in the `Expr’ must include from 1 to 10 subexpressions, joined by the “||” or “&&” operators. Each subexpression must be of the form “resource.matchTag(’/tag_key_short_name, ’tag_value_short_name’)”. or “resource.matchTagId(’tagKeys/key_id’, ’tagValues/value_id’)”. where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: “resource.matchTag(‘123456789/environment, ‘prod’)”. or “resource.matchTagId(’tagKeys/123’, ’tagValues/456’)”.
    
    • description
      Type: STRING
      Provider name: description
      Description: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
      
    • expression
      Type: STRING
      Provider name: expression
      Description: Textual representation of an expression in Common Expression Language syntax.
      
    • location
      Type: STRING
      Provider name: location
      Description: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
      
    • title
      Type: STRING
      Provider name: title
      Description: Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      
  • deny_all
    Type: BOOLEAN
    Provider name: denyAll
    Description: Setting this to true means that all values are denied. This field can be set only in policies for list constraints.
    
  • enforce
    Type: BOOLEAN
    Provider name: enforce
    Description: If true, then the policy is enforced. If false, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints.
    
  • values
    Type: STRUCT
    Provider name: values
    Description: List of values to be used for this policy rule. This field can be set only in policies for list constraints.
    
    • allowed_values
      Type: UNORDERED_LIST_STRING
      Provider name: allowedValues
      Description: List of values allowed at this resource.
      
    • denied_values
      Type: UNORDERED_LIST_STRING
      Provider name: deniedValues
      Description: List of values denied at this resource.
      
• update_time
  Type: TIMESTAMP
  Provider name: updateTime
  Description: Output only. The time stamp this was previously updated. This represents the last time a call to CreatePolicy or UpdatePolicy was made for that policy.
  

etag

Type: STRING
Provider name: etag
Description: Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This ’etag’ is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Immutable. The resource name of the policy. Must be one of the following forms, where constraint_name is the name of the constraint which this policy configures: * projects/{project_number}/policies/{constraint_name} * folders/{folder_id}/policies/{constraint_name} * organizations/{organization_id}/policies/{constraint_name} For example, projects/123/policies/compute.disableSerialPortAccess. Note: projects/{project_id}/policies/{constraint_name} is also an acceptable name for API requests, but responses will return the name using the equivalent project number.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

spec

Type: STRUCT
Provider name: spec
Description: Basic information about the organization policy.

• etag
  Type: STRING
  Provider name: etag
  Description: An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a CreatePolicy request. When the policy is returned from either a GetPolicy or a ListPolicies request, this etag indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a GetEffectivePolicy request, the etag will be unset.
  
• inherit_from_parent
  Type: BOOLEAN
  Provider name: inheritFromParent
  Description: Determines the inheritance behavior for this policy. If inherit_from_parent is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.
  
• reset
  Type: BOOLEAN
  Provider name: reset
  Description: Ignores policies set above this resource and restores the constraint_default enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, rules must be empty and inherit_from_parent must be set to false.
  
• rules
  Type: UNORDERED_LIST_STRUCT
  Provider name: rules
  Description: In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset. - Boolean policy rules with conditions must set enforced to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence.
  
  • allow_all
    Type: BOOLEAN
    Provider name: allowAll
    Description: Setting this to true means that all values are allowed. This field can be set only in policies for list constraints.
    
  • condition
    Type: STRUCT
    Provider name: condition
    Description: A condition which determines whether this rule is used in the evaluation of the policy. When set, the expression field in the `Expr’ must include from 1 to 10 subexpressions, joined by the “||” or “&&” operators. Each subexpression must be of the form “resource.matchTag(’/tag_key_short_name, ’tag_value_short_name’)”. or “resource.matchTagId(’tagKeys/key_id’, ’tagValues/value_id’)”. where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: “resource.matchTag(‘123456789/environment, ‘prod’)”. or “resource.matchTagId(’tagKeys/123’, ’tagValues/456’)”.
    
    • description
      Type: STRING
      Provider name: description
      Description: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
      
    • expression
      Type: STRING
      Provider name: expression
      Description: Textual representation of an expression in Common Expression Language syntax.
      
    • location
      Type: STRING
      Provider name: location
      Description: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
      
    • title
      Type: STRING
      Provider name: title
      Description: Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      
  • deny_all
    Type: BOOLEAN
    Provider name: denyAll
    Description: Setting this to true means that all values are denied. This field can be set only in policies for list constraints.
    
  • enforce
    Type: BOOLEAN
    Provider name: enforce
    Description: If true, then the policy is enforced. If false, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints.
    
  • values
    Type: STRUCT
    Provider name: values
    Description: List of values to be used for this policy rule. This field can be set only in policies for list constraints.
    
    • allowed_values
      Type: UNORDERED_LIST_STRING
      Provider name: allowedValues
      Description: List of values allowed at this resource.
      
    • denied_values
      Type: UNORDERED_LIST_STRING
      Provider name: deniedValues
      Description: List of values denied at this resource.
      
• update_time
  Type: TIMESTAMP
  Provider name: updateTime
  Description: Output only. The time stamp this was previously updated. This represents the last time a call to CreatePolicy or UpdatePolicy was made for that policy.
  

tags

Type: UNORDERED_LIST_STRING