com.pulumi.gcp.apigateway.kotlin.ApiConfig.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.apigateway.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.apigateway.kotlin.outputs.ApiConfigGatewayConfig
import com.pulumi.gcp.apigateway.kotlin.outputs.ApiConfigGrpcService
import com.pulumi.gcp.apigateway.kotlin.outputs.ApiConfigManagedServiceConfig
import com.pulumi.gcp.apigateway.kotlin.outputs.ApiConfigOpenapiDocument
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.gcp.apigateway.kotlin.outputs.ApiConfigGatewayConfig.Companion.toKotlin as apiConfigGatewayConfigToKotlin
import com.pulumi.gcp.apigateway.kotlin.outputs.ApiConfigGrpcService.Companion.toKotlin as apiConfigGrpcServiceToKotlin
import com.pulumi.gcp.apigateway.kotlin.outputs.ApiConfigManagedServiceConfig.Companion.toKotlin as apiConfigManagedServiceConfigToKotlin
import com.pulumi.gcp.apigateway.kotlin.outputs.ApiConfigOpenapiDocument.Companion.toKotlin as apiConfigOpenapiDocumentToKotlin
/**
* Builder for [ApiConfig].
*/
@PulumiTagMarker
public class ApiConfigResourceBuilder internal constructor() {
public var name: String? = null
public var args: ApiConfigArgs = ApiConfigArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend ApiConfigArgsBuilder.() -> Unit) {
val builder = ApiConfigArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): ApiConfig {
val builtJavaResource = com.pulumi.gcp.apigateway.ApiConfig(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ApiConfig(builtJavaResource)
}
}
/**
* An API Configuration is an association of an API Controller Config and a Gateway Config
* To get more information about ApiConfig, see:
* * [API documentation](https://cloud.google.com/api-gateway/docs/reference/rest/v1beta/projects.locations.apis.configs)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/api-gateway/docs/creating-api-config)
* ## 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:
* ```sh
* $ pulumi import gcp:apigateway/apiConfig:ApiConfig default projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config_id}}
* ```
* ```sh
* $ pulumi import gcp:apigateway/apiConfig:ApiConfig default {{project}}/{{api}}/{{api_config_id}}
* ```
* ```sh
* $ pulumi import gcp:apigateway/apiConfig:ApiConfig default {{api}}/{{api_config_id}}
* ```
*/
public class ApiConfig internal constructor(
override val javaResource: com.pulumi.gcp.apigateway.ApiConfig,
) : KotlinCustomResource(javaResource, ApiConfigMapper) {
/**
* The API to attach the config to.
* - - -
*/
public val api: Output
get() = javaResource.api().applyValue({ args0 -> args0 })
/**
* Identifier to assign to the API Config. Must be unique within scope of the parent resource(api).
*/
public val apiConfigId: Output
get() = javaResource.apiConfigId().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val apiConfigIdPrefix: Output
get() = javaResource.apiConfigIdPrefix().applyValue({ args0 -> args0 })
/**
* A user-visible name for the API.
*/
public val displayName: Output
get() = javaResource.displayName().applyValue({ args0 -> args0 })
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
public val effectiveLabels: Output>
get() = javaResource.effectiveLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* 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.
*/
public val gatewayConfig: Output?
get() = javaResource.gatewayConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> apiConfigGatewayConfigToKotlin(args0) })
}).orElse(null)
})
/**
* gRPC service definition files. If specified, openapiDocuments must not be included.
* Structure is documented below.
*/
public val grpcServices: Output>?
get() = javaResource.grpcServices().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> apiConfigGrpcServiceToKotlin(args0) })
})
}).orElse(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.
*/
public val labels: Output>?
get() = javaResource.labels().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(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.
*/
public val managedServiceConfigs: Output>?
get() = javaResource.managedServiceConfigs().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
apiConfigManagedServiceConfigToKotlin(args0)
})
})
}).orElse(null)
})
/**
* The resource name of the API Config.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* OpenAPI specification documents. If specified, grpcServices and managedServiceConfigs must not be included.
* Structure is documented below.
*/
public val openapiDocuments: Output>?
get() = javaResource.openapiDocuments().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
apiConfigOpenapiDocumentToKotlin(args0)
})
})
}).orElse(null)
})
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
public val pulumiLabels: Output>
get() = javaResource.pulumiLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The ID of the associated Service Config (https://cloud.google.com/service-infrastructure/docs/glossary#config).
*/
public val serviceConfigId: Output
get() = javaResource.serviceConfigId().applyValue({ args0 -> args0 })
}
public object ApiConfigMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.apigateway.ApiConfig::class == javaResource::class
override fun map(javaResource: Resource): ApiConfig = ApiConfig(
javaResource as
com.pulumi.gcp.apigateway.ApiConfig,
)
}
/**
* @see [ApiConfig].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ApiConfig].
*/
public suspend fun apiConfig(name: String, block: suspend ApiConfigResourceBuilder.() -> Unit): ApiConfig {
val builder = ApiConfigResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ApiConfig].
* @param name The _unique_ name of the resulting resource.
*/
public fun apiConfig(name: String): ApiConfig {
val builder = ApiConfigResourceBuilder()
builder.name(name)
return builder.build()
}