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

Package-level declarations

Types

data class ApiKeyStageKey(val restApiId: String? = null, val stageName: String? = null)

`StageKey` is a property of the AWS::ApiGateway::ApiKey resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.

DeploymentAccessLogSetting

data class DeploymentAccessLogSetting(val destinationArn: String? = null, val format: String? = null)

The `AccessLogSetting` property type specifies settings for logging access in this stage. `AccessLogSetting` is a property of the StageDescription property type.

DeploymentCanarySetting

data class DeploymentCanarySetting(val percentTraffic: Double? = null, val stageVariableOverrides: Map<String, String>? = null, val useStageCache: Boolean? = null)

The `CanarySetting` property type specifies settings for the canary deployment in this stage. `CanarySetting` is a property of the StageDescription property type.

DeploymentCanarySettings

data class DeploymentCanarySettings(val percentTraffic: Double? = null, val stageVariableOverrides: Map<String, String>? = null, val useStageCache: Boolean? = null)

The `DeploymentCanarySettings` property type specifies settings for the canary deployment.

DeploymentMethodSetting

data class DeploymentMethodSetting(val cacheDataEncrypted: Boolean? = null, val cacheTtlInSeconds: Int? = null, val cachingEnabled: Boolean? = null, val dataTraceEnabled: Boolean? = null, val httpMethod: String? = null, val loggingLevel: String? = null, val metricsEnabled: Boolean? = null, val resourcePath: String? = null, val throttlingBurstLimit: Int? = null, val throttlingRateLimit: Double? = null)

The `MethodSetting` property type configures settings for all methods in a stage. The `MethodSettings` property of the Amazon API Gateway Deployment StageDescription property type contains a list of `MethodSetting` property types.

DeploymentStageDescription

data class DeploymentStageDescription(val accessLogSetting: DeploymentAccessLogSetting? = null, val cacheClusterEnabled: Boolean? = null, val cacheClusterSize: String? = null, val cacheDataEncrypted: Boolean? = null, val cacheTtlInSeconds: Int? = null, val cachingEnabled: Boolean? = null, val canarySetting: DeploymentCanarySetting? = null, val clientCertificateId: String? = null, val dataTraceEnabled: Boolean? = null, val description: String? = null, val documentationVersion: String? = null, val loggingLevel: String? = null, val methodSettings: List<DeploymentMethodSetting>? = null, val metricsEnabled: Boolean? = null, val tags: List<DeploymentTag>? = null, val throttlingBurstLimit: Int? = null, val throttlingRateLimit: Double? = null, val tracingEnabled: Boolean? = null, val variables: Map<String, String>? = null)

`StageDescription` is a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.

DeploymentTag

data class DeploymentTag(val key: String, val value: String)

DocumentationPartLocation

data class DocumentationPartLocation(val method: String? = null, val name: String? = null, val path: String? = null, val statusCode: String? = null, val type: DocumentationPartLocationType? = null)

The `Location` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. `Location` is a property of the AWS::ApiGateway::DocumentationPart resource. For more information about each property, including constraints and valid values, see DocumentationPart in the Amazon API Gateway REST API Reference.

DomainNameEndpointConfiguration

data class DomainNameEndpointConfiguration(val ipAddressType: String? = null, val types: List<String>? = null)

The `EndpointConfiguration` property type specifies the endpoint types of an Amazon API Gateway domain name. `EndpointConfiguration` is a property of the AWS::ApiGateway::DomainName resource.

DomainNameMutualTlsAuthentication

data class DomainNameMutualTlsAuthentication(val truststoreUri: String? = null, val truststoreVersion: String? = null)

DomainNameV2EndpointConfiguration

data class DomainNameV2EndpointConfiguration(val ipAddressType: String? = null, val types: List<String>? = null)

GetAccountResult

data class GetAccountResult(val cloudWatchRoleArn: String? = null, val id: String? = null)

GetApiKeyResult

data class GetApiKeyResult(val apiKeyId: String? = null, val customerId: String? = null, val description: String? = null, val enabled: Boolean? = null, val stageKeys: List<ApiKeyStageKey>? = null, val tags: List<Tag>? = null)

