software.amazon.awscdk.services.apigateway

Class Stage.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.Stage.Builder

Enclosing class:

Stage

public static final class Stage.Builder
extends java.lang.Object

A fluent builder for Stage.

Method Summary

Modifier and Type	Method and Description
Stage.Builder	accessLogDestination(IAccessLogDestination accessLogDestination) The CloudWatch Logs log group.
Stage.Builder	accessLogFormat(AccessLogFormat accessLogFormat) A single line format of access logs of data, as specified by selected $content variables.
Stage	build()
Stage.Builder	cacheClusterEnabled(java.lang.Boolean cacheClusterEnabled) Indicates whether cache clustering is enabled for the stage.
Stage.Builder	cacheClusterSize(java.lang.String cacheClusterSize) The stage's cache cluster size.
Stage.Builder	cacheDataEncrypted(java.lang.Boolean cacheDataEncrypted) Indicates whether the cached responses are encrypted.
Stage.Builder	cacheTtl(Duration cacheTtl) Specifies the time to live (TTL), in seconds, for cached responses.
Stage.Builder	cachingEnabled(java.lang.Boolean cachingEnabled) Specifies whether responses should be cached and returned for requests.
Stage.Builder	clientCertificateId(java.lang.String clientCertificateId) The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
static Stage.Builder	create(software.constructs.Construct scope, java.lang.String id)
Stage.Builder	dataTraceEnabled(java.lang.Boolean dataTraceEnabled) Specifies whether data trace logging is enabled for this method.
Stage.Builder	deployment(Deployment deployment) The deployment that this stage points to [disable-awslint:ref-via-interface].
Stage.Builder	description(java.lang.String description) A description of the purpose of the stage.
Stage.Builder	documentationVersion(java.lang.String documentationVersion) The version identifier of the API documentation snapshot.
Stage.Builder	loggingLevel(MethodLoggingLevel loggingLevel) Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
Stage.Builder	methodOptions(java.util.Map<java.lang.String,? extends MethodDeploymentOptions> methodOptions) Method deployment options for specific resources/methods.
Stage.Builder	metricsEnabled(java.lang.Boolean metricsEnabled) Specifies whether Amazon CloudWatch metrics are enabled for this method.
Stage.Builder	stageName(java.lang.String stageName) The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
Stage.Builder	throttlingBurstLimit(java.lang.Number throttlingBurstLimit) Specifies the throttling burst limit.
Stage.Builder	throttlingRateLimit(java.lang.Number throttlingRateLimit) Specifies the throttling rate limit.
Stage.Builder	tracingEnabled(java.lang.Boolean tracingEnabled) Specifies whether Amazon X-Ray tracing is enabled for this method.
Stage.Builder	variables(java.util.Map<java.lang.String,java.lang.String> variables) A map that defines the stage variables.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Stage.Builder create(software.constructs.Construct scope,
                                   java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Stage.Builder.

cacheDataEncrypted

public Stage.Builder cacheDataEncrypted(java.lang.Boolean cacheDataEncrypted)

Indicates whether the cached responses are encrypted.

Default: false

Parameters:

cacheDataEncrypted - Indicates whether the cached responses are encrypted. This parameter is required.

Returns:

this

cacheTtl

public Stage.Builder cacheTtl(Duration cacheTtl)

Specifies the time to live (TTL), in seconds, for cached responses.

The higher the TTL, the longer the response will be cached.

Default: Duration.minutes(5)

Parameters:

cacheTtl - Specifies the time to live (TTL), in seconds, for cached responses. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html

cachingEnabled

public Stage.Builder cachingEnabled(java.lang.Boolean cachingEnabled)

Specifies whether responses should be cached and returned for requests.

A cache cluster must be enabled on the stage for responses to be cached.

Default: - Caching is Disabled.

Parameters:

cachingEnabled - Specifies whether responses should be cached and returned for requests. This parameter is required.

Returns:

this

dataTraceEnabled

public Stage.Builder dataTraceEnabled(java.lang.Boolean dataTraceEnabled)

Specifies whether data trace logging is enabled for this method.

When enabled, API gateway will log the full API requests and responses. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this feature for production APIs.

Default: false

Parameters:

dataTraceEnabled - Specifies whether data trace logging is enabled for this method. This parameter is required.

Returns:

this

loggingLevel

public Stage.Builder loggingLevel(MethodLoggingLevel loggingLevel)

Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.

Default: - Off

Parameters:

loggingLevel - Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. This parameter is required.

Returns:

this

metricsEnabled

public Stage.Builder metricsEnabled(java.lang.Boolean metricsEnabled)

Specifies whether Amazon CloudWatch metrics are enabled for this method.

Default: false

Parameters:

metricsEnabled - Specifies whether Amazon CloudWatch metrics are enabled for this method. This parameter is required.

Returns:

this

throttlingBurstLimit

public Stage.Builder throttlingBurstLimit(java.lang.Number throttlingBurstLimit)

Specifies the throttling burst limit.

The total rate of all requests in your AWS account is limited to 5,000 requests.

Default: - No additional restriction.

Parameters:

throttlingBurstLimit - Specifies the throttling burst limit. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html

throttlingRateLimit

public Stage.Builder throttlingRateLimit(java.lang.Number throttlingRateLimit)

Specifies the throttling rate limit.

The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).

