A consumable API that can be used by multiple Gateways.
To get more information about Api, see:
resource "google_api_gateway_api" "api" {
provider = google-beta
api_id = "my-api"
}
The following arguments are supported:
api_id
-
(Required)
Identifier to assign to the API. Must be unique within scope of the parent resource(project)display_name
-
(Optional)
A user-visible name for the API.
managed_service
-
(Optional)
Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed).
If not specified, a new Service will automatically be created in the same project as this API.
labels
-
(Optional)
Resource labels to represent user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labels
for all of the labels present on the resource.
project
- (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
In addition to the arguments listed above, the following computed attributes are exported:
id
- an identifier for the resource with format projects/{{project}}/locations/global/apis/{{api_id}}
name
-
The resource name of the API. Format projects/{{project}}/locations/global/apis/{{apiId}}
create_time
-
Creation timestamp in RFC3339 text format.
terraform_labels
-
The combination of labels configured directly on the resource
and default labels configured on the provider.
effective_labels
-
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
This resource provides the following Timeouts configuration options:
create
- Default is 20 minutes.update
- Default is 20 minutes.delete
- Default is 20 minutes.Api can be imported using any of these accepted formats:
projects/{{project}}/locations/global/apis/{{api_id}}
{{project}}/{{api_id}}
{{api_id}}
In Terraform v1.5.0 and later, use an import
block to import Api using one of the formats above. For example:
import {
id = "projects/{{project}}/locations/global/apis/{{api_id}}"
to = google_api_gateway_api.default
}
When using the terraform import
command, Api can be imported using one of the formats above. For example:
$ terraform import google_api_gateway_api.default projects/{{project}}/locations/global/apis/{{api_id}}
$ terraform import google_api_gateway_api.default {{project}}/{{api_id}}
$ terraform import google_api_gateway_api.default {{api_id}}
This resource supports User Project Overrides.