GetAuthorizerResult

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

GetBasePathMappingResult

data class GetBasePathMappingResult(val restApiId: String? = null, val stage: String? = null)

GetBasePathMappingV2Result

data class GetBasePathMappingV2Result(val basePathMappingArn: String? = null, val restApiId: String? = null, val stage: String? = null)

GetClientCertificateResult

data class GetClientCertificateResult(val clientCertificateId: String? = null, val description: String? = null, val tags: List<Tag>? = null)

GetDeploymentResult

data class GetDeploymentResult(val deploymentId: String? = null, val description: String? = null)

GetDocumentationPartResult

data class GetDocumentationPartResult(val documentationPartId: String? = null, val properties: String? = null)

GetDocumentationVersionResult

data class GetDocumentationVersionResult(val description: String? = null)

GetDomainNameAccessAssociationResult

data class GetDomainNameAccessAssociationResult(val domainNameAccessAssociationArn: String? = null)

GetDomainNameResult

data class GetDomainNameResult(val certificateArn: String? = null, val distributionDomainName: String? = null, val distributionHostedZoneId: String? = null, val domainNameArn: String? = null, val endpointConfiguration: DomainNameEndpointConfiguration? = null, val mutualTlsAuthentication: DomainNameMutualTlsAuthentication? = null, val ownershipVerificationCertificateArn: String? = null, val regionalCertificateArn: String? = null, val regionalDomainName: String? = null, val regionalHostedZoneId: String? = null, val routingMode: DomainNameRoutingMode? = null, val securityPolicy: String? = null, val tags: List<Tag>? = null)

GetDomainNameV2Result

data class GetDomainNameV2Result(val certificateArn: String? = null, val domainNameArn: String? = null, val domainNameId: String? = null, val policy: Any? = null, val routingMode: DomainNameV2RoutingMode? = null, val tags: List<Tag>? = null)

GetGatewayResponseResult

data class GetGatewayResponseResult(val id: String? = null, val responseParameters: Map<String, String>? = null, val responseTemplates: Map<String, String>? = null, val statusCode: String? = null)

GetMethodResult

data class GetMethodResult(val apiKeyRequired: Boolean? = null, val authorizationScopes: List<String>? = null, val authorizationType: String? = null, val authorizerId: String? = null, val integration: MethodIntegration? = null, val methodResponses: List<MethodResponse>? = null, val operationName: String? = null, val requestModels: Map<String, String>? = null, val requestParameters: Map<String, Either<Boolean, String>>? = null, val requestValidatorId: String? = null)

GetModelResult

data class GetModelResult(val description: String? = null, val schema: Any? = null)

