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

GatewayArgs

data class GatewayArgs(val apiConfig: Output<String>? = null, val displayName: Output<String>? = null, val gatewayId: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val project: Output<String>? = null, val region: Output<String>? = null) : ConvertibleToJava<GatewayArgs>

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

API documentation
How-to Guides

Official Documentation

Example Usage

Apigateway Gateway Basic

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 com.pulumi.resources.CustomResourceOptions;
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 apiGwApi = new Api("apiGwApi", ApiArgs.builder()
            .apiId("my-api")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());
        var apiGwApiConfig = new ApiConfig("apiGwApiConfig", ApiConfigArgs.builder()
            .api(apiGwApi.apiId())
            .apiConfigId("my-config")
            .openapiDocuments(ApiConfigOpenapiDocumentArgs.builder()
                .document(ApiConfigOpenapiDocumentDocumentArgs.builder()
                    .path("spec.yaml")
                    .contents(Base64.getEncoder().encodeToString(Files.readAllBytes(Paths.get("test-fixtures/openapi.yaml"))))
                    .build())
                .build())
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());
        var apiGwGateway = new Gateway("apiGwGateway", GatewayArgs.builder()
            .apiConfig(apiGwApiConfig.id())
            .gatewayId("my-gateway")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());
    }
}

Import

Gateway can be imported using any of these accepted formats

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

$ pulumi import gcp:apigateway/gateway:Gateway default {{project}}/{{region}}/{{gateway_id}}

$ pulumi import gcp:apigateway/gateway:Gateway default {{region}}/{{gateway_id}}

$ pulumi import gcp:apigateway/gateway:Gateway default {{gateway_id}}

Constructors

GatewayArgs

constructor(apiConfig: Output<String>? = null, displayName: Output<String>? = null, gatewayId: Output<String>? = null, labels: Output<Map<String, String>>? = null, project: Output<String>? = null, region: Output<String>? = null)

Properties

apiConfig

val apiConfig: Output<String>? = null

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.

displayName

val displayName: Output<String>? = null

A user-visible name for the API.

gatewayId

val gatewayId: Output<String>? = null

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

labels