pulumi-aws-native-kotlin/com.pulumi.awsnative.apigateway.kotlin

Package-level declarations

Types

class Account : KotlinCustomResource

The `AWS::ApiGateway::Account` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one `AWS::ApiGateway::Account` resource per region per account.

AccountArgs

data class AccountArgs(val cloudWatchRoleArn: Output<String>? = null) : ConvertibleToJava<AccountArgs>

AccountArgsBuilder

class AccountArgsBuilder

Builder for AccountArgs.

AccountMapper

object AccountMapper : ResourceMapper<Account>

AccountResourceBuilder

class AccountResourceBuilder

Builder for Account.

ApigatewayFunctions

object ApigatewayFunctions

ApiKey

class ApiKey : KotlinCustomResource

The `AWS::ApiGateway::ApiKey` resource creates a unique key that you can distribute to clients who are executing API Gateway `Method` resources that require an API key. To specify which API key clients must use, map the API key with the `RestApi` and `Stage` resources that include the methods that require a key.

ApiKeyArgs

data class ApiKeyArgs(val customerId: Output<String>? = null, val description: Output<String>? = null, val enabled: Output<Boolean>? = null, val generateDistinctId: Output<Boolean>? = null, val name: Output<String>? = null, val stageKeys: Output<List<ApiKeyStageKeyArgs>>? = null, val tags: Output<List<TagArgs>>? = null, val value: Output<String>? = null) : ConvertibleToJava<ApiKeyArgs>

ApiKeyArgsBuilder

class ApiKeyArgsBuilder

Builder for ApiKeyArgs.

ApiKeyMapper

object ApiKeyMapper : ResourceMapper<ApiKey>

ApiKeyResourceBuilder

class ApiKeyResourceBuilder

Builder for ApiKey.

Authorizer

class Authorizer : KotlinCustomResource

The `AWS::ApiGateway::Authorizer` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.

AuthorizerArgs

