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
* ### Apigateway Gateway Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as std from "@pulumi/std";
* const apiGw = new gcp.apigateway.Api("api_gw", {apiId: "my-api"});
* const apiGwApiConfig = new gcp.apigateway.ApiConfig("api_gw", {
* api: apiGw.apiId,
* apiConfigId: "my-config",
* openapiDocuments: [{
* document: {
* path: "spec.yaml",
* contents: std.filebase64({
* input: "test-fixtures/openapi.yaml",
* }).then(invoke => invoke.result),
* },
* }],
* });
* const apiGwGateway = new gcp.apigateway.Gateway("api_gw", {
* apiConfig: apiGwApiConfig.id,
* gatewayId: "my-gateway",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* import pulumi_std as std
* api_gw = gcp.apigateway.Api("api_gw", api_id="my-api")
* api_gw_api_config = gcp.apigateway.ApiConfig("api_gw",
* api=api_gw.api_id,
* api_config_id="my-config",
* openapi_documents=[gcp.apigateway.ApiConfigOpenapiDocumentArgs(
* document=gcp.apigateway.ApiConfigOpenapiDocumentDocumentArgs(
* path="spec.yaml",
* contents=std.filebase64(input="test-fixtures/openapi.yaml").result,
* ),
* )])
* api_gw_gateway = gcp.apigateway.Gateway("api_gw",
* api_config=api_gw_api_config.id,
* gateway_id="my-gateway")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* using Std = Pulumi.Std;
* return await Deployment.RunAsync(() =>
* {
* var apiGw = new Gcp.ApiGateway.Api("api_gw", new()
* {
* ApiId = "my-api",
* });
* var apiGwApiConfig = new Gcp.ApiGateway.ApiConfig("api_gw", new()
* {
* Api = apiGw.ApiId,
* ApiConfigId = "my-config",
* OpenapiDocuments = new[]
* {
* new Gcp.ApiGateway.Inputs.ApiConfigOpenapiDocumentArgs
* {
* Document = new Gcp.ApiGateway.Inputs.ApiConfigOpenapiDocumentDocumentArgs
* {
* Path = "spec.yaml",
* Contents = Std.Filebase64.Invoke(new()
* {
* Input = "test-fixtures/openapi.yaml",
* }).Apply(invoke => invoke.Result),
* },
* },
* },
* });
* var apiGwGateway = new Gcp.ApiGateway.Gateway("api_gw", new()
* {
* ApiConfig = apiGwApiConfig.Id,
* GatewayId = "my-gateway",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
* "github.com/pulumi/pulumi-std/sdk/go/std"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* apiGw, err := apigateway.NewApi(ctx, "api_gw", &apigateway.ApiArgs{
* ApiId: pulumi.String("my-api"),
* })
* if err != nil {
* return err
* }
* invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
* Input: "test-fixtures/openapi.yaml",
* }, nil)
* if err != nil {
* return err
* }
* apiGwApiConfig, err := apigateway.NewApiConfig(ctx, "api_gw", &apigateway.ApiConfigArgs{
* Api: apiGw.ApiId,
* ApiConfigId: pulumi.String("my-config"),
* OpenapiDocuments: apigateway.ApiConfigOpenapiDocumentArray{
* &apigateway.ApiConfigOpenapiDocumentArgs{
* Document: &apigateway.ApiConfigOpenapiDocumentDocumentArgs{
* Path: pulumi.String("spec.yaml"),
* Contents: invokeFilebase64.Result,
* },
* },
* },
* })
* if err != nil {
* return err
* }
* _, err = apigateway.NewGateway(ctx, "api_gw", &apigateway.GatewayArgs{
* ApiConfig: apiGwApiConfig.ID(),
* GatewayId: pulumi.String("my-gateway"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.apigateway.Api;
* import com.pulumi.gcp.apigateway.ApiArgs;
* import com.pulumi.gcp.apigateway.ApiConfig;
* import com.pulumi.gcp.apigateway.ApiConfigArgs;
* import com.pulumi.gcp.apigateway.inputs.ApiConfigOpenapiDocumentArgs;
* import com.pulumi.gcp.apigateway.inputs.ApiConfigOpenapiDocumentDocumentArgs;
* import com.pulumi.gcp.apigateway.Gateway;
* import com.pulumi.gcp.apigateway.GatewayArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var apiGw = new Api("apiGw", ApiArgs.builder()
* .apiId("my-api")
* .build());
* var apiGwApiConfig = new ApiConfig("apiGwApiConfig", ApiConfigArgs.builder()
* .api(apiGw.apiId())
* .apiConfigId("my-config")
* .openapiDocuments(ApiConfigOpenapiDocumentArgs.builder()
* .document(ApiConfigOpenapiDocumentDocumentArgs.builder()
* .path("spec.yaml")
* .contents(StdFunctions.filebase64(Filebase64Args.builder()
* .input("test-fixtures/openapi.yaml")
* .build()).result())
* .build())
* .build())
* .build());
* var apiGwGateway = new Gateway("apiGwGateway", GatewayArgs.builder()
* .apiConfig(apiGwApiConfig.id())
* .gatewayId("my-gateway")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* apiGw:
* type: gcp:apigateway:Api
* name: api_gw
* properties:
* apiId: my-api
* apiGwApiConfig:
* type: gcp:apigateway:ApiConfig
* name: api_gw
* properties:
* api: ${apiGw.apiId}
* apiConfigId: my-config
* openapiDocuments:
* - document:
* path: spec.yaml
* contents:
* fn::invoke:
* Function: std:filebase64
* Arguments:
* input: test-fixtures/openapi.yaml
* Return: result
* apiGwGateway:
* type: gcp:apigateway:Gateway
* name: api_gw
* properties:
* apiConfig: ${apiGwApiConfig.id}
* gatewayId: my-gateway
* ```
*
* ## 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>? = null,
public val project: Output? = null,
public val region: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.apigateway.GatewayArgs =
com.pulumi.gcp.apigateway.GatewayArgs.builder()
.apiConfig(apiConfig?.applyValue({ args0 -> args0 }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.gatewayId(gatewayId?.applyValue({ args0 -> args0 }))
.labels(labels?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.project(project?.applyValue({ args0 -> args0 }))
.region(region?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [GatewayArgs].
*/
@PulumiTagMarker
public class GatewayArgsBuilder internal constructor() {
private var apiConfig: Output? = null
private var displayName: Output? = null
private var gatewayId: Output? = null
private var labels: Output>? = null
private var project: Output? = null
private var region: Output? = null
/**
* @param value 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.
*/
@JvmName("xnobohkopctvpmsx")
public suspend fun apiConfig(`value`: Output) {
this.apiConfig = value
}
/**
* @param value A user-visible name for the API.
*/
@JvmName("xcapkiqxjbamydot")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value Identifier to assign to the Gateway. Must be unique within scope of the parent resource(project).
* - - -
*/
@JvmName("hyidhkvmegftlpat")
public suspend fun gatewayId(`value`: Output) {
this.gatewayId = value
}
/**
* @param value 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.
*/
@JvmName("hsdahmiivsubmsox")
public suspend fun labels(`value`: Output>) {
this.labels = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("xntnyesxiakheute")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value The region of the gateway for the API.
*/
@JvmName("vpnuaqnqfdunrkvw")
public suspend fun region(`value`: Output) {
this.region = value
}
/**
* @param value 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.
*/
@JvmName("yahimvxrmlgsggjq")
public suspend fun apiConfig(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.apiConfig = mapped
}
/**
* @param value A user-visible name for the API.
*/
@JvmName("cdkjhknwewhqaxih")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value Identifier to assign to the Gateway. Must be unique within scope of the parent resource(project).
* - - -
*/
@JvmName("eoxqxqmrhnugomnm")
public suspend fun gatewayId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.gatewayId = mapped
}
/**
* @param value 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.
*/
@JvmName("smekgaagxqewrvri")
public suspend fun labels(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param values 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.
*/
@JvmName("fvufssvobvsvcpdp")
public fun labels(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("xddltoqmnpitqear")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
/**
* @param value The region of the gateway for the API.
*/
@JvmName("fayalmngeixlqyqv")
public suspend fun region(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.region = mapped
}
internal fun build(): GatewayArgs = GatewayArgs(
apiConfig = apiConfig,
displayName = displayName,
gatewayId = gatewayId,
labels = labels,
project = project,
region = region,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy