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:

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}}
Content copied to clipboard
$ pulumi import gcp:apigateway/apiConfig:ApiConfig default {{project}}/{{api}}/{{api_config_id}}
Content copied to clipboard
$ pulumi import gcp:apigateway/apiConfig:ApiConfig default {{api}}/{{api_config_id}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(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)

Properties

Link copied to clipboard
val api: Output<String>? = null

The API to attach the config to.

Link copied to clipboard
val apiConfigId: Output<String>? = null

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

Link copied to clipboard
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.

Link copied to clipboard
val displayName: Output<String>? = null

A user-visible name for the API.

Link copied to clipboard
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.

Link copied to clipboard
val grpcServices: Output<List<ApiConfigGrpcServiceArgs>>? = null

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

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

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.

Link copied to clipboard
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.

Link copied to clipboard
val openapiDocuments: Output<List<ApiConfigOpenapiDocumentArgs>>? = null

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

Link copied to clipboard
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.

Functions

Link copied to clipboard
open override fun toJava(): ApiConfigArgs