1. Docs
  2. Reference
  3. API
  4. GCP
  5. endpoints
  6. ServiceIamPolicy

ServiceIamPolicy

Three different resources help you manage your IAM policy for Cloud Endpoints Service. Each of these resources serves a different use case:

  • gcp.endpoints.ServiceIamPolicy: Authoritative. Sets the IAM policy for the service and replaces any existing policy already attached.
  • gcp.endpoints.ServiceIamBinding: 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 service are preserved.
  • gcp.endpoints.ServiceIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service are preserved.

Note: gcp.endpoints.ServiceIamPolicy cannot be used in conjunction with gcp.endpoints.ServiceIamBinding and gcp.endpoints.ServiceIamMember or they will fight over what your policy should be.

Note: gcp.endpoints.ServiceIamBinding resources can be used in conjunction with gcp.endpoints.ServiceIamMember resources only if they do not grant privilege to the same role.

Create a ServiceIamPolicy Resource

new ServiceIamPolicy(name: string, args: ServiceIamPolicyArgs, opts?: CustomResourceOptions);
def ServiceIamPolicy(resource_name, opts=None, policy_data=None, service_name=None, __props__=None);
func NewServiceIamPolicy(ctx *Context, name string, args ServiceIamPolicyArgs, opts ...ResourceOption) (*ServiceIamPolicy, error)
public ServiceIamPolicy(string name, ServiceIamPolicyArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ServiceIamPolicyArgs
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 ServiceIamPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ServiceIamPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ServiceIamPolicy Resource Properties

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

Inputs

The ServiceIamPolicy resource accepts the following input properties:

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

ServiceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

ServiceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

policyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

serviceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

policy_data str

The policy data generated by a gcp.organizations.getIAMPolicy data source.

service_name str

The name of the service. Used to find the parent resource to bind the IAM policy to

Outputs

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

Etag string

(Computed) The etag of the IAM policy.

Id string
The provider-assigned unique ID for this managed resource.
Etag string

(Computed) The etag of the IAM policy.

Id string
The provider-assigned unique ID for this managed resource.
etag string

(Computed) The etag of the IAM policy.

id string
The provider-assigned unique ID for this managed resource.
etag str

(Computed) The etag of the IAM policy.

id str
The provider-assigned unique ID for this managed resource.

Look up an Existing ServiceIamPolicy Resource

Get an existing ServiceIamPolicy 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?: ServiceIamPolicyState, opts?: CustomResourceOptions): ServiceIamPolicy
static get(resource_name, id, opts=None, etag=None, policy_data=None, service_name=None, __props__=None);
func GetServiceIamPolicy(ctx *Context, name string, id IDInput, state *ServiceIamPolicyState, opts ...ResourceOption) (*ServiceIamPolicy, error)
public static ServiceIamPolicy Get(string name, Input<string> id, ServiceIamPolicyState? 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 IAM policy.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

ServiceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

Etag string

(Computed) The etag of the IAM policy.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

ServiceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

etag string

(Computed) The etag of the IAM policy.

policyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

serviceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

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 str

The name of the service. Used to find the parent resource to bind the 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-beta Terraform Provider.