Package-level declarations

Types

Link copied to clipboard
class AccessControlList : KotlinCustomResource

Provides a Api Gateway Access Control List resource. Access control list. For information about Api Gateway Access Control List and how to use it, see What is Access Control List.

Link copied to clipboard
data class AccessControlListArgs(val accessControlListName: Output<String>? = null, val aclEntrys: Output<List<AccessControlListAclEntryArgs>>? = null, val addressIpVersion: Output<String>? = null) : ConvertibleToJava<AccessControlListArgs>

Provides a Api Gateway Access Control List resource. Access control list. For information about Api Gateway Access Control List and how to use it, see What is Access Control List.

Link copied to clipboard
object AccessControlListMapper : ResourceMapper<AccessControlList>
Link copied to clipboard
class AclEntryAttachment : KotlinCustomResource

Provides an ACL entry attachment resource for attaching ACL entry to an API Gateway ACL.

Link copied to clipboard
data class AclEntryAttachmentArgs(val aclId: Output<String>? = null, val comment: Output<String>? = null, val entry: Output<String>? = null) : ConvertibleToJava<AclEntryAttachmentArgs>

Provides an ACL entry attachment resource for attaching ACL entry to an API Gateway ACL.

Link copied to clipboard
Link copied to clipboard
class Api : KotlinCustomResource

Basic Usage

Link copied to clipboard
data class ApiArgs(val authType: Output<String>? = null, val constantParameters: Output<List<ApiConstantParameterArgs>>? = null, val description: Output<String>? = null, val fcServiceConfig: Output<ApiFcServiceConfigArgs>? = null, val forceNonceCheck: Output<Boolean>? = null, val groupId: Output<String>? = null, val httpServiceConfig: Output<ApiHttpServiceConfigArgs>? = null, val httpVpcServiceConfig: Output<ApiHttpVpcServiceConfigArgs>? = null, val mockServiceConfig: Output<ApiMockServiceConfigArgs>? = null, val name: Output<String>? = null, val requestConfig: Output<ApiRequestConfigArgs>? = null, val requestParameters: Output<List<ApiRequestParameterArgs>>? = null, val serviceType: Output<String>? = null, val stageNames: Output<List<String>>? = null, val systemParameters: Output<List<ApiSystemParameterArgs>>? = null) : ConvertibleToJava<ApiArgs>

Basic Usage

Link copied to clipboard

Builder for ApiArgs.

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

Builder for Api.

Link copied to clipboard
class App : KotlinCustomResource

Basic Usage