data class AuthorizerArgs(val authType: Output<String>? = null, val authorizerCredentials: Output<String>? = null, val authorizerResultTtlInSeconds: Output<Int>? = null, val authorizerUri: Output<String>? = null, val identitySource: Output<String>? = null, val identityValidationExpression: Output<String>? = null, val name: Output<String>? = null, val providerArns: Output<List<String>>? = null, val restApiId: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<AuthorizerArgs>

AuthorizerArgsBuilder

class AuthorizerArgsBuilder

Builder for AuthorizerArgs.

AuthorizerMapper

object AuthorizerMapper : ResourceMapper<Authorizer>

AuthorizerResourceBuilder

class AuthorizerResourceBuilder

Builder for Authorizer.

BasePathMapping

class BasePathMapping : KotlinCustomResource

The `AWS::ApiGateway::BasePathMapping` resource creates a base path that clients who call your API must use in the invocation URL.

BasePathMappingArgs

data class BasePathMappingArgs(val basePath: Output<String>? = null, val domainName: Output<String>? = null, val restApiId: Output<String>? = null, val stage: Output<String>? = null) : ConvertibleToJava<BasePathMappingArgs>

The `AWS::ApiGateway::BasePathMapping` resource creates a base path that clients who call your API must use in the invocation URL.

BasePathMappingArgsBuilder

class BasePathMappingArgsBuilder

Builder for BasePathMappingArgs.

BasePathMappingMapper

object BasePathMappingMapper : ResourceMapper<BasePathMapping>

BasePathMappingResourceBuilder

class BasePathMappingResourceBuilder

Builder for BasePathMapping.

ClientCertificate

class ClientCertificate : KotlinCustomResource

The `AWS::ApiGateway::ClientCertificate` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.

ClientCertificateArgs

data class ClientCertificateArgs(val description: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<ClientCertificateArgs>

The `AWS::ApiGateway::ClientCertificate` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.

ClientCertificateArgsBuilder

class ClientCertificateArgsBuilder

Builder for ClientCertificateArgs.

ClientCertificateMapper

object ClientCertificateMapper : ResourceMapper<ClientCertificate>

ClientCertificateResourceBuilder

class ClientCertificateResourceBuilder

Builder for ClientCertificate.

Deployment

class Deployment : KotlinCustomResource

The `AWS::ApiGateway::Deployment` resource deploys an API Gateway `RestApi` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

DeploymentArgs

data class DeploymentArgs(val deploymentCanarySettings: Output<DeploymentCanarySettingsArgs>? = null, val description: Output<String>? = null, val restApiId: Output<String>? = null, val stageDescription: Output<DeploymentStageDescriptionArgs>? = null, val stageName: Output<String>? = null) : ConvertibleToJava<DeploymentArgs>

The `AWS::ApiGateway::Deployment` resource deploys an API Gateway `RestApi` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

DeploymentArgsBuilder

class DeploymentArgsBuilder

Builder for DeploymentArgs.

DeploymentMapper

object DeploymentMapper : ResourceMapper<Deployment>

DeploymentResourceBuilder

class DeploymentResourceBuilder

Builder for Deployment.

DocumentationPart

class DocumentationPart : KotlinCustomResource

The `AWS::ApiGateway::DocumentationPart` resource creates a documentation part for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide.

DocumentationPartArgs

data class DocumentationPartArgs(val location: Output<DocumentationPartLocationArgs>? = null, val properties: Output<String>? = null, val restApiId: Output<String>? = null) : ConvertibleToJava<DocumentationPartArgs>

DocumentationPartArgsBuilder

class DocumentationPartArgsBuilder

Builder for DocumentationPartArgs.

DocumentationPartMapper

object DocumentationPartMapper : ResourceMapper<DocumentationPart>

DocumentationPartResourceBuilder

class DocumentationPartResourceBuilder

Builder for DocumentationPart.

DocumentationVersion

class DocumentationVersion : KotlinCustomResource

The `AWS::ApiGateway::DocumentationVersion` resource creates a snapshot of the documentation for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide.

DocumentationVersionArgs

data class DocumentationVersionArgs(val description: Output<String>? = null, val documentationVersion: Output<String>? = null, val restApiId: Output<String>? = null) : ConvertibleToJava<DocumentationVersionArgs>

DocumentationVersionArgsBuilder

class DocumentationVersionArgsBuilder

Builder for DocumentationVersionArgs.

DocumentationVersionMapper

object DocumentationVersionMapper : ResourceMapper<DocumentationVersion>

DocumentationVersionResourceBuilder

class DocumentationVersionResourceBuilder

Builder for DocumentationVersion.

DomainName

class DomainName : KotlinCustomResource

Resource Type definition for AWS::ApiGateway::DomainName.

DomainNameArgs

data class DomainNameArgs(val certificateArn: Output<String>? = null, val domainName: Output<String>? = null, val endpointConfiguration: Output<DomainNameEndpointConfigurationArgs>? = null, val mutualTlsAuthentication: Output<DomainNameMutualTlsAuthenticationArgs>? = null, val ownershipVerificationCertificateArn: Output<String>? = null, val regionalCertificateArn: Output<String>? = null, val securityPolicy: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DomainNameArgs>

Resource Type definition for AWS::ApiGateway::DomainName.

DomainNameArgsBuilder

class DomainNameArgsBuilder

Builder for DomainNameArgs.

DomainNameMapper

object DomainNameMapper : ResourceMapper<DomainName>

DomainNameResourceBuilder

class DomainNameResourceBuilder

Builder for DomainName.

GatewayResponse

class GatewayResponse : KotlinCustomResource

The `AWS::ApiGateway::GatewayResponse` resource creates a gateway response for your API. For more information, see API Gateway Responses in the API Gateway Developer Guide.

GatewayResponseArgs

data class GatewayResponseArgs(val responseParameters: Output<Map<String, String>>? = null, val responseTemplates: Output<Map<String, String>>? = null, val responseType: Output<String>? = null, val restApiId: Output<String>? = null, val statusCode: Output<String>? = null) : ConvertibleToJava<GatewayResponseArgs>

The `AWS::ApiGateway::GatewayResponse` resource creates a gateway response for your API. For more information, see API Gateway Responses in the API Gateway Developer Guide.

GatewayResponseArgsBuilder

class GatewayResponseArgsBuilder

Builder for GatewayResponseArgs.

GatewayResponseMapper

object GatewayResponseMapper : ResourceMapper<GatewayResponse>

GatewayResponseResourceBuilder

class GatewayResponseResourceBuilder

Builder for GatewayResponse.

Method

class Method : KotlinCustomResource

The `AWS::ApiGateway::Method` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

MethodArgs

data class MethodArgs(val apiKeyRequired: Output<Boolean>? = null, val authorizationScopes: Output<List<String>>? = null, val authorizationType: Output<String>? = null, val authorizerId: Output<String>? = null, val httpMethod: Output<String>? = null, val integration: Output<MethodIntegrationArgs>? = null, val methodResponses: Output<List<MethodResponseArgs>>? = null, val operationName: Output<String>? = null, val requestModels: Output<Map<String, String>>? = null, val requestParameters: Output<Map<String, Either<Boolean, String>>>? = null, val requestValidatorId: Output<String>? = null, val resourceId: Output<String>? = null, val restApiId: Output<String>? = null) : ConvertibleToJava<MethodArgs>

The `AWS::ApiGateway::Method` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

MethodArgsBuilder

class MethodArgsBuilder

Builder for MethodArgs.

MethodMapper

object MethodMapper : ResourceMapper<Method>

MethodResourceBuilder

class MethodResourceBuilder

Builder for Method.

Model

class Model : KotlinCustomResource

The `AWS::ApiGateway::Model` resource defines the structure of a request or response payload for an API method.

ModelArgs

data class ModelArgs(val contentType: Output<String>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val restApiId: Output<String>? = null, val schema: Output<Any>? = null) : ConvertibleToJava<ModelArgs>

/* /* The `AWS::ApiGateway::Model` resource defines the structure of a request or response payload for an API method.

ModelArgsBuilder

class ModelArgsBuilder

Builder for ModelArgs.

ModelMapper

object ModelMapper : ResourceMapper<Model>

ModelResourceBuilder

class ModelResourceBuilder

Builder for Model.

RequestValidator

class RequestValidator : KotlinCustomResource

The `AWS::ApiGateway::RequestValidator` resource sets up basic validation rules for incoming requests to your API. For more information, see Enable Basic Request Validation for an API in API Gateway in the API Gateway Developer Guide.

RequestValidatorArgs

data class RequestValidatorArgs(val name: Output<String>? = null, val restApiId: Output<String>? = null, val validateRequestBody: Output<Boolean>? = null, val validateRequestParameters: Output<Boolean>? = null) : ConvertibleToJava<RequestValidatorArgs>

RequestValidatorArgsBuilder

class RequestValidatorArgsBuilder

Builder for RequestValidatorArgs.

RequestValidatorMapper

object RequestValidatorMapper : ResourceMapper<RequestValidator>

RequestValidatorResourceBuilder

class RequestValidatorResourceBuilder

Builder for RequestValidator.

Resource

class Resource : KotlinCustomResource

The `AWS::ApiGateway::Resource` resource creates a resource in an API.

ResourceArgs

data class ResourceArgs(val parentId: Output<String>? = null, val pathPart: Output<String>? = null, val restApiId: Output<String>? = null) : ConvertibleToJava<ResourceArgs>

The `AWS::ApiGateway::Resource` resource creates a resource in an API.

ResourceArgsBuilder

class ResourceArgsBuilder

Builder for ResourceArgs.

ResourceMapper

object ResourceMapper : ResourceMapper<Resource>

ResourceResourceBuilder

class ResourceResourceBuilder

Builder for Resource.

RestApi

class RestApi : KotlinCustomResource

The `AWS::ApiGateway::RestApi` resource creates a REST API. For more information, see restapi:create in the Amazon API Gateway REST API Reference. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.

RestApiArgs

data class RestApiArgs(val apiKeySourceType: Output<String>? = null, val binaryMediaTypes: Output<List<String>>? = null, val body: Output<Any>? = null, val bodyS3Location: Output<RestApiS3LocationArgs>? = null, val cloneFrom: Output<String>? = null, val description: Output<String>? = null, val disableExecuteApiEndpoint: Output<Boolean>? = null, val endpointConfiguration: Output<RestApiEndpointConfigurationArgs>? = null, val failOnWarnings: Output<Boolean>? = null, val minimumCompressionSize: Output<Int>? = null, val mode: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val policy: Output<Any>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<RestApiArgs>

RestApiArgsBuilder

class RestApiArgsBuilder

Builder for RestApiArgs.

RestApiMapper

object RestApiMapper : ResourceMapper<RestApi>

RestApiResourceBuilder

class RestApiResourceBuilder

Builder for RestApi.

Stage

class Stage : KotlinCustomResource

The `AWS::ApiGateway::Stage` resource creates a stage for a deployment.

StageArgs

data class StageArgs(val accessLogSetting: Output<StageAccessLogSettingArgs>? = null, val cacheClusterEnabled: Output<Boolean>? = null, val cacheClusterSize: Output<String>? = null, val canarySetting: Output<StageCanarySettingArgs>? = null, val clientCertificateId: Output<String>? = null, val deploymentId: Output<String>? = null, val description: Output<String>? = null, val documentationVersion: Output<String>? = null, val methodSettings: Output<List<StageMethodSettingArgs>>? = null, val restApiId: Output<String>? = null, val stageName: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val tracingEnabled: Output<Boolean>? = null, val variables: Output<Map<String, String>>? = null) : ConvertibleToJava<StageArgs>

/* The `AWS::ApiGateway::Stage` resource creates a stage for a deployment.

StageArgsBuilder

class StageArgsBuilder

Builder for StageArgs.

StageMapper

object StageMapper : ResourceMapper<Stage>

StageResourceBuilder

class StageResourceBuilder

Builder for Stage.

UsagePlan

class UsagePlan : KotlinCustomResource

The `AWS::ApiGateway::UsagePlan` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see Creating and Using API Usage Plans in Amazon API Gateway in the API Gateway Developer Guide. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using to monitor costs and to manage API requests.

UsagePlanArgs

data class UsagePlanArgs(val apiStages: Output<List<UsagePlanApiStageArgs>>? = null, val description: Output<String>? = null, val quota: Output<UsagePlanQuotaSettingsArgs>? = null, val tags: Output<List<TagArgs>>? = null, val throttle: Output<UsagePlanThrottleSettingsArgs>? = null, val usagePlanName: Output<String>? = null) : ConvertibleToJava<UsagePlanArgs>

UsagePlanArgsBuilder

class UsagePlanArgsBuilder

Builder for UsagePlanArgs.

UsagePlanKey

class UsagePlanKey : KotlinCustomResource

The `AWS::ApiGateway::UsagePlanKey` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.

UsagePlanKeyArgs

data class UsagePlanKeyArgs(val keyId: Output<String>? = null, val keyType: Output<UsagePlanKeyKeyType>? = null, val usagePlanId: Output<String>? = null) : ConvertibleToJava<UsagePlanKeyArgs>

The `AWS::ApiGateway::UsagePlanKey` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.

UsagePlanKeyArgsBuilder

class UsagePlanKeyArgsBuilder

Builder for UsagePlanKeyArgs.

UsagePlanKeyMapper

object UsagePlanKeyMapper : ResourceMapper<UsagePlanKey>

UsagePlanKeyResourceBuilder

class UsagePlanKeyResourceBuilder

Builder for UsagePlanKey.

UsagePlanMapper

object UsagePlanMapper : ResourceMapper<UsagePlan>

UsagePlanResourceBuilder

class UsagePlanResourceBuilder

Builder for UsagePlan.

VpcLink

class VpcLink : KotlinCustomResource

The `AWS::ApiGateway::VpcLink` resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see vpclink:create in the `Amazon API Gateway REST API Reference`.

VpcLinkArgs

data class VpcLinkArgs(val description: Output<String>? = null, val name: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val targetArns: Output<List<String>>? = null) : ConvertibleToJava<VpcLinkArgs>

VpcLinkArgsBuilder

class VpcLinkArgsBuilder

Builder for VpcLinkArgs.

VpcLinkMapper

object VpcLinkMapper : ResourceMapper<VpcLink>

VpcLinkResourceBuilder

class VpcLinkResourceBuilder

Builder for VpcLink.

Functions

account

fun account(name: String): Account

suspend fun account(name: String, block: suspend AccountResourceBuilder.() -> Unit): Account

apiKey

fun apiKey(name: String): ApiKey

suspend fun apiKey(name: String, block: suspend ApiKeyResourceBuilder.() -> Unit): ApiKey

authorizer

fun authorizer(name: String): Authorizer

suspend fun authorizer(name: String, block: suspend AuthorizerResourceBuilder.() -> Unit): Authorizer

basePathMapping

fun basePathMapping(name: String): BasePathMapping

suspend fun basePathMapping(name: String, block: suspend BasePathMappingResourceBuilder.() -> Unit): BasePathMapping

clientCertificate

fun clientCertificate(name: String): ClientCertificate

suspend fun clientCertificate(name: String, block: suspend ClientCertificateResourceBuilder.() -> Unit): ClientCertificate

deployment

fun deployment(name: String): Deployment

suspend fun deployment(name: String, block: suspend DeploymentResourceBuilder.() -> Unit): Deployment

documentationPart

fun documentationPart(name: String): DocumentationPart

suspend fun documentationPart(name: String, block: suspend DocumentationPartResourceBuilder.() -> Unit): DocumentationPart

documentationVersion

fun documentationVersion(name: String): DocumentationVersion

suspend fun documentationVersion(name: String, block: suspend DocumentationVersionResourceBuilder.() -> Unit): DocumentationVersion

domainName

fun domainName(name: String): DomainName

suspend fun domainName(name: String, block: suspend DomainNameResourceBuilder.() -> Unit): DomainName

gatewayResponse

fun gatewayResponse(name: String): GatewayResponse

suspend fun gatewayResponse(name: String, block: suspend GatewayResponseResourceBuilder.() -> Unit): GatewayResponse

method

fun method(name: String): Method

suspend fun method(name: String, block: suspend MethodResourceBuilder.() -> Unit): Method

model

fun model(name: String): Model

suspend fun model(name: String, block: suspend ModelResourceBuilder.() -> Unit): Model

requestValidator

fun requestValidator(name: String): RequestValidator

suspend fun requestValidator(name: String, block: suspend RequestValidatorResourceBuilder.() -> Unit): RequestValidator

resource

fun resource(name: String): Resource

suspend fun resource(name: String, block: suspend ResourceResourceBuilder.() -> Unit): Resource

restApi

fun restApi(name: String): RestApi

suspend fun restApi(name: String, block: suspend RestApiResourceBuilder.() -> Unit): RestApi

stage

fun stage(name: String): Stage

suspend fun stage(name: String, block: suspend StageResourceBuilder.() -> Unit): Stage

usagePlan

fun usagePlan(name: String): UsagePlan

suspend fun usagePlan(name: String, block: suspend UsagePlanResourceBuilder.() -> Unit): UsagePlan

usagePlanKey

fun usagePlanKey(name: String): UsagePlanKey

suspend fun usagePlanKey(name: String, block: suspend UsagePlanKeyResourceBuilder.() -> Unit): UsagePlanKey

vpcLink

fun vpcLink(name: String): VpcLink

suspend fun vpcLink(name: String, block: suspend VpcLinkResourceBuilder.() -> Unit): VpcLink