SubscriptionIAMBinding

Three different resources help you manage your IAM policy for pubsub subscription. Each of these resources serves a different use case:

gcp.pubsub.SubscriptionIAMPolicy: Authoritative. Sets the IAM policy for the subscription and replaces any existing policy already attached.
gcp.pubsub.SubscriptionIAMBinding: 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 subscription are preserved.
gcp.pubsub.SubscriptionIAMMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the subscription are preserved.

Note: gcp.pubsub.SubscriptionIAMPolicy cannot be used in conjunction with gcp.pubsub.SubscriptionIAMBinding and gcp.pubsub.SubscriptionIAMMember or they will fight over what your policy should be.
Note: gcp.pubsub.SubscriptionIAMBinding resources can be used in conjunction with gcp.pubsub.SubscriptionIAMMember resources only if they do not grant privilege to the same role.

Create a SubscriptionIAMBinding Resource

new SubscriptionIAMBinding(name: string, args: SubscriptionIAMBindingArgs, opts?: CustomResourceOptions);

def SubscriptionIAMBinding(resource_name, opts=None, condition=None, members=None, project=None, role=None, subscription=None, __props__=None);

func NewSubscriptionIAMBinding(ctx *Context, name string, args SubscriptionIAMBindingArgs, opts ...ResourceOption) (*SubscriptionIAMBinding, error)

public SubscriptionIAMBinding(string name, SubscriptionIAMBindingArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SubscriptionIAMBindingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

SubscriptionIAMBinding Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The SubscriptionIAMBinding resource accepts the following input properties:

Members List<string>
Role string: The role that should be applied. Only one gcp.pubsub.SubscriptionIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Subscription string: The subscription name or id to bind to attach IAM policy to.
Condition SubscriptionIAMBindingConditionArgs
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.

Members []string
Role string: The role that should be applied. Only one gcp.pubsub.SubscriptionIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Subscription string: The subscription name or id to bind to attach IAM policy to.
Condition SubscriptionIAMBindingCondition
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.

members string[]
role string: The role that should be applied. Only one gcp.pubsub.SubscriptionIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
subscription string: The subscription name or id to bind to attach IAM policy to.
condition SubscriptionIAMBindingCondition
project string: The project in which the resource belongs. If it is not provided, the provider project is used.

members List[str]
role str: The role that should be applied. Only one gcp.pubsub.SubscriptionIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
subscription str: The subscription name or id to bind to attach IAM policy to.
condition Dict[SubscriptionIAMBindingCondition]
project str: The project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

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

Etag string: (Computed) The etag of the subscription’s IAM policy.
Id string: The provider-assigned unique ID for this managed resource.

Etag string: (Computed) The etag of the subscription’s IAM policy.
Id string: The provider-assigned unique ID for this managed resource.

etag string: (Computed) The etag of the subscription’s IAM policy.
id string: The provider-assigned unique ID for this managed resource.

etag str: (Computed) The etag of the subscription’s IAM policy.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing SubscriptionIAMBinding Resource

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

static get(resource_name, id, opts=None, condition=None, etag=None, members=None, project=None, role=None, subscription=None, __props__=None);

func GetSubscriptionIAMBinding(ctx *Context, name string, id IDInput, state *SubscriptionIAMBindingState, opts ...ResourceOption) (*SubscriptionIAMBinding, error)

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

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.

The following state arguments are supported:

Condition SubscriptionIAMBindingConditionArgs
Etag string: (Computed) The etag of the subscription’s IAM policy.
Members List<string>
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.
Role string: The role that should be applied. Only one gcp.pubsub.SubscriptionIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Subscription string: The subscription name or id to bind to attach IAM policy to.

Condition SubscriptionIAMBindingCondition
Etag string: (Computed) The etag of the subscription’s IAM policy.
Members []string
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.
Role string: The role that should be applied. Only one gcp.pubsub.SubscriptionIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Subscription string: The subscription name or id to bind to attach IAM policy to.

condition SubscriptionIAMBindingCondition
etag string: (Computed) The etag of the subscription’s IAM policy.
members string[]
project string: The project in which the resource belongs. If it is not provided, the provider project is used.
role string: The role that should be applied. Only one gcp.pubsub.SubscriptionIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
subscription string: The subscription name or id to bind to attach IAM policy to.

condition Dict[SubscriptionIAMBindingCondition]
etag str: (Computed) The etag of the subscription’s IAM policy.
members List[str]
project str: The project in which the resource belongs. If it is not provided, the provider project is used.
role str: The role that should be applied. Only one gcp.pubsub.SubscriptionIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
subscription str: The subscription name or id to bind to attach IAM policy to.

Supporting Types

SubscriptionIAMBindingCondition

See the input and output API doc for this type.

Expression string
Title string
Description string

Expression string
Title string
Description string

expression string
title string
description string

expression str
title str
description str

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud