IAM policy for API Gateway Gateway
Three different resources help you manage your IAM policy for API Gateway Gateway. Each of these resources serves a different use case:
googleApiGatewayGatewayIamPolicy
: Authoritative. Sets the IAM policy for the gateway and replaces any existing policy already attached.googleApiGatewayGatewayIamBinding
: 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 gateway are preserved.googleApiGatewayGatewayIamMember
: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the gateway are preserved.
\~> Note: googleApiGatewayGatewayIamPolicy
cannot be used in conjunction with googleApiGatewayGatewayIamBinding
and googleApiGatewayGatewayIamMember
or they will fight over what your policy should be.
\~> Note: googleApiGatewayGatewayIamBinding
resources can be used in conjunction with googleApiGatewayGatewayIamMember
resources only if they do not grant privilege to the same role.
\~> Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.
googleApiGatewayGatewayIamPolicy
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const dataGoogleIamPolicyAdmin =
new google.dataGoogleIamPolicy.DataGoogleIamPolicy(this, "admin", {
binding: [
{
members: ["user:jane@example.com"],
role: "roles/apigateway.viewer",
},
],
provider: "${google-beta}",
});
new google.apiGatewayGatewayIamPolicy.ApiGatewayGatewayIamPolicy(
this,
"policy",
{
gateway: "${google_api_gateway_gateway.api_gw.gateway_id}",
policy_data: dataGoogleIamPolicyAdmin.policyData,
project: "${google_api_gateway_gateway.api_gw.project}",
provider: "${google-beta}",
region: "${google_api_gateway_gateway.api_gw.region}",
}
);
googleApiGatewayGatewayIamBinding
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.apiGatewayGatewayIamBinding.ApiGatewayGatewayIamBinding(
this,
"binding",
{
gateway: "${google_api_gateway_gateway.api_gw.gateway_id}",
members: ["user:jane@example.com"],
project: "${google_api_gateway_gateway.api_gw.project}",
provider: "${google-beta}",
region: "${google_api_gateway_gateway.api_gw.region}",
role: "roles/apigateway.viewer",
}
);
googleApiGatewayGatewayIamMember
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.apiGatewayGatewayIamMember.ApiGatewayGatewayIamMember(
this,
"member",
{
gateway: "${google_api_gateway_gateway.api_gw.gateway_id}",
member: "user:jane@example.com",
project: "${google_api_gateway_gateway.api_gw.project}",
provider: "${google-beta}",
region: "${google_api_gateway_gateway.api_gw.region}",
role: "roles/apigateway.viewer",
}
);
Argument Reference
The following arguments are supported:
-
region
- (Optional) The region of the gateway for the API. 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. -
project
- (Optional) 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/members
- (Required) Identities that will be granted the privilege inrole
. Each entry can have one of the following values:- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
- projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
- projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
- projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
-
role
- (Required) The role that should be applied. Only onegoogleApiGatewayGatewayIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parentName}/roles/{roleName}
. -
policyData
- (Required only bygoogleApiGatewayGatewayIamPolicy
) The policy data generated by agoogleIamPolicy
data source.
Attributes Reference
In addition to the arguments listed above, the following computed attributes are exported:
etag
- (Computed) The etag of the IAM policy.
Import
For all import syntaxes, the "resource in question" can take any of the following forms:
- projects/{{project}}/locations/{{region}}/gateways/{{gateway}}
- {{project}}/{{region}}/{{gateway}}
- {{region}}/{{gateway}}
- {{gateway}}
Any variables not passed in the import command will be taken from the provider configuration.
API Gateway gateway 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.
$ terraform import google_api_gateway_gateway_iam_member.editor "projects/{{project}}/locations/{{region}}/gateways/{{gateway}} roles/apigateway.viewer user:jane@example.com"
IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
$ terraform import google_api_gateway_gateway_iam_binding.editor "projects/{{project}}/locations/{{region}}/gateways/{{gateway}} roles/apigateway.viewer"
IAM policy imports use the identifier of the resource in question, e.g.
$ terraform import google_api_gateway_gateway_iam_policy.editor projects/{{project}}/locations/{{region}}/gateways/{{gateway}}
-> 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/myProject|organizations/myOrg]/roles/myCustomRole
.
User Project Overrides
This resource supports User Project Overrides.