Class RestApiBaseProps.Builder
java.lang.Object
software.amazon.awscdk.services.apigateway.RestApiBaseProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<RestApiBaseProps>
- Enclosing interface:
RestApiBaseProps
@Stability(Stable)
public static final class RestApiBaseProps.Builder
extends Object
implements software.amazon.jsii.Builder<RestApiBaseProps>
A builder for
RestApiBaseProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.cloudWatchRole
(Boolean cloudWatchRole) Sets the value ofRestApiBaseProps.getCloudWatchRole()
cloudWatchRoleRemovalPolicy
(RemovalPolicy cloudWatchRoleRemovalPolicy) Sets the value ofRestApiBaseProps.getCloudWatchRoleRemovalPolicy()
Sets the value ofRestApiBaseProps.getDeploy()
deployOptions
(StageOptions deployOptions) Sets the value ofRestApiBaseProps.getDeployOptions()
description
(String description) Sets the value ofRestApiBaseProps.getDescription()
disableExecuteApiEndpoint
(Boolean disableExecuteApiEndpoint) Sets the value ofRestApiBaseProps.getDisableExecuteApiEndpoint()
domainName
(DomainNameOptions domainName) Sets the value ofRestApiBaseProps.getDomainName()
endpointExportName
(String endpointExportName) Sets the value ofRestApiBaseProps.getEndpointExportName()
endpointTypes
(List<? extends EndpointType> endpointTypes) Sets the value ofRestApiBaseProps.getEndpointTypes()
failOnWarnings
(Boolean failOnWarnings) Sets the value ofRestApiBaseProps.getFailOnWarnings()
parameters
(Map<String, String> parameters) Sets the value ofRestApiBaseProps.getParameters()
policy
(PolicyDocument policy) Sets the value ofRestApiBaseProps.getPolicy()
restApiName
(String restApiName) Sets the value ofRestApiBaseProps.getRestApiName()
retainDeployments
(Boolean retainDeployments) Sets the value ofRestApiBaseProps.getRetainDeployments()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
cloudWatchRole
Sets the value ofRestApiBaseProps.getCloudWatchRole()
- Parameters:
cloudWatchRole
- Automatically configure an AWS CloudWatch role for API Gateway.- Returns:
this
-
cloudWatchRoleRemovalPolicy
@Stability(Stable) public RestApiBaseProps.Builder cloudWatchRoleRemovalPolicy(RemovalPolicy cloudWatchRoleRemovalPolicy) Sets the value ofRestApiBaseProps.getCloudWatchRoleRemovalPolicy()
- Parameters:
cloudWatchRoleRemovalPolicy
- The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. RequirescloudWatchRole
to be enabled.- Returns:
this
-
deploy
Sets the value ofRestApiBaseProps.getDeploy()
- Parameters:
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 theDeployment
object anddeploymentStage
will refer to aStage
that points to this deployment. To customize the stage options, use thedeployOptions
property.A CloudFormation Output will also be defined with the root URL endpoint of this REST API.
- Returns:
this
-
deployOptions
Sets the value ofRestApiBaseProps.getDeployOptions()
- Parameters:
deployOptions
- Options for the API Gateway stage that will always point to the latest deployment whendeploy
is enabled. Ifdeploy
is disabled, this value cannot be set.- Returns:
this
-
description
Sets the value ofRestApiBaseProps.getDescription()
- Parameters:
description
- A description of the RestApi construct.- Returns:
this
-
disableExecuteApiEndpoint
@Stability(Stable) public RestApiBaseProps.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) Sets the value ofRestApiBaseProps.getDisableExecuteApiEndpoint()
- Parameters:
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.- Returns:
this
-
domainName
Sets the value ofRestApiBaseProps.getDomainName()
- Parameters:
domainName
- Configure a custom domain name and map it to this API.- Returns:
this
-
endpointExportName
Sets the value ofRestApiBaseProps.getEndpointExportName()
- Parameters:
endpointExportName
- Export name for the CfnOutput containing the API endpoint.- Returns:
this
-
endpointTypes
@Stability(Stable) public RestApiBaseProps.Builder endpointTypes(List<? extends EndpointType> endpointTypes) Sets the value ofRestApiBaseProps.getEndpointTypes()
- Parameters:
endpointTypes
- A list of the endpoint types of the API. Use this property when creating an API.- Returns:
this
-
failOnWarnings
Sets the value ofRestApiBaseProps.getFailOnWarnings()
- Parameters:
failOnWarnings
- Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.- Returns:
this
-
parameters
Sets the value ofRestApiBaseProps.getParameters()
- Parameters:
parameters
- Custom header parameters for the request.- Returns:
this
-
policy
Sets the value ofRestApiBaseProps.getPolicy()
- Parameters:
policy
- A policy document that contains the permissions for this RestApi.- Returns:
this
-
restApiName
Sets the value ofRestApiBaseProps.getRestApiName()
- Parameters:
restApiName
- A name for the API Gateway RestApi resource.- Returns:
this
-
retainDeployments
Sets the value ofRestApiBaseProps.getRetainDeployments()
- Parameters:
retainDeployments
- Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<RestApiBaseProps>
- Returns:
- a new instance of
RestApiBaseProps
- Throws:
NullPointerException
- if any required attribute was not provided
-