Default: - No additional restriction.

Parameters:

throttlingRateLimit - Specifies the throttling rate limit. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html

accessLogDestination

public Stage.Builder accessLogDestination(IAccessLogDestination accessLogDestination)

The CloudWatch Logs log group.

Default: - No destination

Parameters:

accessLogDestination - The CloudWatch Logs log group. This parameter is required.

Returns:

this

accessLogFormat

public Stage.Builder accessLogFormat(AccessLogFormat accessLogFormat)

A single line format of access logs of data, as specified by selected $content variables.

The format must include at least AccessLogFormat.contextRequestId().

Default: - Common Log Format

Parameters:

accessLogFormat - A single line format of access logs of data, as specified by selected $content variables. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference

cacheClusterEnabled

public Stage.Builder cacheClusterEnabled(java.lang.Boolean cacheClusterEnabled)

Indicates whether cache clustering is enabled for the stage.

Default: - Disabled for the stage.

Parameters:

cacheClusterEnabled - Indicates whether cache clustering is enabled for the stage. This parameter is required.

Returns:

this

cacheClusterSize

public Stage.Builder cacheClusterSize(java.lang.String cacheClusterSize)

The stage's cache cluster size.

Default: 0.5

Parameters:

cacheClusterSize - The stage's cache cluster size. This parameter is required.

Returns:

this

clientCertificateId

public Stage.Builder clientCertificateId(java.lang.String clientCertificateId)

The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.

Default: - None.

Parameters:

clientCertificateId - The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage. This parameter is required.

Returns:

this

description

public Stage.Builder description(java.lang.String description)

A description of the purpose of the stage.

Default: - No description.

Parameters:

description - A description of the purpose of the stage. This parameter is required.

Returns:

this

documentationVersion

public Stage.Builder documentationVersion(java.lang.String documentationVersion)

The version identifier of the API documentation snapshot.

Default: - No documentation version.

Parameters:

documentationVersion - The version identifier of the API documentation snapshot. This parameter is required.

Returns:

this

methodOptions

public Stage.Builder methodOptions(java.util.Map<java.lang.String,? extends MethodDeploymentOptions> methodOptions)

Method deployment options for specific resources/methods.

These will override common options defined in StageOptions#methodOptions.

Default: - Common options will be used.

Parameters:

methodOptions - Method deployment options for specific resources/methods. This parameter is required.

Returns:

this

stageName

public Stage.Builder stageName(java.lang.String stageName)

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

Default: - "prod"

Parameters:

stageName - The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI). This parameter is required.

Returns:

this

tracingEnabled

public Stage.Builder tracingEnabled(java.lang.Boolean tracingEnabled)

Specifies whether Amazon X-Ray tracing is enabled for this method.

Default: false

Parameters:

tracingEnabled - Specifies whether Amazon X-Ray tracing is enabled for this method. This parameter is required.

Returns:

this

variables

public Stage.Builder variables(java.util.Map<java.lang.String,java.lang.String> variables)

A map that defines the stage variables.

Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

Default: - No stage variables.

Parameters:

variables - A map that defines the stage variables. This parameter is required.

Returns:

this

deployment

public Stage.Builder deployment(Deployment deployment)

The deployment that this stage points to [disable-awslint:ref-via-interface].

Parameters:

deployment - The deployment that this stage points to [disable-awslint:ref-via-interface]. This parameter is required.

Returns:

this

build

public Stage build()