public static final class RestApiProps.Builder
extends java.lang.Object
RestApiProps
Constructor and Description |
---|
Builder() |
public RestApiProps.Builder apiKeySourceType(ApiKeySourceType apiKeySourceType)
RestApiProps.getApiKeySourceType()
apiKeySourceType
- The source of the API key for metering requests according to a usage plan.this
public RestApiProps.Builder binaryMediaTypes(java.util.List<java.lang.String> binaryMediaTypes)
RestApiProps.getBinaryMediaTypes()
binaryMediaTypes
- The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".this
public RestApiProps.Builder cloneFrom(IRestApi cloneFrom)
RestApiProps.getCloneFrom()
cloneFrom
- The ID of the API Gateway RestApi resource that you want to clone.this
public RestApiProps.Builder description(java.lang.String description)
RestApiProps.getDescription()
description
- A description of the purpose of this API Gateway RestApi resource.this
public RestApiProps.Builder endpointConfiguration(EndpointConfiguration endpointConfiguration)
RestApiProps.getEndpointConfiguration()
endpointConfiguration
- The EndpointConfiguration property type specifies the endpoint types of a REST API.this
public RestApiProps.Builder minimumCompressionSize(java.lang.Number minimumCompressionSize)
RestApiProps.getMinimumCompressionSize()
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.
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.this
public RestApiProps.Builder cloudWatchRole(java.lang.Boolean cloudWatchRole)
RestApiBaseProps.getCloudWatchRole()
cloudWatchRole
- Automatically configure an AWS CloudWatch role for API Gateway.this
public RestApiProps.Builder deploy(java.lang.Boolean deploy)
RestApiBaseProps.getDeploy()
deploy
- Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
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.
this
public RestApiProps.Builder deployOptions(StageOptions deployOptions)
RestApiBaseProps.getDeployOptions()
deployOptions
- Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
If deploy
is disabled,
this value cannot be set.this
public RestApiProps.Builder disableExecuteApiEndpoint(java.lang.Boolean disableExecuteApiEndpoint)
RestApiBaseProps.getDisableExecuteApiEndpoint()
disableExecuteApiEndpoint
- Specifies whether clients can invoke the API using the default execute-api endpoint.
To require that clients use a custom domain name to invoke the
API, disable the default endpoint.this
public RestApiProps.Builder domainName(DomainNameOptions domainName)
RestApiBaseProps.getDomainName()
domainName
- Configure a custom domain name and map it to this API.this
public RestApiProps.Builder endpointExportName(java.lang.String endpointExportName)
RestApiBaseProps.getEndpointExportName()
endpointExportName
- Export name for the CfnOutput containing the API endpoint.this
public RestApiProps.Builder endpointTypes(java.util.List<? extends EndpointType> endpointTypes)
RestApiBaseProps.getEndpointTypes()
endpointTypes
- A list of the endpoint types of the API.
Use this property when creating
an API.this
public RestApiProps.Builder failOnWarnings(java.lang.Boolean failOnWarnings)
RestApiBaseProps.getFailOnWarnings()
failOnWarnings
- Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.this
public RestApiProps.Builder parameters(java.util.Map<java.lang.String,java.lang.String> parameters)
RestApiBaseProps.getParameters()
parameters
- Custom header parameters for the request.this
public RestApiProps.Builder policy(PolicyDocument policy)
RestApiBaseProps.getPolicy()
policy
- A policy document that contains the permissions for this RestApi.this
public RestApiProps.Builder restApiName(java.lang.String restApiName)
RestApiBaseProps.getRestApiName()
restApiName
- A name for the API Gateway RestApi resource.this
public RestApiProps.Builder retainDeployments(java.lang.Boolean retainDeployments)
RestApiBaseProps.getRetainDeployments()
retainDeployments
- Retains old deployment resources when the API changes.
This allows
manually reverting stages to point to old deployments via the AWS
Console.this
public RestApiProps.Builder defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)
ResourceOptions.getDefaultCorsPreflightOptions()
defaultCorsPreflightOptions
- Adds a CORS preflight OPTIONS method to this resource and all child resources.
You can add CORS at the resource-level using addCorsPreflight
.this
public RestApiProps.Builder defaultIntegration(Integration defaultIntegration)
ResourceOptions.getDefaultIntegration()
defaultIntegration
- An integration to use as a default for all methods created within this API unless an integration is specified.this
public RestApiProps.Builder defaultMethodOptions(MethodOptions defaultMethodOptions)
ResourceOptions.getDefaultMethodOptions()
defaultMethodOptions
- Method options to use as a default for all methods created within this API unless custom options are specified.this
public RestApiProps build()
RestApiProps
java.lang.NullPointerException
- if any required attribute was not provided