gcp.endpoints.ConsumersIamPolicy
Explore with Pulumi AI
Three different resources help you manage your IAM policy for Cloud Endpoints ServiceConsumers. Each of these resources serves a different use case:
gcp.endpoints.ConsumersIamPolicy
: Authoritative. Sets the IAM policy for the serviceconsumers and replaces any existing policy already attached.gcp.endpoints.ConsumersIamBinding
: 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 serviceconsumers are preserved.gcp.endpoints.ConsumersIamMember
: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the serviceconsumers are preserved.
A data source can be used to retrieve policy data in advent you do not need creation
gcp.endpoints.ConsumersIamPolicy
: Retrieves the IAM policy for the serviceconsumers
Note:
gcp.endpoints.ConsumersIamPolicy
cannot be used in conjunction withgcp.endpoints.ConsumersIamBinding
andgcp.endpoints.ConsumersIamMember
or they will fight over what your policy should be.
Note:
gcp.endpoints.ConsumersIamBinding
resources can be used in conjunction withgcp.endpoints.ConsumersIamMember
resources only if they do not grant privilege to the same role.
Create ConsumersIamPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ConsumersIamPolicy(name: string, args: ConsumersIamPolicyArgs, opts?: CustomResourceOptions);
@overload
def ConsumersIamPolicy(resource_name: str,
args: ConsumersIamPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ConsumersIamPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
consumer_project: Optional[str] = None,
policy_data: Optional[str] = None,
service_name: Optional[str] = None)
func NewConsumersIamPolicy(ctx *Context, name string, args ConsumersIamPolicyArgs, opts ...ResourceOption) (*ConsumersIamPolicy, error)
public ConsumersIamPolicy(string name, ConsumersIamPolicyArgs args, CustomResourceOptions? opts = null)
public ConsumersIamPolicy(String name, ConsumersIamPolicyArgs args)
public ConsumersIamPolicy(String name, ConsumersIamPolicyArgs args, CustomResourceOptions options)
type: gcp:endpoints:ConsumersIamPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ConsumersIamPolicyArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. ConsumersIamPolicyArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ConsumersIamPolicyArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ConsumersIamPolicyArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ConsumersIamPolicyArgs - 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 consumersIamPolicyResource = new Gcp.Endpoints.ConsumersIamPolicy("consumersIamPolicyResource", new()
{
ConsumerProject = "string",
PolicyData = "string",
ServiceName = "string",
});
example, err := endpoints.NewConsumersIamPolicy(ctx, "consumersIamPolicyResource", &endpoints.ConsumersIamPolicyArgs{
ConsumerProject: pulumi.String("string"),
PolicyData: pulumi.String("string"),
ServiceName: pulumi.String("string"),
})
var consumersIamPolicyResource = new ConsumersIamPolicy("consumersIamPolicyResource", ConsumersIamPolicyArgs.builder()
.consumerProject("string")
.policyData("string")
.serviceName("string")
.build());
consumers_iam_policy_resource = gcp.endpoints.ConsumersIamPolicy("consumersIamPolicyResource",
consumer_project="string",
policy_data="string",
service_name="string")
const consumersIamPolicyResource = new gcp.endpoints.ConsumersIamPolicy("consumersIamPolicyResource", {
consumerProject: "string",
policyData: "string",
serviceName: "string",
});
type: gcp:endpoints:ConsumersIamPolicy
properties:
consumerProject: string
policyData: string
serviceName: string
ConsumersIamPolicy 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 ConsumersIamPolicy resource accepts the following input properties:
- Consumer
Project This property is required. Changes to this property will trigger replacement.
- Policy
Data This property is required. string - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - Service
Name This property is required. Changes to this property will trigger replacement.
- Consumer
Project This property is required. Changes to this property will trigger replacement.
- Policy
Data This property is required. string - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - Service
Name This property is required. Changes to this property will trigger replacement.
- consumer
Project This property is required. Changes to this property will trigger replacement.
- policy
Data This property is required. String - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - service
Name This property is required. Changes to this property will trigger replacement.
- consumer
Project This property is required. Changes to this property will trigger replacement.
- policy
Data This property is required. string - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - service
Name This property is required. Changes to this property will trigger replacement.
- consumer_
project This property is required. Changes to this property will trigger replacement.
- policy_
data This property is required. str - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - service_
name This property is required. Changes to this property will trigger replacement.
- consumer
Project This property is required. Changes to this property will trigger replacement.
- policy
Data This property is required. String - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - service
Name This property is required. Changes to this property will trigger replacement.
Outputs
All input properties are implicitly available as output properties. Additionally, the ConsumersIamPolicy resource produces the following output properties:
Look up Existing ConsumersIamPolicy Resource
Get an existing ConsumersIamPolicy 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?: ConsumersIamPolicyState, opts?: CustomResourceOptions): ConsumersIamPolicy
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
consumer_project: Optional[str] = None,
etag: Optional[str] = None,
policy_data: Optional[str] = None,
service_name: Optional[str] = None) -> ConsumersIamPolicy
func GetConsumersIamPolicy(ctx *Context, name string, id IDInput, state *ConsumersIamPolicyState, opts ...ResourceOption) (*ConsumersIamPolicy, error)
public static ConsumersIamPolicy Get(string name, Input<string> id, ConsumersIamPolicyState? state, CustomResourceOptions? opts = null)
public static ConsumersIamPolicy get(String name, Output<String> id, ConsumersIamPolicyState state, CustomResourceOptions options)
resources: _: type: gcp:endpoints:ConsumersIamPolicy get: id: ${id}
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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.
- Consumer
Project Changes to this property will trigger replacement.
- Etag string
- (Computed) The etag of the IAM policy.
- Policy
Data string - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - Service
Name Changes to this property will trigger replacement.
- Consumer
Project Changes to this property will trigger replacement.
- Etag string
- (Computed) The etag of the IAM policy.
- Policy
Data string - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - Service
Name Changes to this property will trigger replacement.
- consumer
Project Changes to this property will trigger replacement.
- etag String
- (Computed) The etag of the IAM policy.
- policy
Data String - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - service
Name Changes to this property will trigger replacement.
- consumer
Project Changes to this property will trigger replacement.
- etag string
- (Computed) The etag of the IAM policy.
- policy
Data string - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - service
Name Changes to this property will trigger replacement.
- consumer_
project Changes to this property will trigger replacement.
- etag str
- (Computed) The etag of the IAM policy.
- policy_
data str - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - service_
name Changes to this property will trigger replacement.
- consumer
Project Changes to this property will trigger replacement.
- etag String
- (Computed) The etag of the IAM policy.
- policy
Data String - The policy data generated by
a
gcp.organizations.getIAMPolicy
data source. - service
Name Changes to this property will trigger replacement.
Import
For all import syntaxes, the “resource in question” can take any of the following forms:
services/{{service_name}}/consumers/{{consumer_project}}
{{service_name}}/{{consumer_project}}
{{consumer_project}}
Any variables not passed in the import command will be taken from the provider configuration.
Cloud Endpoints serviceconsumers IAM resources can be imported using the resource identifiers, role, and member.
IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.
$ pulumi import gcp:endpoints/consumersIamPolicy:ConsumersIamPolicy editor "services/{{service_name}}/consumers/{{consumer_project}} roles/servicemanagement.serviceController user:jane@example.com"
IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
$ pulumi import gcp:endpoints/consumersIamPolicy:ConsumersIamPolicy editor "services/{{service_name}}/consumers/{{consumer_project}} roles/servicemanagement.serviceController"
IAM policy imports use the identifier of the resource in question, e.g.
$ pulumi import gcp:endpoints/consumersIamPolicy:ConsumersIamPolicy editor services/{{service_name}}/consumers/{{consumer_project}}
-> Custom Roles If 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
.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.