Package-level declarations

Types

Link copied to clipboard
class Api : KotlinCustomResource

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

Link copied to clipboard
data class ApiArgs(val apiId: Output<String>? = null, val displayName: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val managedService: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<ApiArgs>

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

Link copied to clipboard

Builder for ApiArgs.

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

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

Link copied to clipboard
Link copied to clipboard
class ApiConfigIamBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for API Gateway ApiConfig. Each of these resources serves a different use case:

Link copied to clipboard
data class ApiConfigIamBindingArgs(val api: Output<String>? = null, val apiConfig: Output<String>? = null, val condition: Output<ApiConfigIamBindingConditionArgs>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<ApiConfigIamBindingArgs>

Three different resources help you manage your IAM policy for API Gateway ApiConfig. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class ApiConfigIamMember : KotlinCustomResource

Three different resources help you manage your IAM policy for API Gateway ApiConfig. Each of these resources serves a different use case:

Link copied to clipboard
data class ApiConfigIamMemberArgs(val api: Output<String>? = null, val apiConfig: Output<String>? = null, val condition: Output<ApiConfigIamMemberConditionArgs>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<ApiConfigIamMemberArgs>

Three different resources help you manage your IAM policy for API Gateway ApiConfig. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class ApiConfigIamPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for API Gateway ApiConfig. Each of these resources serves a different use case:

Link copied to clipboard
data class ApiConfigIamPolicyArgs(val api: Output<String>? = null, val apiConfig: Output<String>? = null, val policyData: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<ApiConfigIamPolicyArgs>

Three different resources help you manage your IAM policy for API Gateway ApiConfig. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object ApiConfigMapper : ResourceMapper<ApiConfig>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class ApiIamBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:

Link copied to clipboard
data class ApiIamBindingArgs(val api: Output<String>? = null, val condition: Output<ApiIamBindingConditionArgs>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<ApiIamBindingArgs>

Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object ApiIamBindingMapper : ResourceMapper<ApiIamBinding>
Link copied to clipboard
Link copied to clipboard
class ApiIamMember : KotlinCustomResource

Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:

Link copied to clipboard
data class ApiIamMemberArgs(val api: Output<String>? = null, val condition: Output<ApiIamMemberConditionArgs>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<ApiIamMemberArgs>

Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object ApiIamMemberMapper : ResourceMapper<ApiIamMember>
Link copied to clipboard
Link copied to clipboard
class ApiIamPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:

Link copied to clipboard
data class ApiIamPolicyArgs(val api: Output<String>? = null, val policyData: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<ApiIamPolicyArgs>

Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object ApiIamPolicyMapper : ResourceMapper<ApiIamPolicy>
Link copied to clipboard
Link copied to clipboard
object ApiMapper : ResourceMapper<Api>
Link copied to clipboard

Builder for Api.

Link copied to clipboard
class Gateway : KotlinCustomResource

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

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

Link copied to clipboard
Link copied to clipboard
class GatewayIamBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for API Gateway Gateway. Each of these resources serves a different use case:

Link copied to clipboard
data class GatewayIamBindingArgs(val condition: Output<GatewayIamBindingConditionArgs>? = null, val gateway: Output<String>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<GatewayIamBindingArgs>

Three different resources help you manage your IAM policy for API Gateway Gateway. Each of these resources serves a different use case:

Link copied to clipboard
object GatewayIamBindingMapper : ResourceMapper<GatewayIamBinding>
Link copied to clipboard
class GatewayIamMember : KotlinCustomResource

Three different resources help you manage your IAM policy for API Gateway Gateway. Each of these resources serves a different use case:

Link copied to clipboard
data class GatewayIamMemberArgs(val condition: Output<GatewayIamMemberConditionArgs>? = null, val gateway: Output<String>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<GatewayIamMemberArgs>

Three different resources help you manage your IAM policy for API Gateway Gateway. Each of these resources serves a different use case:

Link copied to clipboard
object GatewayIamMemberMapper : ResourceMapper<GatewayIamMember>
Link copied to clipboard
class GatewayIamPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for API Gateway Gateway. Each of these resources serves a different use case:

Link copied to clipboard
data class GatewayIamPolicyArgs(val gateway: Output<String>? = null, val policyData: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null) : ConvertibleToJava<GatewayIamPolicyArgs>

Three different resources help you manage your IAM policy for API Gateway Gateway. Each of these resources serves a different use case:

Link copied to clipboard
object GatewayIamPolicyMapper : ResourceMapper<GatewayIamPolicy>
Link copied to clipboard
object GatewayMapper : ResourceMapper<Gateway>
Link copied to clipboard

Functions

Link copied to clipboard
fun api(name: String): Api
suspend fun api(name: String, block: suspend ApiResourceBuilder.() -> Unit): Api
Link copied to clipboard
suspend fun apiConfig(name: String, block: suspend ApiConfigResourceBuilder.() -> Unit): ApiConfig
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun gateway(name: String): Gateway
suspend fun gateway(name: String, block: suspend GatewayResourceBuilder.() -> Unit): Gateway
Link copied to clipboard
Link copied to clipboard