Google Cloud Classic v6.49.0, Feb 1 23

gcp.apigateway.GatewayIamMember

Import

For all import syntaxes, the “resource in question” can take any of the following forms* projects/{{project}}/locations/{{region}}/gateways/{{gateway}} * {{project}}/{{region}}/{{gateway}} * {{region}}/{{gateway}} * {{gateway}} Any variables not passed in the import command will be taken from the provider configuration. API Gateway gateway IAM resources can be imported using the resource identifiers, role, and member. IAM member imports use space-delimited identifiersthe resource in question, the role, and the member identity, e.g.

 $ pulumi import gcp:apigateway/gatewayIamMember:GatewayIamMember editor "projects/{{project}}/locations/{{region}}/gateways/{{gateway}} roles/apigateway.viewer user:jane@example.com"

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

 $ pulumi import gcp:apigateway/gatewayIamMember:GatewayIamMember editor "projects/{{project}}/locations/{{region}}/gateways/{{gateway}} roles/apigateway.viewer"

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

 $ pulumi import gcp:apigateway/gatewayIamMember:GatewayIamMember editor projects/{{project}}/locations/{{region}}/gateways/{{gateway}}

-> Custom RolesIf 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.

Create GatewayIamMember Resource

new GatewayIamMember(name: string, args: GatewayIamMemberArgs, opts?: CustomResourceOptions);

@overload
def GatewayIamMember(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     condition: Optional[GatewayIamMemberConditionArgs] = None,
                     gateway: Optional[str] = None,
                     member: Optional[str] = None,
                     project: Optional[str] = None,
                     region: Optional[str] = None,
                     role: Optional[str] = None)
@overload
def GatewayIamMember(resource_name: str,
                     args: GatewayIamMemberArgs,
                     opts: Optional[ResourceOptions] = None)

func NewGatewayIamMember(ctx *Context, name string, args GatewayIamMemberArgs, opts ...ResourceOption) (*GatewayIamMember, error)

public GatewayIamMember(string name, GatewayIamMemberArgs args, CustomResourceOptions? opts = null)

public GatewayIamMember(String name, GatewayIamMemberArgs args)
public GatewayIamMember(String name, GatewayIamMemberArgs args, CustomResourceOptions options)

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

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

name string: The unique name of the resource.
args GatewayIamMemberArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GatewayIamMemberArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Gateway string
Member string
Role string: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition GatewayIamMemberConditionArgs
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.
Region string: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

Gateway string
Member string
Role string: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition GatewayIamMemberConditionArgs
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.
Region string: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

gateway String
member String
role String: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition GatewayIamMemberConditionArgs
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.
region String: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

gateway string
member string
role string: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition GatewayIamMemberConditionArgs
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.
region string: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

gateway str
member str
role str: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition GatewayIamMemberConditionArgs
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.
region str: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

gateway String
member String
role String: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Property Map
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.
region String: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[GatewayIamMemberConditionArgs] = None,
        etag: Optional[str] = None,
        gateway: Optional[str] = None,
        member: Optional[str] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        role: Optional[str] = None) -> GatewayIamMember

func GetGatewayIamMember(ctx *Context, name string, id IDInput, state *GatewayIamMemberState, opts ...ResourceOption) (*GatewayIamMember, error)

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

public static GatewayIamMember get(String name, Output<String> id, GatewayIamMemberState 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:

Condition GatewayIamMemberConditionArgs
Etag string: (Computed) The etag of the IAM policy.
Gateway string
Member string
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.
Region string: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
Role string: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Condition GatewayIamMemberConditionArgs
Etag string: (Computed) The etag of the IAM policy.
Gateway string
Member string
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.
Region string: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
Role string: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition GatewayIamMemberConditionArgs
etag String: (Computed) The etag of the IAM policy.
gateway String
member String
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.
region String: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
role String: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition GatewayIamMemberConditionArgs
etag string: (Computed) The etag of the IAM policy.
gateway string
member string
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.
region string: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
role string: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition GatewayIamMemberConditionArgs
etag str: (Computed) The etag of the IAM policy.
gateway str
member str
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.
region str: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
role str: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition Property Map
etag String: (Computed) The etag of the IAM policy.
gateway String
member String
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.
region String: The region of the gateway for the API. 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 region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
role String: The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.