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

Package-level declarations

Types

data class ApiKeyStageKeyArgs(val restApiId: Output<String>? = null, val stageName: Output<String>? = null) : ConvertibleToJava<ApiKeyStageKeyArgs>

`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.

ApiKeyStageKeyArgsBuilder

class ApiKeyStageKeyArgsBuilder

Builder for ApiKeyStageKeyArgs.

DeploymentAccessLogSettingArgs

data class DeploymentAccessLogSettingArgs(val destinationArn: Output<String>? = null, val format: Output<String>? = null) : ConvertibleToJava<DeploymentAccessLogSettingArgs>

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

DeploymentAccessLogSettingArgsBuilder

class DeploymentAccessLogSettingArgsBuilder

Builder for DeploymentAccessLogSettingArgs.

DeploymentCanarySettingArgs

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

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

DeploymentCanarySettingArgsBuilder

class DeploymentCanarySettingArgsBuilder

Builder for DeploymentCanarySettingArgs.

DeploymentCanarySettingsArgs

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

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

DeploymentCanarySettingsArgsBuilder

class DeploymentCanarySettingsArgsBuilder

Builder for DeploymentCanarySettingsArgs.

DeploymentMethodSettingArgs

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

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.

DeploymentMethodSettingArgsBuilder

class DeploymentMethodSettingArgsBuilder

Builder for DeploymentMethodSettingArgs.

DeploymentStageDescriptionArgs

data class DeploymentStageDescriptionArgs(val accessLogSetting: Output<DeploymentAccessLogSettingArgs>? = null, val cacheClusterEnabled: Output<Boolean>? = null, val cacheClusterSize: Output<String>? = null, val cacheDataEncrypted: Output<Boolean>? = null, val cacheTtlInSeconds: Output<Int>? = null, val cachingEnabled: Output<Boolean>? = null, val canarySetting: Output<DeploymentCanarySettingArgs>? = null, val clientCertificateId: Output<String>? = null, val dataTraceEnabled: Output<Boolean>? = null, val description: Output<String>? = null, val documentationVersion: Output<String>? = null, val loggingLevel: Output<String>? = null, val methodSettings: Output<List<DeploymentMethodSettingArgs>>? = null, val metricsEnabled: Output<Boolean>? = null, val tags: Output<List<DeploymentTagArgs>>? = null, val throttlingBurstLimit: Output<Int>? = null, val throttlingRateLimit: Output<Double>? = null, val tracingEnabled: Output<Boolean>? = null, val variables: Output<Map<String, String>>? = null) : ConvertibleToJava<DeploymentStageDescriptionArgs>

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

DeploymentStageDescriptionArgsBuilder

class DeploymentStageDescriptionArgsBuilder

Builder for DeploymentStageDescriptionArgs.

DeploymentTagArgs

data class DeploymentTagArgs(val key: Output<String>, val value: Output<String>) : ConvertibleToJava<DeploymentTagArgs>

DeploymentTagArgsBuilder

class DeploymentTagArgsBuilder

Builder for DeploymentTagArgs.

DocumentationPartLocationArgs

data class DocumentationPartLocationArgs(val method: Output<String>? = null, val name: Output<String>? = null, val path: Output<String>? = null, val statusCode: Output<String>? = null, val type: Output<DocumentationPartLocationType>? = null) : ConvertibleToJava<DocumentationPartLocationArgs>

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.

DocumentationPartLocationArgsBuilder

class DocumentationPartLocationArgsBuilder

Builder for DocumentationPartLocationArgs.

DomainNameEndpointConfigurationArgs

data class DomainNameEndpointConfigurationArgs(val types: Output<List<String>>? = null) : ConvertibleToJava<DomainNameEndpointConfigurationArgs>

DomainNameEndpointConfigurationArgsBuilder

class DomainNameEndpointConfigurationArgsBuilder

Builder for DomainNameEndpointConfigurationArgs.

DomainNameMutualTlsAuthenticationArgs

data class DomainNameMutualTlsAuthenticationArgs(val truststoreUri: Output<String>? = null, val truststoreVersion: Output<String>? = null) : ConvertibleToJava<DomainNameMutualTlsAuthenticationArgs>

DomainNameMutualTlsAuthenticationArgsBuilder

class DomainNameMutualTlsAuthenticationArgsBuilder

Builder for DomainNameMutualTlsAuthenticationArgs.

GetAccountPlainArgs

data class GetAccountPlainArgs(val id: String) : ConvertibleToJava<GetAccountPlainArgs>

GetAccountPlainArgsBuilder

class GetAccountPlainArgsBuilder

Builder for GetAccountPlainArgs.

GetApiKeyPlainArgs

data class GetApiKeyPlainArgs(val apiKeyId: String) : ConvertibleToJava<GetApiKeyPlainArgs>

GetApiKeyPlainArgsBuilder

class GetApiKeyPlainArgsBuilder

Builder for GetApiKeyPlainArgs.

GetAuthorizerPlainArgs

data class GetAuthorizerPlainArgs(val authorizerId: String, val restApiId: String) : ConvertibleToJava<GetAuthorizerPlainArgs>

GetAuthorizerPlainArgsBuilder

class GetAuthorizerPlainArgsBuilder

Builder for GetAuthorizerPlainArgs.

GetBasePathMappingPlainArgs

data class GetBasePathMappingPlainArgs(val basePath: String, val domainName: String) : ConvertibleToJava<GetBasePathMappingPlainArgs>

GetBasePathMappingPlainArgsBuilder

class GetBasePathMappingPlainArgsBuilder

Builder for GetBasePathMappingPlainArgs.

GetClientCertificatePlainArgs

data class GetClientCertificatePlainArgs(val clientCertificateId: String) : ConvertibleToJava<GetClientCertificatePlainArgs>

GetClientCertificatePlainArgsBuilder

class GetClientCertificatePlainArgsBuilder

Builder for GetClientCertificatePlainArgs.

GetDeploymentPlainArgs

data class GetDeploymentPlainArgs(val deploymentId: String, val restApiId: String) : ConvertibleToJava<GetDeploymentPlainArgs>

GetDeploymentPlainArgsBuilder

class GetDeploymentPlainArgsBuilder

Builder for GetDeploymentPlainArgs.

GetDocumentationPartPlainArgs

data class GetDocumentationPartPlainArgs(val documentationPartId: String, val restApiId: String) : ConvertibleToJava<GetDocumentationPartPlainArgs>

GetDocumentationPartPlainArgsBuilder

class GetDocumentationPartPlainArgsBuilder

Builder for GetDocumentationPartPlainArgs.

GetDocumentationVersionPlainArgs

data class GetDocumentationVersionPlainArgs(val documentationVersion: String, val restApiId: String) : ConvertibleToJava<GetDocumentationVersionPlainArgs>

GetDocumentationVersionPlainArgsBuilder

class GetDocumentationVersionPlainArgsBuilder

Builder for GetDocumentationVersionPlainArgs.

GetDomainNamePlainArgs

data class GetDomainNamePlainArgs(val domainName: String) : ConvertibleToJava<GetDomainNamePlainArgs>

GetDomainNamePlainArgsBuilder

class GetDomainNamePlainArgsBuilder

Builder for GetDomainNamePlainArgs.

GetGatewayResponsePlainArgs

data class GetGatewayResponsePlainArgs(val id: String) : ConvertibleToJava<GetGatewayResponsePlainArgs>

GetGatewayResponsePlainArgsBuilder

class GetGatewayResponsePlainArgsBuilder

Builder for GetGatewayResponsePlainArgs.

GetMethodPlainArgs

data class GetMethodPlainArgs(val httpMethod: String, val resourceId: String, val restApiId: String) : ConvertibleToJava<GetMethodPlainArgs>

GetMethodPlainArgsBuilder

class GetMethodPlainArgsBuilder

Builder for GetMethodPlainArgs.

GetModelPlainArgs

data class GetModelPlainArgs(val name: String, val restApiId: String) : ConvertibleToJava<GetModelPlainArgs>

GetModelPlainArgsBuilder

class GetModelPlainArgsBuilder

Builder for GetModelPlainArgs.

GetRequestValidatorPlainArgs

data class GetRequestValidatorPlainArgs(val requestValidatorId: String, val restApiId: String) : ConvertibleToJava<GetRequestValidatorPlainArgs>

GetRequestValidatorPlainArgsBuilder

class GetRequestValidatorPlainArgsBuilder

Builder for GetRequestValidatorPlainArgs.

GetResourcePlainArgs

data class GetResourcePlainArgs(val resourceId: String, val restApiId: String) : ConvertibleToJava<GetResourcePlainArgs>

GetResourcePlainArgsBuilder

class GetResourcePlainArgsBuilder

Builder for GetResourcePlainArgs.

GetRestApiPlainArgs

data class GetRestApiPlainArgs(val restApiId: String) : ConvertibleToJava<GetRestApiPlainArgs>

GetRestApiPlainArgsBuilder

class GetRestApiPlainArgsBuilder

Builder for GetRestApiPlainArgs.

GetStagePlainArgs

data class GetStagePlainArgs(val restApiId: String, val stageName: String) : ConvertibleToJava<GetStagePlainArgs>

GetStagePlainArgsBuilder

class GetStagePlainArgsBuilder

Builder for GetStagePlainArgs.

GetUsagePlanKeyPlainArgs

data class GetUsagePlanKeyPlainArgs(val id: String) : ConvertibleToJava<GetUsagePlanKeyPlainArgs>

GetUsagePlanKeyPlainArgsBuilder

class GetUsagePlanKeyPlainArgsBuilder

Builder for GetUsagePlanKeyPlainArgs.

GetUsagePlanPlainArgs

data class GetUsagePlanPlainArgs(val id: String) : ConvertibleToJava<GetUsagePlanPlainArgs>

GetUsagePlanPlainArgsBuilder

class GetUsagePlanPlainArgsBuilder

Builder for GetUsagePlanPlainArgs.

GetVpcLinkPlainArgs

data class GetVpcLinkPlainArgs(val vpcLinkId: String) : ConvertibleToJava<GetVpcLinkPlainArgs>

GetVpcLinkPlainArgsBuilder

class GetVpcLinkPlainArgsBuilder

Builder for GetVpcLinkPlainArgs.

MethodIntegrationArgs

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

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

MethodIntegrationArgsBuilder

class MethodIntegrationArgsBuilder

Builder for MethodIntegrationArgs.

MethodIntegrationResponseArgs

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

`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.

MethodIntegrationResponseArgsBuilder

class MethodIntegrationResponseArgsBuilder

Builder for MethodIntegrationResponseArgs.

MethodResponseArgs

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

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

MethodResponseArgsBuilder

class MethodResponseArgsBuilder

Builder for MethodResponseArgs.

RestApiEndpointConfigurationArgs

data class RestApiEndpointConfigurationArgs(val types: Output<List<String>>? = null, val vpcEndpointIds: Output<List<String>>? = null) : ConvertibleToJava<RestApiEndpointConfigurationArgs>

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

RestApiEndpointConfigurationArgsBuilder

class RestApiEndpointConfigurationArgsBuilder

Builder for RestApiEndpointConfigurationArgs.

RestApiS3LocationArgs

data class RestApiS3LocationArgs(val bucket: Output<String>? = null, val eTag: Output<String>? = null, val key: Output<String>? = null, val version: Output<String>? = null) : ConvertibleToJava<RestApiS3LocationArgs>

`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.

RestApiS3LocationArgsBuilder

class RestApiS3LocationArgsBuilder

Builder for RestApiS3LocationArgs.

StageAccessLogSettingArgs

data class StageAccessLogSettingArgs(val destinationArn: Output<String>? = null, val format: Output<String>? = null) : ConvertibleToJava<StageAccessLogSettingArgs>

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

StageAccessLogSettingArgsBuilder

class StageAccessLogSettingArgsBuilder

Builder for StageAccessLogSettingArgs.

StageCanarySettingArgs

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

Configuration settings of a canary deployment.

StageCanarySettingArgsBuilder

class StageCanarySettingArgsBuilder

Builder for StageCanarySettingArgs.

StageMethodSettingArgs

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

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.

StageMethodSettingArgsBuilder

class StageMethodSettingArgsBuilder

Builder for StageMethodSettingArgs.

UsagePlanApiStageArgs

data class UsagePlanApiStageArgs(val apiId: Output<String>? = null, val stage: Output<String>? = null, val throttle: Output<Map<String, UsagePlanThrottleSettingsArgs>>? = null) : ConvertibleToJava<UsagePlanApiStageArgs>

API stage name of the associated API stage in a usage plan.

UsagePlanApiStageArgsBuilder

class UsagePlanApiStageArgsBuilder

Builder for UsagePlanApiStageArgs.

UsagePlanQuotaSettingsArgs

data class UsagePlanQuotaSettingsArgs(val limit: Output<Int>? = null, val offset: Output<Int>? = null, val period: Output<String>? = null) : ConvertibleToJava<UsagePlanQuotaSettingsArgs>

`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.

UsagePlanQuotaSettingsArgsBuilder

class UsagePlanQuotaSettingsArgsBuilder

Builder for UsagePlanQuotaSettingsArgs.

UsagePlanThrottleSettingsArgs

data class UsagePlanThrottleSettingsArgs(val burstLimit: Output<Int>? = null, val rateLimit: Output<Double>? = null) : ConvertibleToJava<UsagePlanThrottleSettingsArgs>

`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.

UsagePlanThrottleSettingsArgsBuilder

class UsagePlanThrottleSettingsArgsBuilder

Builder for UsagePlanThrottleSettingsArgs.