1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. iam
  5. AccessBoundaryPolicy
Google Cloud Classic v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi

gcp.iam.AccessBoundaryPolicy

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi

    Represents a collection of access boundary policies to apply to a given resource. NOTE: This is a private feature and users should contact GCP support if they would like to test it.

    Create AccessBoundaryPolicy Resource

    new AccessBoundaryPolicy(name: string, args: AccessBoundaryPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def AccessBoundaryPolicy(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             display_name: Optional[str] = None,
                             name: Optional[str] = None,
                             parent: Optional[str] = None,
                             rules: Optional[Sequence[AccessBoundaryPolicyRuleArgs]] = None)
    @overload
    def AccessBoundaryPolicy(resource_name: str,
                             args: AccessBoundaryPolicyArgs,
                             opts: Optional[ResourceOptions] = None)
    func NewAccessBoundaryPolicy(ctx *Context, name string, args AccessBoundaryPolicyArgs, opts ...ResourceOption) (*AccessBoundaryPolicy, error)
    public AccessBoundaryPolicy(string name, AccessBoundaryPolicyArgs args, CustomResourceOptions? opts = null)
    public AccessBoundaryPolicy(String name, AccessBoundaryPolicyArgs args)
    public AccessBoundaryPolicy(String name, AccessBoundaryPolicyArgs args, CustomResourceOptions options)
    
    type: gcp:iam:AccessBoundaryPolicy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AccessBoundaryPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AccessBoundaryPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AccessBoundaryPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessBoundaryPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessBoundaryPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AccessBoundaryPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AccessBoundaryPolicy resource accepts the following input properties:

    Parent string

    The attachment point is identified by its URL-encoded full resource name.

    Rules List<AccessBoundaryPolicyRule>

    Rules to be applied. Structure is documented below.

    DisplayName string

    The display name of the rule.

    Name string

    The name of the policy.

    Parent string

    The attachment point is identified by its URL-encoded full resource name.

    Rules []AccessBoundaryPolicyRuleArgs

    Rules to be applied. Structure is documented below.

    DisplayName string

    The display name of the rule.

    Name string

    The name of the policy.

    parent String

    The attachment point is identified by its URL-encoded full resource name.

    rules List<AccessBoundaryPolicyRule>

    Rules to be applied. Structure is documented below.

    displayName String

    The display name of the rule.

    name String

    The name of the policy.

    parent string

    The attachment point is identified by its URL-encoded full resource name.

    rules AccessBoundaryPolicyRule[]

    Rules to be applied. Structure is documented below.

    displayName string

    The display name of the rule.

    name string

    The name of the policy.

    parent str

    The attachment point is identified by its URL-encoded full resource name.

    rules Sequence[AccessBoundaryPolicyRuleArgs]

    Rules to be applied. Structure is documented below.

    display_name str

    The display name of the rule.

    name str

    The name of the policy.

    parent String

    The attachment point is identified by its URL-encoded full resource name.

    rules List<Property Map>

    Rules to be applied. Structure is documented below.

    displayName String

    The display name of the rule.

    name String

    The name of the policy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AccessBoundaryPolicy resource produces the following output properties:

    Etag string

    The hash of the resource. Used internally during updates.

    Id string

    The provider-assigned unique ID for this managed resource.

    Etag string

    The hash of the resource. Used internally during updates.

    Id string

    The provider-assigned unique ID for this managed resource.

    etag String

    The hash of the resource. Used internally during updates.

    id String

    The provider-assigned unique ID for this managed resource.

    etag string

    The hash of the resource. Used internally during updates.

    id string

    The provider-assigned unique ID for this managed resource.

    etag str

    The hash of the resource. Used internally during updates.

    id str

    The provider-assigned unique ID for this managed resource.

    etag String

    The hash of the resource. Used internally during updates.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing AccessBoundaryPolicy Resource

    Get an existing AccessBoundaryPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AccessBoundaryPolicyState, opts?: CustomResourceOptions): AccessBoundaryPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            display_name: Optional[str] = None,
            etag: Optional[str] = None,
            name: Optional[str] = None,
            parent: Optional[str] = None,
            rules: Optional[Sequence[AccessBoundaryPolicyRuleArgs]] = None) -> AccessBoundaryPolicy
    func GetAccessBoundaryPolicy(ctx *Context, name string, id IDInput, state *AccessBoundaryPolicyState, opts ...ResourceOption) (*AccessBoundaryPolicy, error)
    public static AccessBoundaryPolicy Get(string name, Input<string> id, AccessBoundaryPolicyState? state, CustomResourceOptions? opts = null)
    public static AccessBoundaryPolicy get(String name, Output<String> id, AccessBoundaryPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DisplayName string

    The display name of the rule.

    Etag string

    The hash of the resource. Used internally during updates.

    Name string

    The name of the policy.

    Parent string

    The attachment point is identified by its URL-encoded full resource name.

    Rules List<AccessBoundaryPolicyRule>

    Rules to be applied. Structure is documented below.

    DisplayName string

    The display name of the rule.

    Etag string

    The hash of the resource. Used internally during updates.

    Name string

    The name of the policy.

    Parent string

    The attachment point is identified by its URL-encoded full resource name.

    Rules []AccessBoundaryPolicyRuleArgs

    Rules to be applied. Structure is documented below.

    displayName String

    The display name of the rule.

    etag String

    The hash of the resource. Used internally during updates.

    name String

    The name of the policy.

    parent String

    The attachment point is identified by its URL-encoded full resource name.

    rules List<AccessBoundaryPolicyRule>

    Rules to be applied. Structure is documented below.

    displayName string

    The display name of the rule.

    etag string

    The hash of the resource. Used internally during updates.

    name string

    The name of the policy.

    parent string

    The attachment point is identified by its URL-encoded full resource name.

    rules AccessBoundaryPolicyRule[]

    Rules to be applied. Structure is documented below.

    display_name str

    The display name of the rule.

    etag str

    The hash of the resource. Used internally during updates.

    name str

    The name of the policy.

    parent str

    The attachment point is identified by its URL-encoded full resource name.

    rules Sequence[AccessBoundaryPolicyRuleArgs]

    Rules to be applied. Structure is documented below.

    displayName String

    The display name of the rule.

    etag String

    The hash of the resource. Used internally during updates.

    name String

    The name of the policy.

    parent String

    The attachment point is identified by its URL-encoded full resource name.

    rules List<Property Map>

    Rules to be applied. Structure is documented below.

    Supporting Types

    AccessBoundaryPolicyRule, AccessBoundaryPolicyRuleArgs

    AccessBoundaryRule AccessBoundaryPolicyRuleAccessBoundaryRule

    An access boundary rule in an IAM policy. Structure is documented below.

    Description string

    The description of the rule.

    AccessBoundaryRule AccessBoundaryPolicyRuleAccessBoundaryRule

    An access boundary rule in an IAM policy. Structure is documented below.

    Description string

    The description of the rule.

    accessBoundaryRule AccessBoundaryPolicyRuleAccessBoundaryRule

    An access boundary rule in an IAM policy. Structure is documented below.

    description String

    The description of the rule.

    accessBoundaryRule AccessBoundaryPolicyRuleAccessBoundaryRule

    An access boundary rule in an IAM policy. Structure is documented below.

    description string

    The description of the rule.

    access_boundary_rule AccessBoundaryPolicyRuleAccessBoundaryRule

    An access boundary rule in an IAM policy. Structure is documented below.

    description str

    The description of the rule.

    accessBoundaryRule Property Map

    An access boundary rule in an IAM policy. Structure is documented below.

    description String

    The description of the rule.

    AccessBoundaryPolicyRuleAccessBoundaryRule, AccessBoundaryPolicyRuleAccessBoundaryRuleArgs

    AvailabilityCondition AccessBoundaryPolicyRuleAccessBoundaryRuleAvailabilityCondition

    The availability condition further constrains the access allowed by the access boundary rule. Structure is documented below.

    AvailablePermissions List<string>

    A list of permissions that may be allowed for use on the specified resource.

    AvailableResource string

    The full resource name of a Google Cloud resource entity.

    AvailabilityCondition AccessBoundaryPolicyRuleAccessBoundaryRuleAvailabilityCondition

    The availability condition further constrains the access allowed by the access boundary rule. Structure is documented below.

    AvailablePermissions []string

    A list of permissions that may be allowed for use on the specified resource.

    AvailableResource string

    The full resource name of a Google Cloud resource entity.

    availabilityCondition AccessBoundaryPolicyRuleAccessBoundaryRuleAvailabilityCondition

    The availability condition further constrains the access allowed by the access boundary rule. Structure is documented below.

    availablePermissions List<String>

    A list of permissions that may be allowed for use on the specified resource.

    availableResource String

    The full resource name of a Google Cloud resource entity.

    availabilityCondition AccessBoundaryPolicyRuleAccessBoundaryRuleAvailabilityCondition

    The availability condition further constrains the access allowed by the access boundary rule. Structure is documented below.

    availablePermissions string[]

    A list of permissions that may be allowed for use on the specified resource.

    availableResource string

    The full resource name of a Google Cloud resource entity.

    availability_condition AccessBoundaryPolicyRuleAccessBoundaryRuleAvailabilityCondition

    The availability condition further constrains the access allowed by the access boundary rule. Structure is documented below.

    available_permissions Sequence[str]

    A list of permissions that may be allowed for use on the specified resource.

    available_resource str

    The full resource name of a Google Cloud resource entity.

    availabilityCondition Property Map

    The availability condition further constrains the access allowed by the access boundary rule. Structure is documented below.

    availablePermissions List<String>

    A list of permissions that may be allowed for use on the specified resource.

    availableResource String

    The full resource name of a Google Cloud resource entity.

    AccessBoundaryPolicyRuleAccessBoundaryRuleAvailabilityCondition, AccessBoundaryPolicyRuleAccessBoundaryRuleAvailabilityConditionArgs

    Expression string

    Textual representation of an expression in Common Expression Language syntax.

    Description string

    Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

    Location string

    String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.


    Title string

    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.

    Expression string

    Textual representation of an expression in Common Expression Language syntax.

    Description string

    Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

    Location string

    String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.


    Title string

    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.

    expression String

    Textual representation of an expression in Common Expression Language syntax.

    description String

    Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

    location String

    String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.


    title String

    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.

    expression string

    Textual representation of an expression in Common Expression Language syntax.

    description string

    Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

    location string

    String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.


    title string

    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.

    expression str

    Textual representation of an expression in Common Expression Language syntax.

    description str

    Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

    location str

    String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.


    title str

    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.

    expression String

    Textual representation of an expression in Common Expression Language syntax.

    description String

    Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

    location String

    String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.


    title String

    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.

    Import

    AccessBoundaryPolicy can be imported using any of these accepted formats:

     $ pulumi import gcp:iam/accessBoundaryPolicy:AccessBoundaryPolicy default {{parent}}/{{name}}
    

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the google-beta Terraform Provider.

    gcp logo
    Google Cloud Classic v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi