1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. endpoints
  5. ConsumersIamPolicy
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

gcp.endpoints.ConsumersIamPolicy

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

    Three different resources help you manage your IAM policy for Cloud Endpoints ServiceConsumers. Each of these resources serves a different use case:

    • gcp.endpoints.ConsumersIamPolicy: Authoritative. Sets the IAM policy for the serviceconsumers and replaces any existing policy already attached.
    • gcp.endpoints.ConsumersIamBinding: 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 serviceconsumers are preserved.
    • gcp.endpoints.ConsumersIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the serviceconsumers are preserved.

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

    • gcp.endpoints.ConsumersIamPolicy: Retrieves the IAM policy for the serviceconsumers

    Note: gcp.endpoints.ConsumersIamPolicy cannot be used in conjunction with gcp.endpoints.ConsumersIamBinding and gcp.endpoints.ConsumersIamMember or they will fight over what your policy should be.

    Note: gcp.endpoints.ConsumersIamBinding resources can be used in conjunction with gcp.endpoints.ConsumersIamMember resources only if they do not grant privilege to the same role.

    Create ConsumersIamPolicy Resource

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

    Constructor syntax

    new ConsumersIamPolicy(name: string, args: ConsumersIamPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def ConsumersIamPolicy(resource_name: str,
                           args: ConsumersIamPolicyArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConsumersIamPolicy(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           consumer_project: Optional[str] = None,
                           policy_data: Optional[str] = None,
                           service_name: Optional[str] = None)
    func NewConsumersIamPolicy(ctx *Context, name string, args ConsumersIamPolicyArgs, opts ...ResourceOption) (*ConsumersIamPolicy, error)
    public ConsumersIamPolicy(string name, ConsumersIamPolicyArgs args, CustomResourceOptions? opts = null)
    public ConsumersIamPolicy(String name, ConsumersIamPolicyArgs args)
    public ConsumersIamPolicy(String name, ConsumersIamPolicyArgs args, CustomResourceOptions options)
    
    type: gcp:endpoints:ConsumersIamPolicy
    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 ConsumersIamPolicyArgs
    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 ConsumersIamPolicyArgs
    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 ConsumersIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConsumersIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConsumersIamPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var consumersIamPolicyResource = new Gcp.Endpoints.ConsumersIamPolicy("consumersIamPolicyResource", new()
    {
        ConsumerProject = "string",
        PolicyData = "string",
        ServiceName = "string",
    });
    
    example, err := endpoints.NewConsumersIamPolicy(ctx, "consumersIamPolicyResource", &endpoints.ConsumersIamPolicyArgs{
    	ConsumerProject: pulumi.String("string"),
    	PolicyData:      pulumi.String("string"),
    	ServiceName:     pulumi.String("string"),
    })
    
    var consumersIamPolicyResource = new ConsumersIamPolicy("consumersIamPolicyResource", ConsumersIamPolicyArgs.builder()        
        .consumerProject("string")
        .policyData("string")
        .serviceName("string")
        .build());
    
    consumers_iam_policy_resource = gcp.endpoints.ConsumersIamPolicy("consumersIamPolicyResource",
        consumer_project="string",
        policy_data="string",
        service_name="string")
    
    const consumersIamPolicyResource = new gcp.endpoints.ConsumersIamPolicy("consumersIamPolicyResource", {
        consumerProject: "string",
        policyData: "string",
        serviceName: "string",
    });
    
    type: gcp:endpoints:ConsumersIamPolicy
    properties:
        consumerProject: string
        policyData: string
        serviceName: string
    

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

    ConsumerProject string
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    ServiceName string
    ConsumerProject string
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    ServiceName string
    consumerProject String
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName String
    consumerProject string
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName string
    consumer_project str
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    service_name str
    consumerProject String
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConsumersIamPolicy 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 ConsumersIamPolicy Resource

    Get an existing ConsumersIamPolicy 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?: ConsumersIamPolicyState, opts?: CustomResourceOptions): ConsumersIamPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            consumer_project: Optional[str] = None,
            etag: Optional[str] = None,
            policy_data: Optional[str] = None,
            service_name: Optional[str] = None) -> ConsumersIamPolicy
    func GetConsumersIamPolicy(ctx *Context, name string, id IDInput, state *ConsumersIamPolicyState, opts ...ResourceOption) (*ConsumersIamPolicy, error)
    public static ConsumersIamPolicy Get(string name, Input<string> id, ConsumersIamPolicyState? state, CustomResourceOptions? opts = null)
    public static ConsumersIamPolicy get(String name, Output<String> id, ConsumersIamPolicyState 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:
    ConsumerProject string
    Etag string
    (Computed) The etag of the IAM policy.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    ServiceName string
    ConsumerProject string
    Etag string
    (Computed) The etag of the IAM policy.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    ServiceName string
    consumerProject String
    etag String
    (Computed) The etag of the IAM policy.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName String
    consumerProject string
    etag string
    (Computed) The etag of the IAM policy.
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName string
    consumer_project str
    etag str
    (Computed) The etag of the IAM policy.
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    service_name str
    consumerProject String
    etag String
    (Computed) The etag of the IAM policy.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName String

    Import

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

    • services/{{service_name}}/consumers/{{consumer_project}}

    • {{service_name}}/{{consumer_project}}

    • {{consumer_project}}

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

    Cloud Endpoints serviceconsumers 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:endpoints/consumersIamPolicy:ConsumersIamPolicy editor "services/{{service_name}}/consumers/{{consumer_project}} roles/servicemanagement.serviceController user:jane@example.com"
    

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

    $ pulumi import gcp:endpoints/consumersIamPolicy:ConsumersIamPolicy editor "services/{{service_name}}/consumers/{{consumer_project}} roles/servicemanagement.serviceController"
    

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

    $ pulumi import gcp:endpoints/consumersIamPolicy:ConsumersIamPolicy editor services/{{service_name}}/consumers/{{consumer_project}}
    

    -> 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 v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi