Package software.amazon.awscdk.cfnpropertymixins.services.apigateway
package software.amazon.awscdk.cfnpropertymixins.services.apigateway
-
ClassDescriptionProperties for CfnAccountPropsMixin.A builder for
CfnAccountMixinPropsAn implementation forCfnAccountMixinPropsTheAWS::ApiGateway::Accountresource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs.A fluent builder forCfnAccountPropsMixin.Properties for CfnApiKeyPropsMixin.A builder forCfnApiKeyMixinPropsAn implementation forCfnApiKeyMixinPropsTheAWS::ApiGateway::ApiKeyresource creates a unique key that you can distribute to clients who are executing API GatewayMethodresources that require an API key.A fluent builder forCfnApiKeyPropsMixin.StageKeyis a property of the AWS::ApiGateway::ApiKey resource that specifies the stage to associate with the API key.A builder forCfnApiKeyPropsMixin.StageKeyPropertyAn implementation forCfnApiKeyPropsMixin.StageKeyPropertyProperties for CfnAuthorizerPropsMixin.A builder forCfnAuthorizerMixinPropsAn implementation forCfnAuthorizerMixinPropsTheAWS::ApiGateway::Authorizerresource creates an authorization layer that API Gateway activates for methods that have authorization enabled.A fluent builder forCfnAuthorizerPropsMixin.Properties for CfnBasePathMappingPropsMixin.A builder forCfnBasePathMappingMixinPropsAn implementation forCfnBasePathMappingMixinPropsTheAWS::ApiGateway::BasePathMappingresource creates a base path that clients who call your API must use in the invocation URL.A fluent builder forCfnBasePathMappingPropsMixin.Properties for CfnBasePathMappingV2PropsMixin.A builder forCfnBasePathMappingV2MixinPropsAn implementation forCfnBasePathMappingV2MixinPropsTheAWS::ApiGateway::BasePathMappingV2resource creates a base path that clients who call your API must use in the invocation URL.A fluent builder forCfnBasePathMappingV2PropsMixin.Properties for CfnClientCertificatePropsMixin.A builder forCfnClientCertificateMixinPropsAn implementation forCfnClientCertificateMixinPropsTheAWS::ApiGateway::ClientCertificateresource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.A fluent builder forCfnClientCertificatePropsMixin.Properties for CfnDeploymentPropsMixin.A builder forCfnDeploymentMixinPropsAn implementation forCfnDeploymentMixinPropsTheAWS::ApiGateway::Deploymentresource deploys an API GatewayRestApiresource to a stage so that clients can call the API over the internet.TheAccessLogSettingproperty type specifies settings for logging access in this stage.A builder forCfnDeploymentPropsMixin.AccessLogSettingPropertyAn implementation forCfnDeploymentPropsMixin.AccessLogSettingPropertyA fluent builder forCfnDeploymentPropsMixin.TheCanarySettingproperty type specifies settings for the canary deployment in this stage.A builder forCfnDeploymentPropsMixin.CanarySettingPropertyAn implementation forCfnDeploymentPropsMixin.CanarySettingPropertyTheDeploymentCanarySettingsproperty type specifies settings for the canary deployment.A builder forCfnDeploymentPropsMixin.DeploymentCanarySettingsPropertyAn implementation forCfnDeploymentPropsMixin.DeploymentCanarySettingsPropertyTheMethodSettingproperty type configures settings for all methods in a stage.A builder forCfnDeploymentPropsMixin.MethodSettingPropertyAn implementation forCfnDeploymentPropsMixin.MethodSettingPropertyStageDescriptionis a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.A builder forCfnDeploymentPropsMixin.StageDescriptionPropertyAn implementation forCfnDeploymentPropsMixin.StageDescriptionPropertyProperties for CfnDocumentationPartPropsMixin.A builder forCfnDocumentationPartMixinPropsAn implementation forCfnDocumentationPartMixinPropsTheAWS::ApiGateway::DocumentationPartresource creates a documentation part for an API.A fluent builder forCfnDocumentationPartPropsMixin.TheLocationproperty specifies the location of the Amazon API Gateway API entity that the documentation applies to.A builder forCfnDocumentationPartPropsMixin.LocationPropertyAn implementation forCfnDocumentationPartPropsMixin.LocationPropertyProperties for CfnDocumentationVersionPropsMixin.A builder forCfnDocumentationVersionMixinPropsAn implementation forCfnDocumentationVersionMixinPropsTheAWS::ApiGateway::DocumentationVersionresource creates a snapshot of the documentation for an API.A fluent builder forCfnDocumentationVersionPropsMixin.Properties for CfnDomainNameAccessAssociationPropsMixin.A builder forCfnDomainNameAccessAssociationMixinPropsAn implementation forCfnDomainNameAccessAssociationMixinPropsTheAWS::ApiGateway::DomainNameAccessAssociationresource creates a domain name access association between an access association source and a private custom domain name.A fluent builder forCfnDomainNameAccessAssociationPropsMixin.Properties for CfnDomainNamePropsMixin.A builder forCfnDomainNameMixinPropsAn implementation forCfnDomainNameMixinPropsTheAWS::ApiGateway::DomainNameresource specifies a public custom domain name for your API in API Gateway.A fluent builder forCfnDomainNamePropsMixin.TheEndpointConfigurationproperty type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.A builder forCfnDomainNamePropsMixin.EndpointConfigurationPropertyAn implementation forCfnDomainNamePropsMixin.EndpointConfigurationPropertyThe mutual TLS authentication configuration for a custom domain name.A builder forCfnDomainNamePropsMixin.MutualTlsAuthenticationPropertyAn implementation forCfnDomainNamePropsMixin.MutualTlsAuthenticationPropertyProperties for CfnDomainNameV2PropsMixin.A builder forCfnDomainNameV2MixinPropsAn implementation forCfnDomainNameV2MixinPropsTheAWS::ApiGateway::DomainNameV2resource specifies a custom domain name for your private APIs in API Gateway.A fluent builder forCfnDomainNameV2PropsMixin.The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.A builder forCfnDomainNameV2PropsMixin.EndpointConfigurationPropertyAn implementation forCfnDomainNameV2PropsMixin.EndpointConfigurationPropertyProperties for CfnGatewayResponsePropsMixin.A builder forCfnGatewayResponseMixinPropsAn implementation forCfnGatewayResponseMixinPropsTheAWS::ApiGateway::GatewayResponseresource creates a gateway response for your API.A fluent builder forCfnGatewayResponsePropsMixin.Properties for CfnMethodPropsMixin.A builder forCfnMethodMixinPropsAn implementation forCfnMethodMixinPropsTheAWS::ApiGateway::Methodresource creates API Gateway methods that define the parameters and body that clients must send in their requests.A fluent builder forCfnMethodPropsMixin.Integrationis a property of the AWS::ApiGateway::Method resource that specifies information about the target backend that a method calls.A builder forCfnMethodPropsMixin.IntegrationPropertyAn implementation forCfnMethodPropsMixin.IntegrationPropertyIntegrationResponseis 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.A builder forCfnMethodPropsMixin.IntegrationResponsePropertyAn implementation forCfnMethodPropsMixin.IntegrationResponsePropertyRepresents a method response of a given HTTP status code returned to the client.A builder forCfnMethodPropsMixin.MethodResponsePropertyAn implementation forCfnMethodPropsMixin.MethodResponsePropertyProperties for CfnModelPropsMixin.A builder forCfnModelMixinPropsAn implementation forCfnModelMixinPropsTheAWS::ApiGateway::Modelresource defines the structure of a request or response payload for an API method.A fluent builder forCfnModelPropsMixin.Properties for CfnRequestValidatorPropsMixin.A builder forCfnRequestValidatorMixinPropsAn implementation forCfnRequestValidatorMixinPropsTheAWS::ApiGateway::RequestValidatorresource sets up basic validation rules for incoming requests to your API.A fluent builder forCfnRequestValidatorPropsMixin.Properties for CfnResourcePropsMixin.A builder forCfnResourceMixinPropsAn implementation forCfnResourceMixinPropsTheAWS::ApiGateway::Resourceresource creates a resource in an API.A fluent builder forCfnResourcePropsMixin.Properties for CfnRestApiPropsMixin.A builder forCfnRestApiMixinPropsAn implementation forCfnRestApiMixinPropsTheAWS::ApiGateway::RestApiresource creates a REST API.A fluent builder forCfnRestApiPropsMixin.TheEndpointConfigurationproperty type specifies the endpoint types and IP address types of a REST API.A builder forCfnRestApiPropsMixin.EndpointConfigurationPropertyAn implementation forCfnRestApiPropsMixin.EndpointConfigurationPropertyS3Locationis 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.A builder forCfnRestApiPropsMixin.S3LocationPropertyAn implementation forCfnRestApiPropsMixin.S3LocationPropertyProperties for CfnStagePropsMixin.A builder forCfnStageMixinPropsAn implementation forCfnStageMixinPropsTheAWS::ApiGateway::Stageresource creates a stage for a deployment.TheAccessLogSettingproperty type specifies settings for logging access in this stage.A builder forCfnStagePropsMixin.AccessLogSettingPropertyAn implementation forCfnStagePropsMixin.AccessLogSettingPropertyA fluent builder forCfnStagePropsMixin.Configuration settings of a canary deployment.A builder forCfnStagePropsMixin.CanarySettingPropertyAn implementation forCfnStagePropsMixin.CanarySettingPropertyTheMethodSettingproperty type configures settings for all methods in a stage.A builder forCfnStagePropsMixin.MethodSettingPropertyAn implementation forCfnStagePropsMixin.MethodSettingPropertyProperties for CfnUsagePlanKeyPropsMixin.A builder forCfnUsagePlanKeyMixinPropsAn implementation forCfnUsagePlanKeyMixinPropsTheAWS::ApiGateway::UsagePlanKeyresource associates an API key with a usage plan.A fluent builder forCfnUsagePlanKeyPropsMixin.Properties for CfnUsagePlanPropsMixin.A builder forCfnUsagePlanMixinPropsAn implementation forCfnUsagePlanMixinPropsTheAWS::ApiGateway::UsagePlanresource creates a usage plan for deployed APIs.API stage name of the associated API stage in a usage plan.A builder forCfnUsagePlanPropsMixin.ApiStagePropertyAn implementation forCfnUsagePlanPropsMixin.ApiStagePropertyA fluent builder forCfnUsagePlanPropsMixin.QuotaSettingsis 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.A builder forCfnUsagePlanPropsMixin.QuotaSettingsPropertyAn implementation forCfnUsagePlanPropsMixin.QuotaSettingsPropertyThrottleSettingsis 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.A builder forCfnUsagePlanPropsMixin.ThrottleSettingsPropertyAn implementation forCfnUsagePlanPropsMixin.ThrottleSettingsPropertyProperties for CfnVpcLinkPropsMixin.A builder forCfnVpcLinkMixinPropsAn implementation forCfnVpcLinkMixinPropsTheAWS::ApiGateway::VpcLinkresource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC).A fluent builder forCfnVpcLinkPropsMixin.