SubscriptionIAMPolicy
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.SubscriptionIAMPolicycannot be used in conjunction withgcp.pubsub.SubscriptionIAMBindingandgcp.pubsub.SubscriptionIAMMemberor they will fight over what your policy should be.Note:
gcp.pubsub.SubscriptionIAMBindingresources can be used in conjunction withgcp.pubsub.SubscriptionIAMMemberresources only if they do not grant privilege to the same role.
Create a SubscriptionIAMPolicy Resource
new SubscriptionIAMPolicy(name: string, args: SubscriptionIAMPolicyArgs, opts?: CustomResourceOptions);def SubscriptionIAMPolicy(resource_name, opts=None, policy_data=None, project=None, subscription=None, __props__=None);func NewSubscriptionIAMPolicy(ctx *Context, name string, args SubscriptionIAMPolicyArgs, opts ...ResourceOption) (*SubscriptionIAMPolicy, error)public SubscriptionIAMPolicy(string name, SubscriptionIAMPolicyArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args SubscriptionIAMPolicyArgs
- 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 SubscriptionIAMPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubscriptionIAMPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
SubscriptionIAMPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The SubscriptionIAMPolicy resource accepts the following input properties:
- Policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- Subscription string
The subscription name or id to bind to attach IAM policy to.
- Project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- Policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- Subscription string
The subscription name or id to bind to attach IAM policy to.
- Project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- subscription string
The subscription name or id to bind to attach IAM policy to.
- project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- policy_
data str The policy data generated by a
gcp.organizations.getIAMPolicydata source.- subscription str
The subscription name or id to bind to attach IAM policy to.
- 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 SubscriptionIAMPolicy resource produces the following output properties:
Look up an Existing SubscriptionIAMPolicy Resource
Get an existing SubscriptionIAMPolicy 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?: SubscriptionIAMPolicyState, opts?: CustomResourceOptions): SubscriptionIAMPolicystatic get(resource_name, id, opts=None, etag=None, policy_data=None, project=None, subscription=None, __props__=None);func GetSubscriptionIAMPolicy(ctx *Context, name string, id IDInput, state *SubscriptionIAMPolicyState, opts ...ResourceOption) (*SubscriptionIAMPolicy, error)public static SubscriptionIAMPolicy Get(string name, Input<string> id, SubscriptionIAMPolicyState? 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:
- Etag string
(Computed) The etag of the subscription’s IAM policy.
- Policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- Project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- Subscription string
The subscription name or id to bind to attach IAM policy to.
- Etag string
(Computed) The etag of the subscription’s IAM policy.
- Policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- Project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- Subscription string
The subscription name or id to bind to attach IAM policy to.
- etag string
(Computed) The etag of the subscription’s IAM policy.
- policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- project string
The project in which the resource belongs. If it is not provided, the provider project is used.
- subscription string
The subscription name or id to bind to attach IAM policy to.
- etag str
(Computed) The etag of the subscription’s IAM policy.
- policy_
data str The policy data generated by a
gcp.organizations.getIAMPolicydata source.- project str
The project in which the resource belongs. If it is not provided, the provider project is used.
- subscription str
The subscription name or id to bind to attach IAM policy to.
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.