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

ApiConfig

class ApiConfig : KotlinCustomResource

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

Import

ApiConfig can be imported using any of these accepted formats:

projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config_id}}
{{project}}/{{api}}/{{api_config_id}}
{{api}}/{{api_config_id}} When using the pulumi import command, ApiConfig can be imported using one of the formats above. For example:

$ 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}}

Properties

api

val api: Output<String>

The API to attach the config to.

apiConfigId

val apiConfigId: Output<String>

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

apiConfigIdPrefix

val apiConfigIdPrefix: Output<String>

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>

A user-visible name for the API.

effectiveLabels

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.

gatewayConfig

val gatewayConfig: Output<ApiConfigGatewayConfig>?

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<ApiConfigGrpcService>>?

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

val id: Output<String>

labels

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.

managedServiceConfigs

val managedServiceConfigs: Output<List<ApiConfigManagedServiceConfig>>?

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.

name

val name: Output<String>

The resource name of the API Config.

openapiDocuments

val openapiDocuments: Output<List<ApiConfigOpenapiDocument>>?

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

project

val project: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiLabels

val pulumiLabels: Output<Map<String, String>>

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

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

serviceConfigId

val serviceConfigId: Output<String>

The ID of the associated Service Config (https://cloud.google.com/service-infrastructure/docs/glossary#config).

urn

val urn: Output<String>