1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. networksecurity
  5. AddressGroupIamPolicy
Google Cloud Classic v8.7.0 published on Tuesday, Oct 29, 2024 by Pulumi

gcp.networksecurity.AddressGroupIamPolicy

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.7.0 published on Tuesday, Oct 29, 2024 by Pulumi

    Three different resources help you manage your IAM policy for Network security ProjectAddressGroup. Each of these resources serves a different use case:

    • gcp.networksecurity.AddressGroupIamPolicy: Authoritative. Sets the IAM policy for the projectaddressgroup and replaces any existing policy already attached.
    • gcp.networksecurity.AddressGroupIamBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the projectaddressgroup are preserved.
    • gcp.networksecurity.AddressGroupIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the projectaddressgroup are preserved.

    A data source can be used to retrieve policy data in advent you do not need creation

    • gcp.networksecurity.AddressGroupIamPolicy: Retrieves the IAM policy for the projectaddressgroup

    Note: gcp.networksecurity.AddressGroupIamPolicy cannot be used in conjunction with gcp.networksecurity.AddressGroupIamBinding and gcp.networksecurity.AddressGroupIamMember or they will fight over what your policy should be.

    Note: gcp.networksecurity.AddressGroupIamBinding resources can be used in conjunction with gcp.networksecurity.AddressGroupIamMember resources only if they do not grant privilege to the same role.

    Create AddressGroupIamPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AddressGroupIamPolicy(name: string, args: AddressGroupIamPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def AddressGroupIamPolicy(resource_name: str,
                              args: AddressGroupIamPolicyArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def AddressGroupIamPolicy(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              policy_data: Optional[str] = None,
                              location: Optional[str] = None,
                              name: Optional[str] = None,
                              project: Optional[str] = None)
    func NewAddressGroupIamPolicy(ctx *Context, name string, args AddressGroupIamPolicyArgs, opts ...ResourceOption) (*AddressGroupIamPolicy, error)
    public AddressGroupIamPolicy(string name, AddressGroupIamPolicyArgs args, CustomResourceOptions? opts = null)
    public AddressGroupIamPolicy(String name, AddressGroupIamPolicyArgs args)
    public AddressGroupIamPolicy(String name, AddressGroupIamPolicyArgs args, CustomResourceOptions options)
    
    type: gcp:networksecurity:AddressGroupIamPolicy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AddressGroupIamPolicyArgs
    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 AddressGroupIamPolicyArgs
    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 AddressGroupIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AddressGroupIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AddressGroupIamPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var addressGroupIamPolicyResource = new Gcp.NetworkSecurity.AddressGroupIamPolicy("addressGroupIamPolicyResource", new()
    {
        PolicyData = "string",
        Location = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := networksecurity.NewAddressGroupIamPolicy(ctx, "addressGroupIamPolicyResource", &networksecurity.AddressGroupIamPolicyArgs{
    	PolicyData: pulumi.String("string"),
    	Location:   pulumi.String("string"),
    	Name:       pulumi.String("string"),
    	Project:    pulumi.String("string"),
    })
    
    var addressGroupIamPolicyResource = new AddressGroupIamPolicy("addressGroupIamPolicyResource", AddressGroupIamPolicyArgs.builder()
        .policyData("string")
        .location("string")
        .name("string")
        .project("string")
        .build());
    
    address_group_iam_policy_resource = gcp.networksecurity.AddressGroupIamPolicy("addressGroupIamPolicyResource",
        policy_data="string",
        location="string",
        name="string",
        project="string")
    
    const addressGroupIamPolicyResource = new gcp.networksecurity.AddressGroupIamPolicy("addressGroupIamPolicyResource", {
        policyData: "string",
        location: "string",
        name: "string",
        project: "string",
    });
    
    type: gcp:networksecurity:AddressGroupIamPolicy
    properties:
        location: string
        name: string
        policyData: string
        project: string
    

    AddressGroupIamPolicy 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 AddressGroupIamPolicy resource accepts the following input properties:

    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Location string
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    Name string
    Used to find the parent resource to bind the IAM policy to
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Location string
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    Name string
    Used to find the parent resource to bind the IAM policy to
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    location String
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    name String
    Used to find the parent resource to bind the IAM policy to
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    location string
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    name string
    Used to find the parent resource to bind the IAM policy to
    project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    location str
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    name str
    Used to find the parent resource to bind the IAM policy to
    project str
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    location String
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    name String
    Used to find the parent resource to bind the IAM policy to
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

    Outputs

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

    Etag string
    (Computed) The etag of the IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Etag string
    (Computed) The etag of the IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    etag String
    (Computed) The etag of the IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.
    etag string
    (Computed) The etag of the IAM policy.
    id string
    The provider-assigned unique ID for this managed resource.
    etag str
    (Computed) The etag of the IAM policy.
    id str
    The provider-assigned unique ID for this managed resource.
    etag String
    (Computed) The etag of the IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AddressGroupIamPolicy Resource

    Get an existing AddressGroupIamPolicy 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?: AddressGroupIamPolicyState, opts?: CustomResourceOptions): AddressGroupIamPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            etag: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            policy_data: Optional[str] = None,
            project: Optional[str] = None) -> AddressGroupIamPolicy
    func GetAddressGroupIamPolicy(ctx *Context, name string, id IDInput, state *AddressGroupIamPolicyState, opts ...ResourceOption) (*AddressGroupIamPolicy, error)
    public static AddressGroupIamPolicy Get(string name, Input<string> id, AddressGroupIamPolicyState? state, CustomResourceOptions? opts = null)
    public static AddressGroupIamPolicy get(String name, Output<String> id, AddressGroupIamPolicyState 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:
    Etag string
    (Computed) The etag of the IAM policy.
    Location string
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    Name string
    Used to find the parent resource to bind the IAM policy to
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    Etag string
    (Computed) The etag of the IAM policy.
    Location string
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    Name string
    Used to find the parent resource to bind the IAM policy to
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    etag String
    (Computed) The etag of the IAM policy.
    location String
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    name String
    Used to find the parent resource to bind the IAM policy to
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    etag string
    (Computed) The etag of the IAM policy.
    location string
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    name string
    Used to find the parent resource to bind the IAM policy to
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    etag str
    (Computed) The etag of the IAM policy.
    location str
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    name str
    Used to find the parent resource to bind the IAM policy to
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    etag String
    (Computed) The etag of the IAM policy.
    location String
    The location of the gateway security policy. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    name String
    Used to find the parent resource to bind the IAM policy to
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

    Import

    For all import syntaxes, the “resource in question” can take any of the following forms:

    • projects/{{project}}/locations/{{location}}/addressGroups/{{name}}

    • {{project}}/{{location}}/{{name}}

    • {{location}}/{{name}}

    • {{name}}

    Any variables not passed in the import command will be taken from the provider configuration.

    Network security projectaddressgroup IAM resources can be imported using the resource identifiers, role, and member.

    IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.

    $ pulumi import gcp:networksecurity/addressGroupIamPolicy:AddressGroupIamPolicy editor "projects/{{project}}/locations/{{location}}/addressGroups/{{project_address_group}} roles/compute.networkAdmin user:jane@example.com"
    

    IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.

    $ pulumi import gcp:networksecurity/addressGroupIamPolicy:AddressGroupIamPolicy editor "projects/{{project}}/locations/{{location}}/addressGroups/{{project_address_group}} roles/compute.networkAdmin"
    

    IAM policy imports use the identifier of the resource in question, e.g.

    $ pulumi import gcp:networksecurity/addressGroupIamPolicy:AddressGroupIamPolicy editor projects/{{project}}/locations/{{location}}/addressGroups/{{project_address_group}}
    

    -> Custom Roles: If you’re importing a IAM resource with a custom role, make sure to use the

    full name of the custom role, e.g. [projects/my-project|organizations/my-org]/roles/my-custom-role.

    To learn more about importing existing cloud resources, see Importing resources.

    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 v8.7.0 published on Tuesday, Oct 29, 2024 by Pulumi