Link copied to clipboard
data class AppArgs(val description: Output<String>? = null, val name: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<AppArgs>

Basic Usage

Link copied to clipboard

Builder for AppArgs.

Link copied to clipboard
class AppAttachment : KotlinCustomResource

Basic Usage

Link copied to clipboard
data class AppAttachmentArgs(val apiId: Output<String>? = null, val appId: Output<String>? = null, val groupId: Output<String>? = null, val stageName: Output<String>? = null) : ConvertibleToJava<AppAttachmentArgs>

Basic Usage

Link copied to clipboard
Link copied to clipboard
object AppAttachmentMapper : ResourceMapper<AppAttachment>
Link copied to clipboard
Link copied to clipboard
object AppMapper : ResourceMapper<App>
Link copied to clipboard

Builder for App.

Link copied to clipboard
class Backend : KotlinCustomResource

Provides a Api Gateway Backend resource. For information about Api Gateway Backend and how to use it, see What is Backend.

Link copied to clipboard
data class BackendArgs(val backendName: Output<String>? = null, val backendType: Output<String>? = null, val createEventBridgeServiceLinkedRole: Output<Boolean>? = null, val description: Output<String>? = null) : ConvertibleToJava<BackendArgs>

Provides a Api Gateway Backend resource. For information about Api Gateway Backend and how to use it, see What is Backend.

Link copied to clipboard
Link copied to clipboard
object BackendMapper : ResourceMapper<Backend>
Link copied to clipboard
Link copied to clipboard
class Group : KotlinCustomResource

Basic Usage

Link copied to clipboard
data class GroupArgs(val basePath: Output<String>? = null, val description: Output<String>? = null, val instanceId: Output<String>? = null, val name: Output<String>? = null, val userLogConfig: Output<GroupUserLogConfigArgs>? = null, val vpcIntranetEnable: Output<Boolean>? = null) : ConvertibleToJava<GroupArgs>

Basic Usage

Link copied to clipboard

Builder for GroupArgs.

Link copied to clipboard
object GroupMapper : ResourceMapper<Group>
Link copied to clipboard

Builder for Group.

Link copied to clipboard
class Instance : KotlinCustomResource

Provides a Api Gateway Instance resource. For information about Api Gateway Instance and how to use it, see What is Instance.

Link copied to clipboard
class InstanceAclAttachment : KotlinCustomResource

Provides an Instance ACL attachment resource for attaching an ACL to a specific API Gateway instance.

Link copied to clipboard
data class InstanceAclAttachmentArgs(val aclId: Output<String>? = null, val aclType: Output<String>? = null, val instanceId: Output<String>? = null) : ConvertibleToJava<InstanceAclAttachmentArgs>

Provides an Instance ACL attachment resource for attaching an ACL to a specific API Gateway instance.

Link copied to clipboard
Link copied to clipboard
data class InstanceArgs(val deleteVpcIpBlock: Output<String>? = null, val duration: Output<Int>? = null, val egressIpv6Enable: Output<Boolean>? = null, val httpsPolicy: Output<String>? = null, val ingressVpcId: Output<String>? = null, val ingressVpcOwnerId: Output<String>? = null, val ingressVswitchId: Output<String>? = null, val instanceCidr: Output<String>? = null, val instanceName: Output<String>? = null, val instanceSpec: Output<String>? = null, val instanceType: Output<String>? = null, val ipv6Enabled: Output<Boolean>? = null, val paymentType: Output<String>? = null, val pricingCycle: Output<String>? = null, val skipWaitSwitch: Output<Boolean>? = null, val toConnectVpcIpBlock: Output<InstanceToConnectVpcIpBlockArgs>? = null, val userVpcId: Output<String>? = null, val vpcSlbIntranetEnable: Output<Boolean>? = null, val zoneId: Output<String>? = null, val zoneVswitchSecurityGroups: Output<List<InstanceZoneVswitchSecurityGroupArgs>>? = null) : ConvertibleToJava<InstanceArgs>

Provides a Api Gateway Instance resource. For information about Api Gateway Instance and how to use it, see What is Instance.

Link copied to clipboard
Link copied to clipboard
object InstanceMapper : ResourceMapper<Instance>
Link copied to clipboard
Link copied to clipboard
class LogConfig : KotlinCustomResource

Provides a Api Gateway Log Config resource. For information about Api Gateway Log Config and how to use it, see What is Log Config.

Link copied to clipboard
data class LogConfigArgs(val logType: Output<String>? = null, val slsLogStore: Output<String>? = null, val slsProject: Output<String>? = null) : ConvertibleToJava<LogConfigArgs>

Provides a Api Gateway Log Config resource. For information about Api Gateway Log Config and how to use it, see What is Log Config.

Link copied to clipboard
Link copied to clipboard
object LogConfigMapper : ResourceMapper<LogConfig>
Link copied to clipboard
Link copied to clipboard
class Model : KotlinCustomResource

Provides a Api Gateway Model resource. For information about Api Gateway Model and how to use it, see What is Model.

Link copied to clipboard
data class ModelArgs(val description: Output<String>? = null, val groupId: Output<String>? = null, val modelName: Output<String>? = null, val schema: Output<String>? = null) : ConvertibleToJava<ModelArgs>

Provides a Api Gateway Model resource. For information about Api Gateway Model and how to use it, see What is Model.

Link copied to clipboard

Builder for ModelArgs.

Link copied to clipboard
object ModelMapper : ResourceMapper<Model>
Link copied to clipboard

Builder for Model.

Link copied to clipboard
class Plugin : KotlinCustomResource

Provides a Api Gateway Plugin resource. For information about Api Gateway Plugin and how to use it, see What is Plugin.

Link copied to clipboard
data class PluginArgs(val description: Output<String>? = null, val pluginData: Output<String>? = null, val pluginName: Output<String>? = null, val pluginType: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<PluginArgs>

Provides a Api Gateway Plugin resource. For information about Api Gateway Plugin and how to use it, see What is Plugin.

Link copied to clipboard

Builder for PluginArgs.

Link copied to clipboard
class PluginAttachment : KotlinCustomResource

Basic Usage

Link copied to clipboard
data class PluginAttachmentArgs(val apiId: Output<String>? = null, val groupId: Output<String>? = null, val pluginId: Output<String>? = null, val stageName: Output<String>? = null) : ConvertibleToJava<PluginAttachmentArgs>

Basic Usage

Link copied to clipboard
object PluginAttachmentMapper : ResourceMapper<PluginAttachment>
Link copied to clipboard
object PluginMapper : ResourceMapper<Plugin>
Link copied to clipboard

Builder for Plugin.

Link copied to clipboard
class VpcAccess : KotlinCustomResource

Basic Usage

Link copied to clipboard
data class VpcAccessArgs(val instanceId: Output<String>? = null, val name: Output<String>? = null, val port: Output<Int>? = null, val vpcId: Output<String>? = null) : ConvertibleToJava<VpcAccessArgs>

Basic Usage

Link copied to clipboard
Link copied to clipboard
object VpcAccessMapper : ResourceMapper<VpcAccess>
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
fun app(name: String): App
suspend fun app(name: String, block: suspend AppResourceBuilder.() -> Unit): App
Link copied to clipboard
Link copied to clipboard
fun backend(name: String): Backend
suspend fun backend(name: String, block: suspend BackendResourceBuilder.() -> Unit): Backend
Link copied to clipboard
fun group(name: String): Group
suspend fun group(name: String, block: suspend GroupResourceBuilder.() -> Unit): Group
Link copied to clipboard
suspend fun instance(name: String, block: suspend InstanceResourceBuilder.() -> Unit): Instance
Link copied to clipboard
suspend fun logConfig(name: String, block: suspend LogConfigResourceBuilder.() -> Unit): LogConfig
Link copied to clipboard
fun model(name: String): Model
suspend fun model(name: String, block: suspend ModelResourceBuilder.() -> Unit): Model
Link copied to clipboard
fun plugin(name: String): Plugin
suspend fun plugin(name: String, block: suspend PluginResourceBuilder.() -> Unit): Plugin
Link copied to clipboard
Link copied to clipboard
suspend fun vpcAccess(name: String, block: suspend VpcAccessResourceBuilder.() -> Unit): VpcAccess