com.pulumi.gcp.apigateway.kotlin.GatewayArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.apigateway.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.apigateway.GatewayArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* A consumable API that can be used by multiple Gateways.
* To get more information about Gateway, see:
* * [API documentation](https://cloud.google.com/api-gateway/docs/reference/rest/v1beta/projects.locations.apis)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/api-gateway/docs/quickstart)
* ## 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:
* ```sh
* $ pulumi import gcp:apigateway/gateway:Gateway default projects/{{project}}/locations/{{region}}/gateways/{{gateway_id}}
* ```
* ```sh
* $ pulumi import gcp:apigateway/gateway:Gateway default {{project}}/{{region}}/{{gateway_id}}
* ```
* ```sh
* $ pulumi import gcp:apigateway/gateway:Gateway default {{region}}/{{gateway_id}}
* ```
* ```sh
* $ pulumi import gcp:apigateway/gateway:Gateway default {{gateway_id}}
* ```
* @property apiConfig 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.
* @property displayName A user-visible name for the API.
* @property gatewayId Identifier to assign to the Gateway. Must be unique within scope of the parent resource(project).
* - - -
* @property labels 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.
* @property project The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
* @property region The region of the gateway for the API.
*/
public data class GatewayArgs(
public val apiConfig: Output? = null,
public val displayName: Output? = null,
public val gatewayId: Output? = null,
public val labels: Output
© 2015 - 2025 Weber Informatics LLC | Privacy Policy