gcp.endpoints.ConsumersIamMember

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 ConsumersIamMember Resource

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

Constructor syntax

new ConsumersIamMember(name: string, args: ConsumersIamMemberArgs, opts?: CustomResourceOptions);

@overload
def ConsumersIamMember(resource_name: str,
                       args: ConsumersIamMemberArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def ConsumersIamMember(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       consumer_project: Optional[str] = None,
                       member: Optional[str] = None,
                       role: Optional[str] = None,
                       service_name: Optional[str] = None,
                       condition: Optional[ConsumersIamMemberConditionArgs] = None)

func NewConsumersIamMember(ctx *Context, name string, args ConsumersIamMemberArgs, opts ...ResourceOption) (*ConsumersIamMember, error)

public ConsumersIamMember(string name, ConsumersIamMemberArgs args, CustomResourceOptions? opts = null)

public ConsumersIamMember(String name, ConsumersIamMemberArgs args)
public ConsumersIamMember(String name, ConsumersIamMemberArgs args, CustomResourceOptions options)

type: gcp:endpoints:ConsumersIamMember
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

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

var consumersIamMemberResource = new Gcp.Endpoints.ConsumersIamMember("consumersIamMemberResource", new()
{
    ConsumerProject = "string",
    Member = "string",
    Role = "string",
    ServiceName = "string",
    Condition = new Gcp.Endpoints.Inputs.ConsumersIamMemberConditionArgs
    {
        Expression = "string",
        Title = "string",
        Description = "string",
    },
});

example, err := endpoints.NewConsumersIamMember(ctx, "consumersIamMemberResource", &endpoints.ConsumersIamMemberArgs{
	ConsumerProject: pulumi.String("string"),
	Member:          pulumi.String("string"),
	Role:            pulumi.String("string"),
	ServiceName:     pulumi.String("string"),
	Condition: &endpoints.ConsumersIamMemberConditionArgs{
		Expression:  pulumi.String("string"),
		Title:       pulumi.String("string"),
		Description: pulumi.String("string"),
	},
})

var consumersIamMemberResource = new ConsumersIamMember("consumersIamMemberResource", ConsumersIamMemberArgs.builder()
    .consumerProject("string")
    .member("string")
    .role("string")
    .serviceName("string")
    .condition(ConsumersIamMemberConditionArgs.builder()
        .expression("string")
        .title("string")
        .description("string")
        .build())
    .build());

consumers_iam_member_resource = gcp.endpoints.ConsumersIamMember("consumersIamMemberResource",
    consumer_project="string",
    member="string",
    role="string",
    service_name="string",
    condition={
        "expression": "string",
        "title": "string",
        "description": "string",
    })

const consumersIamMemberResource = new gcp.endpoints.ConsumersIamMember("consumersIamMemberResource", {
    consumerProject: "string",
    member: "string",
    role: "string",
    serviceName: "string",
    condition: {
        expression: "string",
        title: "string",
        description: "string",
    },
});

type: gcp:endpoints:ConsumersIamMember
properties:
    condition:
        description: string
        expression: string
        title: string
    consumerProject: string
    member: string
    role: string
    serviceName: string

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

Outputs

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

Look up Existing ConsumersIamMember Resource

Get an existing ConsumersIamMember 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?: ConsumersIamMemberState, opts?: CustomResourceOptions): ConsumersIamMember

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[ConsumersIamMemberConditionArgs] = None,
        consumer_project: Optional[str] = None,
        etag: Optional[str] = None,
        member: Optional[str] = None,
        role: Optional[str] = None,
        service_name: Optional[str] = None) -> ConsumersIamMember

func GetConsumersIamMember(ctx *Context, name string, id IDInput, state *ConsumersIamMemberState, opts ...ResourceOption) (*ConsumersIamMember, error)

public static ConsumersIamMember Get(string name, Input<string> id, ConsumersIamMemberState? state, CustomResourceOptions? opts = null)

public static ConsumersIamMember get(String name, Output<String> id, ConsumersIamMemberState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

Supporting Types

ConsumersIamMemberCondition, ConsumersIamMemberConditionArgs

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/consumersIamMember:ConsumersIamMember 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/consumersIamMember:ConsumersIamMember 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/consumersIamMember:ConsumersIamMember 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.