Package-level declarations
Types
Provides a settings of an API Gateway Account. Settings is applied region-wide per provider block.
Provides a settings of an API Gateway Account. Settings is applied region-wide per provider block.
Builder for AccountArgs.
Builder for Account.
Provides an API Gateway API Key.
Provides an API Gateway API Key.
Builder for ApiKeyArgs.
Builder for ApiKey.
Provides an API Gateway Authorizer.
Provides an API Gateway Authorizer.
Builder for AuthorizerArgs.
Builder for Authorizer.
Connects a custom domain name registered via aws.apigateway.DomainName with a deployed API so that its methods can be called via the custom domain name.
Connects a custom domain name registered via aws.apigateway.DomainName with a deployed API so that its methods can be called via the custom domain name.
Builder for BasePathMappingArgs.
Builder for BasePathMapping.
Provides an API Gateway Client Certificate.
Provides an API Gateway Client Certificate.
Builder for ClientCertificateArgs.
Builder for ClientCertificate.
Manages an API Gateway REST Deployment. A deployment is a snapshot of the REST API configuration. The deployment can then be published to callable endpoints via the aws.apigateway.Stage resource and optionally managed further with the aws.apigateway.BasePathMapping resource, aws.apigateway.DomainName resource, and aws_api_method_settings resource. For more information, see the API Gateway Developer Guide. To properly capture all REST API configuration in a deployment, this resource must have dependencies on all prior resources that manage resources/paths, methods, integrations, etc.
Manages an API Gateway REST Deployment. A deployment is a snapshot of the REST API configuration. The deployment can then be published to callable endpoints via the aws.apigateway.Stage resource and optionally managed further with the aws.apigateway.BasePathMapping resource, aws.apigateway.DomainName resource, and aws_api_method_settings resource. For more information, see the API Gateway Developer Guide. To properly capture all REST API configuration in a deployment, this resource must have dependencies on all prior resources that manage resources/paths, methods, integrations, etc.
Builder for DeploymentArgs.
Builder for Deployment.
Provides a settings of an API Gateway Documentation Part.
Provides a settings of an API Gateway Documentation Part.
Builder for DocumentationPartArgs.
Builder for DocumentationPart.
Provides a resource to manage an API Gateway Documentation Version.
Provides a resource to manage an API Gateway Documentation Version.
Builder for DocumentationVersionArgs.
Builder for DocumentationVersion.
Registers a custom domain name for use with AWS API Gateway. Additional information about this functionality can be found in the API Gateway Developer Guide. This resource just establishes ownership of and the TLS settings for a particular domain name. An API can be attached to a particular path under the registered domain name using the aws.apigateway.BasePathMapping resource. API Gateway domains can be defined as either 'edge-optimized' or 'regional'. In an edge-optimized configuration, API Gateway internally creates and manages a CloudFront distribution to route requests on the given hostname. In addition to this resource it's necessary to create a DNS record corresponding to the given domain name which is an alias (either Route53 alias or traditional CNAME) to the Cloudfront domain name exported in the cloudfront_domain_name attribute. In a regional configuration, API Gateway does not create a CloudFront distribution to route requests to the API, though a distribution can be created if needed. In either case, it is necessary to create a DNS record corresponding to the given domain name which is an alias (either Route53 alias or traditional CNAME) to the regional domain name exported in the regional_domain_name attribute.
Registers a custom domain name for use with AWS API Gateway. Additional information about this functionality can be found in the API Gateway Developer Guide. This resource just establishes ownership of and the TLS settings for a particular domain name. An API can be attached to a particular path under the registered domain name using the aws.apigateway.BasePathMapping resource. API Gateway domains can be defined as either 'edge-optimized' or 'regional'. In an edge-optimized configuration, API Gateway internally creates and manages a CloudFront distribution to route requests on the given hostname. In addition to this resource it's necessary to create a DNS record corresponding to the given domain name which is an alias (either Route53 alias or traditional CNAME) to the Cloudfront domain name exported in the cloudfront_domain_name attribute. In a regional configuration, API Gateway does not create a CloudFront distribution to route requests to the API, though a distribution can be created if needed. In either case, it is necessary to create a DNS record corresponding to the given domain name which is an alias (either Route53 alias or traditional CNAME) to the regional domain name exported in the regional_domain_name attribute.
Builder for DomainNameArgs.
Builder for DomainName.
Provides an HTTP Method Integration for an API Gateway Integration.
Provides an HTTP Method Integration for an API Gateway Integration.
Builder for IntegrationArgs.
Builder for Integration.
Provides an HTTP Method Integration Response for an API Gateway Resource.
Provides an HTTP Method Integration Response for an API Gateway Resource.
Builder for IntegrationResponseArgs.
Builder for IntegrationResponse.
Provides a HTTP Method for an API Gateway Resource.
Provides a HTTP Method for an API Gateway Resource.
Builder for MethodArgs.
Builder for Method.
Provides an HTTP Method Response for an API Gateway Resource.
Provides an HTTP Method Response for an API Gateway Resource.
Builder for MethodResponseArgs.
Builder for MethodResponse.
/* Manages API Gateway Stage Method Settings. For example, CloudWatch logging and metrics.
/* /* Manages API Gateway Stage Method Settings. For example, CloudWatch logging and metrics.
Builder for MethodSettingsArgs.
Builder for MethodSettings.
Provides a Model for a REST API Gateway.
Builder for ModelArgs.
Builder for Model.
Manages an API Gateway Request Validator.
Manages an API Gateway Request Validator.
Builder for RequestValidatorArgs.
Builder for RequestValidator.
Provides an API Gateway Resource.
Provides an API Gateway Resource.
Builder for ResourceArgs.
Builder for Resource.
Provides an API Gateway Gateway Response for a REST API Gateway.
Provides an API Gateway Gateway Response for a REST API Gateway.
Builder for ResponseArgs.
Builder for Response.
Manages an API Gateway REST API. The REST API can be configured via importing an OpenAPI specification in the body argument (with other arguments serving as overrides) or via other provider resources to manage the resources (aws.apigateway.Resource resource), methods (aws.apigateway.Method resource), integrations (aws.apigateway.Integration resource), etc. of the REST API. Once the REST API is configured, the aws.apigateway.Deployment resource can be used along with the aws.apigateway.Stage resource to publish the REST API.
Manages an API Gateway REST API. The REST API can be configured via importing an OpenAPI specification in the body argument (with other arguments serving as overrides) or via other provider resources to manage the resources (aws.apigateway.Resource resource), methods (aws.apigateway.Method resource), integrations (aws.apigateway.Integration resource), etc. of the REST API. Once the REST API is configured, the aws.apigateway.Deployment resource can be used along with the aws.apigateway.Stage resource to publish the REST API.
Builder for RestApiArgs.
Provides an API Gateway REST API Policy.
Provides an API Gateway REST API Policy.
Builder for RestApiPolicyArgs.
Builder for RestApiPolicy.
Builder for RestApi.
/* Manages an API Gateway Stage. A stage is a named reference to a deployment, which can be done via the aws.apigateway.Deployment resource. Stages can be optionally managed further with the aws.apigateway.BasePathMapping resource, aws.apigateway.DomainName resource, and aws_api_method_settings resource. For more information, see the API Gateway Developer Guide.
/* Manages an API Gateway Stage. A stage is a named reference to a deployment, which can be done via the aws.apigateway.Deployment resource. Stages can be optionally managed further with the aws.apigateway.BasePathMapping resource, aws.apigateway.DomainName resource, and aws_api_method_settings resource. For more information, see the API Gateway Developer Guide.
Builder for StageArgs.
Builder for Stage.
Provides an API Gateway Usage Plan.
Provides an API Gateway Usage Plan.
Builder for UsagePlanArgs.
Provides an API Gateway Usage Plan Key.
Provides an API Gateway Usage Plan Key.
Builder for UsagePlanKeyArgs.
Builder for UsagePlanKey.
Builder for UsagePlan.
Provides an API Gateway VPC Link.
Provides an API Gateway VPC Link.
Builder for VpcLinkArgs.
Builder for VpcLink.