pulumi-gcp-kotlin/com.pulumi.gcp.apigateway.kotlin/Gateway

Gateway

class Gateway : KotlinCustomResource

A consumable API that can be used by multiple Gateways. To get more information about Gateway, see:

Example Usage

Import

Gateway can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{region}}/gateways/{{gateway_id}}

  • {{project}}/{{region}}/{{gateway_id}}

  • {{region}}/{{gateway_id}}

  • {{gateway_id}} When using the pulumi import command, Gateway can be imported using one of the formats above. For example:

$ pulumi import gcp:apigateway/gateway:Gateway default projects/{{project}}/locations/{{region}}/gateways/{{gateway_id}}
Content copied to clipboard
$ pulumi import gcp:apigateway/gateway:Gateway default {{project}}/{{region}}/{{gateway_id}}
Content copied to clipboard
$ pulumi import gcp:apigateway/gateway:Gateway default {{region}}/{{gateway_id}}
Content copied to clipboard
$ pulumi import gcp:apigateway/gateway:Gateway default {{gateway_id}}
Content copied to clipboard

Properties

Link copied to clipboard
val apiConfig: Output<String>

Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}. When changing api configs please ensure the new config is a new resource and the lifecycle rule create_before_destroy is set.

Link copied to clipboard
val defaultHostname: Output<String>

The default API Gateway host name of the form {gatewayId}-{hash}.{region_code}.gateway.dev.

Link copied to clipboard
val displayName: Output<String>

A user-visible name for the API.

Link copied to clipboard
val effectiveLabels: Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

Link copied to clipboard
val gatewayId: Output<String>

Identifier to assign to the Gateway. Must be unique within scope of the parent resource(project).

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val labels: Output<Map<String, String>>?

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.

Link copied to clipboard
val name: Output<String>

Resource name of the Gateway. Format: projects/{project}/locations/{region}/gateways/{gateway}

Link copied to clipboard
val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
val pulumiLabels: Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val region: Output<String>

The region of the gateway for the API.

Link copied to clipboard
val urn: Output<String>