/* /*

GetRequestValidatorResult

data class GetRequestValidatorResult(val requestValidatorId: String? = null, val validateRequestBody: Boolean? = null, val validateRequestParameters: Boolean? = null)

GetResourceResult

data class GetResourceResult(val resourceId: String? = null)

GetRestApiResult

data class GetRestApiResult(val apiKeySourceType: String? = null, val binaryMediaTypes: List<String>? = null, val description: String? = null, val disableExecuteApiEndpoint: Boolean? = null, val endpointConfiguration: RestApiEndpointConfiguration? = null, val minimumCompressionSize: Int? = null, val name: String? = null, val policy: Any? = null, val restApiId: String? = null, val rootResourceId: String? = null, val tags: List<Tag>? = null)

GetStageResult

data class GetStageResult(val accessLogSetting: StageAccessLogSetting? = null, val cacheClusterEnabled: Boolean? = null, val cacheClusterSize: String? = null, val canarySetting: StageCanarySetting? = null, val clientCertificateId: String? = null, val deploymentId: String? = null, val description: String? = null, val documentationVersion: String? = null, val methodSettings: List<StageMethodSetting>? = null, val tags: List<Tag>? = null, val tracingEnabled: Boolean? = null, val variables: Map<String, String>? = null)

GetUsagePlanKeyResult

data class GetUsagePlanKeyResult(val id: String? = null)

GetUsagePlanResult

data class GetUsagePlanResult(val apiStages: List<UsagePlanApiStage>? = null, val description: String? = null, val id: String? = null, val quota: UsagePlanQuotaSettings? = null, val tags: List<Tag>? = null, val throttle: UsagePlanThrottleSettings? = null, val usagePlanName: String? = null)

GetVpcLinkResult

data class GetVpcLinkResult(val description: String? = null, val name: String? = null, val tags: List<Tag>? = null, val vpcLinkId: String? = null)

MethodIntegration

data class MethodIntegration(val cacheKeyParameters: List<String>? = null, val cacheNamespace: String? = null, val connectionId: String? = null, val connectionType: MethodIntegrationConnectionType? = null, val contentHandling: MethodIntegrationContentHandling? = null, val credentials: String? = null, val integrationHttpMethod: String? = null, val integrationResponses: List<MethodIntegrationResponse>? = null, val passthroughBehavior: MethodIntegrationPassthroughBehavior? = null, val requestParameters: Map<String, String>? = null, val requestTemplates: Map<String, String>? = null, val timeoutInMillis: Int? = null, val type: MethodIntegrationType, val uri: String? = null)

`Integration` is a property of the AWS::ApiGateway::Method resource that specifies information about the target backend that a method calls.

MethodIntegrationResponse

data class MethodIntegrationResponse(val contentHandling: MethodIntegrationResponseContentHandling? = null, val responseParameters: Map<String, String>? = null, val responseTemplates: Map<String, String>? = null, val selectionPattern: String? = null, val statusCode: String)

`IntegrationResponse` is a property of the Amazon API Gateway Method Integration property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.

MethodResponse

data class MethodResponse(val responseModels: Map<String, String>? = null, val responseParameters: Map<String, Either<Boolean, String>>? = null, val statusCode: String)

RestApiEndpointConfiguration

data class RestApiEndpointConfiguration(val ipAddressType: String? = null, val types: List<String>? = null, val vpcEndpointIds: List<String>? = null)

The `EndpointConfiguration` property type specifies the endpoint types of a REST API. `EndpointConfiguration` is a property of the AWS::ApiGateway::RestApi resource.

RestApiS3Location

data class RestApiS3Location(val bucket: String? = null, val eTag: String? = null, val key: String? = null, val version: String? = null)

`S3Location` is a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.

StageAccessLogSetting

data class StageAccessLogSetting(val destinationArn: String? = null, val format: String? = null)

The `AccessLogSetting` property type specifies settings for logging access in this stage. `AccessLogSetting` is a property of the AWS::ApiGateway::Stage resource.

StageCanarySetting

data class StageCanarySetting(val deploymentId: String? = null, val percentTraffic: Double? = null, val stageVariableOverrides: Map<String, String>? = null, val useStageCache: Boolean? = null)

StageMethodSetting

data class StageMethodSetting(val cacheDataEncrypted: Boolean? = null, val cacheTtlInSeconds: Int? = null, val cachingEnabled: Boolean? = null, val dataTraceEnabled: Boolean? = null, val httpMethod: String? = null, val loggingLevel: String? = null, val metricsEnabled: Boolean? = null, val resourcePath: String? = null, val throttlingBurstLimit: Int? = null, val throttlingRateLimit: Double? = null)

The `MethodSetting` property type configures settings for all methods in a stage. The `MethodSettings` property of the `AWS::ApiGateway::Stage` resource contains a list of `MethodSetting` property types.

UsagePlanApiStage

data class UsagePlanApiStage(val apiId: String? = null, val stage: String? = null, val throttle: Map<String, UsagePlanThrottleSettings>? = null)

UsagePlanQuotaSettings

data class UsagePlanQuotaSettings(val limit: Int? = null, val offset: Int? = null, val period: String? = null)

`QuotaSettings` is a property of the AWS::ApiGateway::UsagePlan resource that specifies a target for the maximum number of requests users can make to your REST APIs. 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.

UsagePlanThrottleSettings

data class UsagePlanThrottleSettings(val burstLimit: Int? = null, val rateLimit: Double? = null)

`ThrottleSettings` is a property of the AWS::ApiGateway::UsagePlan resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.