Package software.amazon.awscdk.services.apigateway

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RestApiBaseProps	build()	Builds the configured instance.
RestApiBaseProps.Builder	cloudWatchRole(Boolean cloudWatchRole)	Sets the value of RestApiBaseProps.getCloudWatchRole()
RestApiBaseProps.Builder	cloudWatchRoleRemovalPolicy(RemovalPolicy cloudWatchRoleRemovalPolicy)	Sets the value of RestApiBaseProps.getCloudWatchRoleRemovalPolicy()
RestApiBaseProps.Builder	deploy(Boolean deploy)	Sets the value of RestApiBaseProps.getDeploy()
RestApiBaseProps.Builder	deployOptions(StageOptions deployOptions)	Sets the value of RestApiBaseProps.getDeployOptions()
RestApiBaseProps.Builder	description(String description)	Sets the value of RestApiBaseProps.getDescription()
RestApiBaseProps.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)	Sets the value of RestApiBaseProps.getDisableExecuteApiEndpoint()
RestApiBaseProps.Builder	domainName(DomainNameOptions domainName)	Sets the value of RestApiBaseProps.getDomainName()
RestApiBaseProps.Builder	endpointExportName(String endpointExportName)	Sets the value of RestApiBaseProps.getEndpointExportName()
RestApiBaseProps.Builder	endpointTypes(List<? extends EndpointType> endpointTypes)	Sets the value of RestApiBaseProps.getEndpointTypes()
RestApiBaseProps.Builder	failOnWarnings(Boolean failOnWarnings)	Sets the value of RestApiBaseProps.getFailOnWarnings()
RestApiBaseProps.Builder	parameters(Map<String,String> parameters)	Sets the value of RestApiBaseProps.getParameters()
RestApiBaseProps.Builder	policy(PolicyDocument policy)	Sets the value of RestApiBaseProps.getPolicy()
RestApiBaseProps.Builder	restApiName(String restApiName)	Sets the value of RestApiBaseProps.getRestApiName()
RestApiBaseProps.Builder	retainDeployments(Boolean retainDeployments)	Sets the value of RestApiBaseProps.getRetainDeployments()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

cloudWatchRole

@Stability(Stable)
public RestApiBaseProps.Builder cloudWatchRole(Boolean cloudWatchRole)

Sets the value of RestApiBaseProps.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 of RestApiBaseProps.getCloudWatchRoleRemovalPolicy()

Parameters:

cloudWatchRoleRemovalPolicy - The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. Requires cloudWatchRole to be enabled.

Returns:

this

deploy

@Stability(Stable)
public RestApiBaseProps.Builder deploy(Boolean deploy)

Sets the value of RestApiBaseProps.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 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.

Returns:

this

deployOptions

@Stability(Stable)
public RestApiBaseProps.Builder deployOptions(StageOptions deployOptions)

Sets the value of RestApiBaseProps.getDeployOptions()

Parameters:

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.

Returns:

this

description

@Stability(Stable)
public RestApiBaseProps.Builder description(String description)

Sets the value of RestApiBaseProps.getDescription()

Parameters:

description - A description of the RestApi construct.

Returns:

this

disableExecuteApiEndpoint

@Stability(Stable)
public RestApiBaseProps.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)

Sets the value of RestApiBaseProps.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

@Stability(Stable)
public RestApiBaseProps.Builder domainName(DomainNameOptions domainName)

Sets the value of RestApiBaseProps.getDomainName()

Parameters:

domainName - Configure a custom domain name and map it to this API.

Returns:

this

endpointExportName

@Stability(Stable)
public RestApiBaseProps.Builder endpointExportName(String endpointExportName)

Sets the value of RestApiBaseProps.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 of RestApiBaseProps.getEndpointTypes()

Parameters:

endpointTypes - A list of the endpoint types of the API. Use this property when creating an API.

Returns:

this

failOnWarnings

@Stability(Stable)
public RestApiBaseProps.Builder failOnWarnings(Boolean failOnWarnings)

Sets the value of RestApiBaseProps.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

@Stability(Stable)
public RestApiBaseProps.Builder parameters(Map<String,String> parameters)

Sets the value of RestApiBaseProps.getParameters()

Parameters:

parameters - Custom header parameters for the request.

Returns:

this

policy

@Stability(Stable)
public RestApiBaseProps.Builder policy(PolicyDocument policy)

Sets the value of RestApiBaseProps.getPolicy()

Parameters:

policy - A policy document that contains the permissions for this RestApi.

Returns:

this

restApiName

@Stability(Stable)
public RestApiBaseProps.Builder restApiName(String restApiName)

Sets the value of RestApiBaseProps.getRestApiName()

Parameters:

restApiName - A name for the API Gateway RestApi resource.

Returns:

this

retainDeployments

@Stability(Stable)
public RestApiBaseProps.Builder retainDeployments(Boolean retainDeployments)

Sets the value of RestApiBaseProps.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

@Stability(Stable)
public RestApiBaseProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<RestApiBaseProps>

Returns:

a new instance of RestApiBaseProps

Throws:

NullPointerException - if any required attribute was not provided