Modifier and Type | Method and Description |
---|---|
RestApi.Builder |
apiKeySourceType(ApiKeySourceType apiKeySourceType)
The source of the API key for metering requests according to a usage plan.
|
RestApi.Builder |
binaryMediaTypes(java.util.List<java.lang.String> binaryMediaTypes)
The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
|
RestApi |
build() |
RestApi.Builder |
cloneFrom(IRestApi cloneFrom)
The ID of the API Gateway RestApi resource that you want to clone.
|
RestApi.Builder |
cloudWatchRole(java.lang.Boolean cloudWatchRole)
Automatically configure an AWS CloudWatch role for API Gateway.
|
static RestApi.Builder |
create(software.constructs.Construct scope,
java.lang.String id) |
RestApi.Builder |
defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)
Adds a CORS preflight OPTIONS method to this resource and all child resources.
|
RestApi.Builder |
defaultIntegration(Integration defaultIntegration)
An integration to use as a default for all methods created within this API unless an integration is specified.
|
RestApi.Builder |
defaultMethodOptions(MethodOptions defaultMethodOptions)
Method options to use as a default for all methods created within this API unless custom options are specified.
|
RestApi.Builder |
deploy(java.lang.Boolean deploy)
Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
|
RestApi.Builder |
deployOptions(StageOptions deployOptions)
Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
|
RestApi.Builder |
description(java.lang.String description)
A description of the purpose of this API Gateway RestApi resource.
|
RestApi.Builder |
disableExecuteApiEndpoint(java.lang.Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke the API using the default execute-api endpoint.
|
RestApi.Builder |
domainName(DomainNameOptions domainName)
Configure a custom domain name and map it to this API.
|
RestApi.Builder |
endpointConfiguration(EndpointConfiguration endpointConfiguration)
The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
RestApi.Builder |
endpointExportName(java.lang.String endpointExportName)
Export name for the CfnOutput containing the API endpoint.
|
RestApi.Builder |
endpointTypes(java.util.List<? extends EndpointType> endpointTypes)
A list of the endpoint types of the API.
|
RestApi.Builder |
failOnWarnings(java.lang.Boolean failOnWarnings)
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
|
RestApi.Builder |
minimumCompressionSize(java.lang.Number minimumCompressionSize)
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.
|
RestApi.Builder |
parameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Custom header parameters for the request.
|
RestApi.Builder |
policy(PolicyDocument policy)
A policy document that contains the permissions for this RestApi.
|
RestApi.Builder |
restApiName(java.lang.String restApiName)
A name for the API Gateway RestApi resource.
|
RestApi.Builder |
retainDeployments(java.lang.Boolean retainDeployments)
Retains old deployment resources when the API changes.
|
public static RestApi.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.RestApi.Builder
.public RestApi.Builder cloudWatchRole(java.lang.Boolean cloudWatchRole)
Default: true
cloudWatchRole
- Automatically configure an AWS CloudWatch role for API Gateway. This parameter is required.this
public RestApi.Builder deploy(java.lang.Boolean deploy)
Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.
If this is set, latestDeployment
will refer to the Deployment
object
and deploymentStage
will refer to a Stage
that points to this
deployment. To customize the stage options, use the deployOptions
property.
A CloudFormation Output will also be defined with the root URL endpoint of this REST API.
Default: true
deploy
- Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. This parameter is required.this
public RestApi.Builder deployOptions(StageOptions deployOptions)
If deploy
is disabled,
this value cannot be set.
Default: - Based on defaults of `StageOptions`.
deployOptions
- Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled. This parameter is required.this
public RestApi.Builder disableExecuteApiEndpoint(java.lang.Boolean disableExecuteApiEndpoint)
To require that clients use a custom domain name to invoke the API, disable the default endpoint.
Default: false
disableExecuteApiEndpoint
- Specifies whether clients can invoke the API using the default execute-api endpoint. This parameter is required.this
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
public RestApi.Builder domainName(DomainNameOptions domainName)
Default: - no domain name is defined, use `addDomainName` or directly define a `DomainName`.
domainName
- Configure a custom domain name and map it to this API. This parameter is required.this
public RestApi.Builder endpointExportName(java.lang.String endpointExportName)
Default: - when no export name is given, output will be created without export
endpointExportName
- Export name for the CfnOutput containing the API endpoint. This parameter is required.this
public RestApi.Builder endpointTypes(java.util.List<? extends EndpointType> endpointTypes)
Use this property when creating an API.
Default: EndpointType.EDGE
endpointTypes
- A list of the endpoint types of the API. This parameter is required.this
public RestApi.Builder failOnWarnings(java.lang.Boolean failOnWarnings)
Default: false
failOnWarnings
- Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. This parameter is required.this
public RestApi.Builder parameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Default: - No parameters.
parameters
- Custom header parameters for the request. This parameter is required.this
https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html
public RestApi.Builder policy(PolicyDocument policy)
Default: - No policy.
policy
- A policy document that contains the permissions for this RestApi. This parameter is required.this
public RestApi.Builder restApiName(java.lang.String restApiName)
Default: - ID of the RestApi construct.
restApiName
- A name for the API Gateway RestApi resource. This parameter is required.this
public RestApi.Builder retainDeployments(java.lang.Boolean retainDeployments)
This allows manually reverting stages to point to old deployments via the AWS Console.
Default: false
retainDeployments
- Retains old deployment resources when the API changes. This parameter is required.this
public RestApi.Builder defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)
You can add CORS at the resource-level using addCorsPreflight
.
Default: - CORS is disabled
defaultCorsPreflightOptions
- Adds a CORS preflight OPTIONS method to this resource and all child resources. This parameter is required.this
public RestApi.Builder defaultIntegration(Integration defaultIntegration)
Default: - Inherited from parent.
defaultIntegration
- An integration to use as a default for all methods created within this API unless an integration is specified. This parameter is required.this
public RestApi.Builder defaultMethodOptions(MethodOptions defaultMethodOptions)
Default: - Inherited from parent.
defaultMethodOptions
- Method options to use as a default for all methods created within this API unless custom options are specified. This parameter is required.this
public RestApi.Builder apiKeySourceType(ApiKeySourceType apiKeySourceType)
Default: - Metering is disabled.
apiKeySourceType
- The source of the API key for metering requests according to a usage plan. This parameter is required.this
public RestApi.Builder binaryMediaTypes(java.util.List<java.lang.String> binaryMediaTypes)
Default: - RestApi supports only UTF-8-encoded text payloads.
binaryMediaTypes
- The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream". This parameter is required.this
public RestApi.Builder cloneFrom(IRestApi cloneFrom)
Default: - None.
cloneFrom
- The ID of the API Gateway RestApi resource that you want to clone. This parameter is required.this
public RestApi.Builder description(java.lang.String description)
Default: - No description.
description
- A description of the purpose of this API Gateway RestApi resource. This parameter is required.this
public RestApi.Builder endpointConfiguration(EndpointConfiguration endpointConfiguration)
Default: EndpointType.EDGE
endpointConfiguration
- The EndpointConfiguration property type specifies the endpoint types of a REST API. This parameter is required.this
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
public RestApi.Builder minimumCompressionSize(java.lang.Number minimumCompressionSize)
When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
Default: - Compression is disabled.
minimumCompressionSize
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. This parameter is required.this
public RestApi build()