1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigateway
  5. apigateway/v1
  6. GatewayIamMember

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.apigateway/v1.GatewayIamMember

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

    Create GatewayIamMember Resource

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

    Constructor syntax

    new GatewayIamMember(name: string, args: GatewayIamMemberArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayIamMember(resource_name: str,
                         args: GatewayIamMemberArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayIamMember(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         member: Optional[str] = None,
                         name: Optional[str] = None,
                         role: Optional[str] = None,
                         condition: Optional[_iam.v1.ConditionArgs] = 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: google-native:apigateway/v1:GatewayIamMember
    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 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.

    Constructor example

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

    var gatewayIamMemberResource = new GoogleNative.APIGateway.V1.GatewayIamMember("gatewayIamMemberResource", new()
    {
        Member = "string",
        Name = "string",
        Role = "string",
        Condition = new GoogleNative.IAM.V1.Inputs.ConditionArgs
        {
            Expression = "string",
            Title = "string",
            Description = "string",
        },
    });
    
    example, err := apigateway.NewGatewayIamMember(ctx, "gatewayIamMemberResource", &apigateway.GatewayIamMemberArgs{
    	Member: pulumi.String("string"),
    	Name:   pulumi.String("string"),
    	Role:   pulumi.String("string"),
    	Condition: &iam.ConditionArgs{
    		Expression:  pulumi.String("string"),
    		Title:       pulumi.String("string"),
    		Description: pulumi.String("string"),
    	},
    })
    
    var gatewayIamMemberResource = new GatewayIamMember("gatewayIamMemberResource", GatewayIamMemberArgs.builder()
        .member("string")
        .name("string")
        .role("string")
        .condition(ConditionArgs.builder()
            .expression("string")
            .title("string")
            .description("string")
            .build())
        .build());
    
    gateway_iam_member_resource = google_native.apigateway.v1.GatewayIamMember("gatewayIamMemberResource",
        member="string",
        name="string",
        role="string",
        condition={
            "expression": "string",
            "title": "string",
            "description": "string",
        })
    
    const gatewayIamMemberResource = new google_native.apigateway.v1.GatewayIamMember("gatewayIamMemberResource", {
        member: "string",
        name: "string",
        role: "string",
        condition: {
            expression: "string",
            title: "string",
            description: "string",
        },
    });
    
    type: google-native:apigateway/v1:GatewayIamMember
    properties:
        condition:
            description: string
            expression: string
            title: string
        member: string
        name: string
        role: string
    

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GatewayIamMember resource accepts the following input properties:

    Member string
    Identity that will be granted the privilege in role. The entry can have one of the following values:

    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    Name string
    The name of the resource to manage IAM policies for.
    Role string
    The role that should be applied.
    Condition Pulumi.GoogleNative.IAM.V1.Inputs.Condition
    An IAM Condition for a given binding.
    Member string
    Identity that will be granted the privilege in role. The entry can have one of the following values:

    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    Name string
    The name of the resource to manage IAM policies for.
    Role string
    The role that should be applied.
    Condition ConditionArgs
    An IAM Condition for a given binding.
    member String
    Identity that will be granted the privilege in role. The entry can have one of the following values:

    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    name String
    The name of the resource to manage IAM policies for.
    role String
    The role that should be applied.
    condition Condition
    An IAM Condition for a given binding.
    member string
    Identity that will be granted the privilege in role. The entry can have one of the following values:

    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    name string
    The name of the resource to manage IAM policies for.
    role string
    The role that should be applied.
    condition iam.v1.Condition
    An IAM Condition for a given binding.
    member str
    Identity that will be granted the privilege in role. The entry can have one of the following values:

    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    name str
    The name of the resource to manage IAM policies for.
    role str
    The role that should be applied.
    condition iam.v1.ConditionArgs
    An IAM Condition for a given binding.
    member String
    Identity that will be granted the privilege in role. The entry can have one of the following values:

    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    name String
    The name of the resource to manage IAM policies for.
    role String
    The role that should be applied.
    condition Property Map
    An IAM Condition for a given binding.

    Outputs

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

    Etag string
    The etag of the resource's IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Project string
    The project in which the resource belongs. If it is not provided, a default will be supplied.
    Etag string
    The etag of the resource's IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Project string
    The project in which the resource belongs. If it is not provided, a default will be supplied.
    etag String
    The etag of the resource's IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.
    project String
    The project in which the resource belongs. If it is not provided, a default will be supplied.
    etag string
    The etag of the resource's IAM policy.
    id string
    The provider-assigned unique ID for this managed resource.
    project string
    The project in which the resource belongs. If it is not provided, a default will be supplied.
    etag str
    The etag of the resource's IAM policy.
    id str
    The provider-assigned unique ID for this managed resource.
    project str
    The project in which the resource belongs. If it is not provided, a default will be supplied.
    etag String
    The etag of the resource's IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.
    project String
    The project in which the resource belongs. If it is not provided, a default will be supplied.

    Supporting Types

    Condition, ConditionArgs

    Expression string
    Textual representation of an expression in Common Expression Language syntax.
    Title string
    A title for the expression, i.e. a short string describing its purpose.
    Description string
    An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.
    Expression string
    Textual representation of an expression in Common Expression Language syntax.
    Title string
    A title for the expression, i.e. a short string describing its purpose.
    Description string
    An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.
    expression String
    Textual representation of an expression in Common Expression Language syntax.
    title String
    A title for the expression, i.e. a short string describing its purpose.
    description String
    An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.
    expression string
    Textual representation of an expression in Common Expression Language syntax.
    title string
    A title for the expression, i.e. a short string describing its purpose.
    description string
    An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.
    expression str
    Textual representation of an expression in Common Expression Language syntax.
    title str
    A title for the expression, i.e. a short string describing its purpose.
    description str
    An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.
    expression String
    Textual representation of an expression in Common Expression Language syntax.
    title String
    A title for the expression, i.e. a short string describing its purpose.
    description String
    An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi