IAM policy for API Gateway Api

Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:

A data source can be used to retrieve policy data in advent you do not need creation

google_api_gateway_api_iam_policy

data "google_iam_policy" "admin" {
  provider = google-beta
  binding {
    role = "roles/apigateway.viewer"
    members = [
      "user:jane@example.com",
    ]
  }
}

resource "google_api_gateway_api_iam_policy" "policy" {
  provider = google-beta
  project = google_api_gateway_api.api.project
  api = google_api_gateway_api.api.api_id
  policy_data = data.google_iam_policy.admin.policy_data
}

google_api_gateway_api_iam_binding

resource "google_api_gateway_api_iam_binding" "binding" {
  provider = google-beta
  project = google_api_gateway_api.api.project
  api = google_api_gateway_api.api.api_id
  role = "roles/apigateway.viewer"
  members = [
    "user:jane@example.com",
  ]
}

google_api_gateway_api_iam_member

resource "google_api_gateway_api_iam_member" "member" {
  provider = google-beta
  project = google_api_gateway_api.api.project
  api = google_api_gateway_api.api.api_id
  role = "roles/apigateway.viewer"
  member = "user:jane@example.com"
}

Argument Reference

The following arguments are supported:

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

Import

For all import syntaxes, the "resource in question" can take any of the following forms:

Any variables not passed in the import command will be taken from the provider configuration.

API Gateway api 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_api_iam_member.editor "projects/{{project}}/locations/global/apis/{{api}} 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_api_iam_binding.editor "projects/{{project}}/locations/global/apis/{{api}} roles/apigateway.viewer"

IAM policy imports use the identifier of the resource in question, e.g.

$ terraform import google_api_gateway_api_iam_policy.editor projects/{{project}}/locations/global/apis/{{api}}

User Project Overrides

This resource supports User Project Overrides.