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

ApiConfigArgs

data class ApiConfigArgs(val api: Output<String>? = null, val apiConfigId: Output<String>? = null, val apiConfigIdPrefix: Output<String>? = null, val displayName: Output<String>? = null, val gatewayConfig: Output<ApiConfigGatewayConfigArgs>? = null, val grpcServices: Output<List<ApiConfigGrpcServiceArgs>>? = null, val labels: Output<Map<String, String>>? = null, val managedServiceConfigs: Output<List<ApiConfigManagedServiceConfigArgs>>? = null, val openapiDocuments: Output<List<ApiConfigOpenapiDocumentArgs>>? = null, val project: Output<String>? = null) : ConvertibleToJava<ApiConfigArgs>

An API Configuration is an association of an API Controller Config and a Gateway Config To get more information about ApiConfig, see:

API documentation
How-to Guides

Official Documentation

Example Usage

Apigateway Api Config 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.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 apiCfgApi = new Api("apiCfgApi", ApiArgs.builder()
            .apiId("my-api")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());
        var apiCfgApiConfig = new ApiConfig("apiCfgApiConfig", ApiConfigArgs.builder()
            .api(apiCfgApi.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());
    }
}

Import

ApiConfig can be imported using any of these accepted formats

$ pulumi import gcp:apigateway/apiConfig:ApiConfig default projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config_id}}

$ pulumi import gcp:apigateway/apiConfig:ApiConfig default {{project}}/{{api}}/{{api_config_id}}

$ pulumi import gcp:apigateway/apiConfig:ApiConfig default {{api}}/{{api_config_id}}

Constructors

ApiConfigArgs

fun ApiConfigArgs(api: Output<String>? = null, apiConfigId: Output<String>? = null, apiConfigIdPrefix: Output<String>? = null, displayName: Output<String>? = null, gatewayConfig: Output<ApiConfigGatewayConfigArgs>? = null, grpcServices: Output<List<ApiConfigGrpcServiceArgs>>? = null, labels: Output<Map<String, String>>? = null, managedServiceConfigs: Output<List<ApiConfigManagedServiceConfigArgs>>? = null, openapiDocuments: Output<List<ApiConfigOpenapiDocumentArgs>>? = null, project: Output<String>? = null)

Functions

toJava

open override fun toJava(): ApiConfigArgs

Properties

api

val api: Output<String>? = null

The API to attach the config to.

apiConfigId

val apiConfigId: Output<String>? = null

Identifier to assign to the API Config. Must be unique within scope of the parent resource(api).

apiConfigIdPrefix

val apiConfigIdPrefix: Output<String>? = null

Creates a unique name beginning with the specified prefix. If this and api_config_id are unspecified, a random value is chosen for the name.

displayName

val displayName: Output<String>? = null

A user-visible name for the API.

gatewayConfig

val gatewayConfig: Output<ApiConfigGatewayConfigArgs>? = null

Immutable. Gateway specific configuration. If not specified, backend authentication will be set to use OIDC authentication using the default compute service account Structure is documented below.

grpcServices

val grpcServices: Output<List<ApiConfigGrpcServiceArgs>>? = null

gRPC service definition files. If specified, openapiDocuments must not be included. Structure is documented below.

labels

val labels: Output<Map<String, String>>? = null

Resource labels to represent user-provided metadata.

managedServiceConfigs

val managedServiceConfigs: Output<List<ApiConfigManagedServiceConfigArgs>>? = null

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields. Structure is documented below.

openapiDocuments

val openapiDocuments: Output<List<ApiConfigOpenapiDocumentArgs>>? = null

OpenAPI specification documents. If specified, grpcServices and managedServiceConfigs must not be included. Structure is documented below.

project

val project: Output<String>? = null

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