FunctionIamPolicy
Three different resources help you manage your IAM policy for Cloud Functions CloudFunction. Each of these resources serves a different use case:
gcp.cloudfunctions.FunctionIamPolicy: Authoritative. Sets the IAM policy for the cloudfunction and replaces any existing policy already attached.gcp.cloudfunctions.FunctionIamBinding: 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 cloudfunction are preserved.gcp.cloudfunctions.FunctionIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the cloudfunction are preserved.
Note:
gcp.cloudfunctions.FunctionIamPolicycannot be used in conjunction withgcp.cloudfunctions.FunctionIamBindingandgcp.cloudfunctions.FunctionIamMemberor they will fight over what your policy should be.Note:
gcp.cloudfunctions.FunctionIamBindingresources can be used in conjunction withgcp.cloudfunctions.FunctionIamMemberresources only if they do not grant privilege to the same role.
Create a FunctionIamPolicy Resource
new FunctionIamPolicy(name: string, args: FunctionIamPolicyArgs, opts?: CustomResourceOptions);def FunctionIamPolicy(resource_name, opts=None, cloud_function=None, policy_data=None, project=None, region=None, __props__=None);func NewFunctionIamPolicy(ctx *Context, name string, args FunctionIamPolicyArgs, opts ...ResourceOption) (*FunctionIamPolicy, error)public FunctionIamPolicy(string name, FunctionIamPolicyArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args FunctionIamPolicyArgs
- 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 FunctionIamPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FunctionIamPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
FunctionIamPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The FunctionIamPolicy resource accepts the following input properties:
- Cloud
Function string Used to find the parent resource to bind the IAM policy to
- Policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- 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.
- Region string
The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
- Cloud
Function string Used to find the parent resource to bind the IAM policy to
- Policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- 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.
- Region string
The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
- cloud
Function string Used to find the parent resource to bind the IAM policy to
- policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- 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.
- region string
The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
- cloud_
function str Used to find the parent resource to bind the IAM policy to
- policy_
data str The policy data generated by a
gcp.organizations.getIAMPolicydata source.- 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.
- region str
The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
Outputs
All input properties are implicitly available as output properties. Additionally, the FunctionIamPolicy resource produces the following output properties:
Look up an Existing FunctionIamPolicy Resource
Get an existing FunctionIamPolicy 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?: FunctionIamPolicyState, opts?: CustomResourceOptions): FunctionIamPolicystatic get(resource_name, id, opts=None, cloud_function=None, etag=None, policy_data=None, project=None, region=None, __props__=None);func GetFunctionIamPolicy(ctx *Context, name string, id IDInput, state *FunctionIamPolicyState, opts ...ResourceOption) (*FunctionIamPolicy, error)public static FunctionIamPolicy Get(string name, Input<string> id, FunctionIamPolicyState? 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:
- Cloud
Function string Used to find the parent resource to bind the IAM policy to
- Etag string
(Computed) The etag of the IAM policy.
- Policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- 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.
- Region string
The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
- Cloud
Function string Used to find the parent resource to bind the IAM policy to
- Etag string
(Computed) The etag of the IAM policy.
- Policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- 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.
- Region string
The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
- cloud
Function string Used to find the parent resource to bind the IAM policy to
- etag string
(Computed) The etag of the IAM policy.
- policy
Data string The policy data generated by a
gcp.organizations.getIAMPolicydata source.- 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.
- region string
The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
- cloud_
function str 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.getIAMPolicydata source.- 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.
- region str
The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.