TopicIAMMember
Three different resources help you manage your IAM policy for Cloud Pub/Sub Topic. Each of these resources serves a different use case:
gcp.pubsub.TopicIAMPolicy: Authoritative. Sets the IAM policy for the topic and replaces any existing policy already attached.gcp.pubsub.TopicIAMBinding: 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 topic are preserved.gcp.pubsub.TopicIAMMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the topic are preserved.
Note:
gcp.pubsub.TopicIAMPolicycannot be used in conjunction withgcp.pubsub.TopicIAMBindingandgcp.pubsub.TopicIAMMemberor they will fight over what your policy should be.Note:
gcp.pubsub.TopicIAMBindingresources can be used in conjunction withgcp.pubsub.TopicIAMMemberresources only if they do not grant privilege to the same role.
Create a TopicIAMMember Resource
new TopicIAMMember(name: string, args: TopicIAMMemberArgs, opts?: CustomResourceOptions);def TopicIAMMember(resource_name, opts=None, condition=None, member=None, project=None, role=None, topic=None, __props__=None);func NewTopicIAMMember(ctx *Context, name string, args TopicIAMMemberArgs, opts ...ResourceOption) (*TopicIAMMember, error)public TopicIAMMember(string name, TopicIAMMemberArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args TopicIAMMemberArgs
- 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 TopicIAMMemberArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TopicIAMMemberArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
TopicIAMMember Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The TopicIAMMember resource accepts the following input properties:
- Member string
- Role string
The role that should be applied. Only one
gcp.pubsub.TopicIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- Topic string
Used to find the parent resource to bind the IAM policy to
- Condition
Topic
IAMMember Condition Args - 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.
- Member string
- Role string
The role that should be applied. Only one
gcp.pubsub.TopicIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- Topic string
Used to find the parent resource to bind the IAM policy to
- Condition
Topic
IAMMember Condition - 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.
- member string
- role string
The role that should be applied. Only one
gcp.pubsub.TopicIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- topic string
Used to find the parent resource to bind the IAM policy to
- condition
Topic
IAMMember Condition - 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.
- member str
- role str
The role that should be applied. Only one
gcp.pubsub.TopicIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- topic str
Used to find the parent resource to bind the IAM policy to
- condition
Dict[Topic
IAMMember Condition] - 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the TopicIAMMember resource produces the following output properties:
Look up an Existing TopicIAMMember Resource
Get an existing TopicIAMMember 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?: TopicIAMMemberState, opts?: CustomResourceOptions): TopicIAMMemberstatic get(resource_name, id, opts=None, condition=None, etag=None, member=None, project=None, role=None, topic=None, __props__=None);func GetTopicIAMMember(ctx *Context, name string, id IDInput, state *TopicIAMMemberState, opts ...ResourceOption) (*TopicIAMMember, error)public static TopicIAMMember Get(string name, Input<string> id, TopicIAMMemberState? 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
Topic
IAMMember Condition Args - Etag string
(Computed) The etag of the IAM policy.
- 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.
- Role string
The role that should be applied. Only one
gcp.pubsub.TopicIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- Topic string
Used to find the parent resource to bind the IAM policy to
- Condition
Topic
IAMMember Condition - Etag string
(Computed) The etag of the IAM policy.
- 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.
- Role string
The role that should be applied. Only one
gcp.pubsub.TopicIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- Topic string
Used to find the parent resource to bind the IAM policy to
- condition
Topic
IAMMember Condition - etag string
(Computed) The etag of the IAM policy.
- 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.
- role string
The role that should be applied. Only one
gcp.pubsub.TopicIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- topic string
Used to find the parent resource to bind the IAM policy to
- condition
Dict[Topic
IAMMember Condition] - etag str
(Computed) The etag of the IAM policy.
- 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.
- role str
The role that should be applied. Only one
gcp.pubsub.TopicIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- topic str
Used to find the parent resource to bind the IAM policy to
Supporting Types
TopicIAMMemberCondition
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.