software.amazon.awscdk.services.apigateway

Class StepFunctionsRestApi.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.StepFunctionsRestApi.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StepFunctionsRestApi>

Enclosing class:

StepFunctionsRestApi

@Stability(value=Stable)
public static final class StepFunctionsRestApi.Builder
extends Object
implements software.amazon.jsii.Builder<StepFunctionsRestApi>

A fluent builder for StepFunctionsRestApi.

Method Summary

Modifier and Type	Method and Description
StepFunctionsRestApi.Builder	apiKeySourceType(ApiKeySourceType apiKeySourceType) The source of the API key for metering requests according to a usage plan.
StepFunctionsRestApi.Builder	authorizer(Boolean authorizer) If the whole authorizer object, including custom context values should be in the execution input.
StepFunctionsRestApi.Builder	binaryMediaTypes(List<String> binaryMediaTypes) The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
StepFunctionsRestApi	build()
StepFunctionsRestApi.Builder	cloneFrom(IRestApi cloneFrom) The ID of the API Gateway RestApi resource that you want to clone.
StepFunctionsRestApi.Builder	cloudWatchRole(Boolean cloudWatchRole) Automatically configure an AWS CloudWatch role for API Gateway.
static StepFunctionsRestApi.Builder	create(software.constructs.Construct scope, String id)
StepFunctionsRestApi.Builder	defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions) Adds a CORS preflight OPTIONS method to this resource and all child resources.
StepFunctionsRestApi.Builder	defaultIntegration(Integration defaultIntegration) An integration to use as a default for all methods created within this API unless an integration is specified.
StepFunctionsRestApi.Builder	defaultMethodOptions(MethodOptions defaultMethodOptions) Method options to use as a default for all methods created within this API unless custom options are specified.
StepFunctionsRestApi.Builder	deploy(Boolean deploy) Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
StepFunctionsRestApi.Builder	deployOptions(StageOptions deployOptions) Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
StepFunctionsRestApi.Builder	description(String description) A description of the RestApi construct.
StepFunctionsRestApi.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) Specifies whether clients can invoke the API using the default execute-api endpoint.
StepFunctionsRestApi.Builder	domainName(DomainNameOptions domainName) Configure a custom domain name and map it to this API.
StepFunctionsRestApi.Builder	endpointConfiguration(EndpointConfiguration endpointConfiguration) The EndpointConfiguration property type specifies the endpoint types of a REST API.
StepFunctionsRestApi.Builder	endpointExportName(String endpointExportName) Export name for the CfnOutput containing the API endpoint.
StepFunctionsRestApi.Builder	endpointTypes(List<? extends EndpointType> endpointTypes) A list of the endpoint types of the API.
StepFunctionsRestApi.Builder	failOnWarnings(Boolean failOnWarnings) Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
StepFunctionsRestApi.Builder	headers(Boolean headers) Check if header is to be included inside the execution input.
StepFunctionsRestApi.Builder	minimumCompressionSize(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.
StepFunctionsRestApi.Builder	parameters(Map<String,String> parameters) Custom header parameters for the request.
StepFunctionsRestApi.Builder	path(Boolean path) Check if path is to be included inside the execution input.
StepFunctionsRestApi.Builder	policy(PolicyDocument policy) A policy document that contains the permissions for this RestApi.
StepFunctionsRestApi.Builder	querystring(Boolean querystring) Check if querystring is to be included inside the execution input.
StepFunctionsRestApi.Builder	requestContext(RequestContext requestContext) Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.
StepFunctionsRestApi.Builder	restApiName(String restApiName) A name for the API Gateway RestApi resource.
StepFunctionsRestApi.Builder	retainDeployments(Boolean retainDeployments) Retains old deployment resources when the API changes.
StepFunctionsRestApi.Builder	role(IRole role) An IAM role that API Gateway will assume to start the execution of the state machine.
StepFunctionsRestApi.Builder	stateMachine(IStateMachine stateMachine) The default State Machine that handles all requests from this API.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static StepFunctionsRestApi.Builder create(software.constructs.Construct scope,
                                                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of StepFunctionsRestApi.Builder.

defaultCorsPreflightOptions

@Stability(value=Stable)
public StepFunctionsRestApi.Builder defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)

Adds a CORS preflight OPTIONS method to this resource and all child resources.

You can add CORS at the resource-level using addCorsPreflight.

Default: - CORS is disabled

Parameters:

defaultCorsPreflightOptions - Adds a CORS preflight OPTIONS method to this resource and all child resources. This parameter is required.

Returns:

this

defaultIntegration

@Stability(value=Stable)
public StepFunctionsRestApi.Builder defaultIntegration(Integration defaultIntegration)

An integration to use as a default for all methods created within this API unless an integration is specified.

Default: - Inherited from parent.

Parameters:

defaultIntegration - An integration to use as a default for all methods created within this API unless an integration is specified. This parameter is required.

Returns:

this

defaultMethodOptions

@Stability(value=Stable)
public StepFunctionsRestApi.Builder defaultMethodOptions(MethodOptions defaultMethodOptions)

Method options to use as a default for all methods created within this API unless custom options are specified.

Default: - Inherited from parent.

Parameters:

defaultMethodOptions - Method options to use as a default for all methods created within this API unless custom options are specified. This parameter is required.

Returns:

this

cloudWatchRole

@Stability(value=Stable)
public StepFunctionsRestApi.Builder cloudWatchRole(Boolean cloudWatchRole)

Automatically configure an AWS CloudWatch role for API Gateway.

Default: - false if `@aws-cdk/aws-apigateway:disableCloudWatchRole` is enabled, true otherwise

Parameters:

cloudWatchRole - Automatically configure an AWS CloudWatch role for API Gateway. This parameter is required.

Returns:

this

deploy

@Stability(value=Stable)
public StepFunctionsRestApi.Builder deploy(Boolean 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.

Default: true

Parameters:

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.

Returns:

this

deployOptions

@Stability(value=Stable)
public StepFunctionsRestApi.Builder deployOptions(StageOptions 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.

Default: - Based on defaults of `StageOptions`.

Parameters:

deployOptions - Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public StepFunctionsRestApi.Builder description(String description)

A description of the RestApi construct.

Default: - 'Automatically created by the RestApi construct'

Parameters:

description - A description of the RestApi construct. This parameter is required.

Returns:

this

disableExecuteApiEndpoint

@Stability(value=Stable)
public StepFunctionsRestApi.Builder disableExecuteApiEndpoint(Boolean 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.

Default: false

Parameters:

disableExecuteApiEndpoint - Specifies whether clients can invoke the API using the default execute-api endpoint. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html

domainName

@Stability(value=Stable)
public StepFunctionsRestApi.Builder domainName(DomainNameOptions domainName)

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

Default: - no domain name is defined, use `addDomainName` or directly define a `DomainName`.

Parameters:

domainName - Configure a custom domain name and map it to this API. This parameter is required.

Returns:

this

endpointExportName

@Stability(value=Stable)
public StepFunctionsRestApi.Builder endpointExportName(String endpointExportName)

Export name for the CfnOutput containing the API endpoint.

Default: - when no export name is given, output will be created without export

Parameters:

endpointExportName - Export name for the CfnOutput containing the API endpoint. This parameter is required.

Returns:

this

endpointTypes

@Stability(value=Stable)
public StepFunctionsRestApi.Builder endpointTypes(List<? extends EndpointType> endpointTypes)

A list of the endpoint types of the API.

Use this property when creating an API.

Default: EndpointType.EDGE

Parameters:

endpointTypes - A list of the endpoint types of the API. This parameter is required.

Returns:

this

failOnWarnings

@Stability(value=Stable)
public StepFunctionsRestApi.Builder failOnWarnings(Boolean failOnWarnings)

Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

Default: false

Parameters:

failOnWarnings - Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. This parameter is required.

Returns:

this

parameters

@Stability(value=Stable)
public StepFunctionsRestApi.Builder parameters(Map<String,String> parameters)

Custom header parameters for the request.

Default: - No parameters.

Parameters:

parameters - Custom header parameters for the request. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html

policy

@Stability(value=Stable)
public StepFunctionsRestApi.Builder policy(PolicyDocument policy)

A policy document that contains the permissions for this RestApi.

Default: - No policy.

Parameters:

policy - A policy document that contains the permissions for this RestApi. This parameter is required.

Returns:

this

restApiName

@Stability(value=Stable)
public StepFunctionsRestApi.Builder restApiName(String restApiName)

A name for the API Gateway RestApi resource.

Default: - ID of the RestApi construct.

Parameters:

restApiName - A name for the API Gateway RestApi resource. This parameter is required.

Returns:

this

retainDeployments

@Stability(value=Stable)
public StepFunctionsRestApi.Builder retainDeployments(Boolean retainDeployments)

Retains old deployment resources when the API changes.

This allows manually reverting stages to point to old deployments via the AWS Console.

Default: false

Parameters:

retainDeployments - Retains old deployment resources when the API changes. This parameter is required.

Returns:

this

apiKeySourceType

@Stability(value=Stable)
public StepFunctionsRestApi.Builder apiKeySourceType(ApiKeySourceType apiKeySourceType)

The source of the API key for metering requests according to a usage plan.

Default: - Metering is disabled.

Parameters:

apiKeySourceType - The source of the API key for metering requests according to a usage plan. This parameter is required.

Returns:

this

binaryMediaTypes

@Stability(value=Stable)
public StepFunctionsRestApi.Builder binaryMediaTypes(List<String> binaryMediaTypes)

The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".

Default: - RestApi supports only UTF-8-encoded text payloads.

Parameters:

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.

Returns:

this

cloneFrom

@Stability(value=Stable)
public StepFunctionsRestApi.Builder cloneFrom(IRestApi cloneFrom)

The ID of the API Gateway RestApi resource that you want to clone.

Default: - None.

Parameters:

cloneFrom - The ID of the API Gateway RestApi resource that you want to clone. This parameter is required.

Returns:

this

endpointConfiguration

@Stability(value=Stable)
public StepFunctionsRestApi.Builder endpointConfiguration(EndpointConfiguration endpointConfiguration)

The EndpointConfiguration property type specifies the endpoint types of a REST API.

Default: EndpointType.EDGE

Parameters:

endpointConfiguration - The EndpointConfiguration property type specifies the endpoint types of a REST API. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html

minimumCompressionSize

@Stability(value=Stable)
public StepFunctionsRestApi.Builder minimumCompressionSize(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.

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.

Parameters:

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.

Returns:

this

stateMachine

@Stability(value=Stable)
public StepFunctionsRestApi.Builder stateMachine(IStateMachine stateMachine)

The default State Machine that handles all requests from this API.

This stateMachine will be used as a the default integration for all methods in this API, unless specified otherwise in addMethod.

Parameters:

stateMachine - The default State Machine that handles all requests from this API. This parameter is required.

Returns:

this

authorizer

@Stability(value=Stable)
public StepFunctionsRestApi.Builder authorizer(Boolean authorizer)

If the whole authorizer object, including custom context values should be in the execution input.

The execution input will include a new key authorizer:

{ "body": {}, "authorizer": { "key": "value" } }

Default: false

Parameters:

authorizer - If the whole authorizer object, including custom context values should be in the execution input. This parameter is required.

Returns:

this

headers

@Stability(value=Stable)
public StepFunctionsRestApi.Builder headers(Boolean headers)

Check if header is to be included inside the execution input.

The execution input will include a new key headers:

{ "body": {}, "headers": { "header1": "value", "header2": "value" } }

Default: false

Parameters:

headers - Check if header is to be included inside the execution input. This parameter is required.

Returns:

this

path

@Stability(value=Stable)
public StepFunctionsRestApi.Builder path(Boolean path)

Check if path is to be included inside the execution input.

The execution input will include a new key path:

{ "body": {}, "path": { "resourceName": "resourceValue" } }

Default: true

Parameters:

path - Check if path is to be included inside the execution input. This parameter is required.

Returns:

this

querystring

@Stability(value=Stable)
public StepFunctionsRestApi.Builder querystring(Boolean querystring)

Check if querystring is to be included inside the execution input.

The execution input will include a new key queryString:

{ "body": {}, "querystring": { "key": "value" } }

Default: true

Parameters:

querystring - Check if querystring is to be included inside the execution input. This parameter is required.

Returns:

this

requestContext

@Stability(value=Stable)
public StepFunctionsRestApi.Builder requestContext(RequestContext requestContext)

Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.

The execution input will include a new key requestContext:

{ "body": {}, "requestContext": { "key": "value" } }

Default: - all parameters within request context will be set as false

Parameters:

requestContext - Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public StepFunctionsRestApi.Builder role(IRole role)

An IAM role that API Gateway will assume to start the execution of the state machine.

Default: - a new role is created

Parameters:

role - An IAM role that API Gateway will assume to start the execution of the state machine. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public StepFunctionsRestApi build()

Specified by:

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