Package software.amazon.awscdk.services.apigateway

Class StageProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.StageProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StageProps>

Enclosing interface:

StageProps

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

A builder for StageProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StageProps.Builder	accessLogDestination(IAccessLogDestination accessLogDestination)	Sets the value of StageOptions.getAccessLogDestination()
StageProps.Builder	accessLogFormat(AccessLogFormat accessLogFormat)	Sets the value of StageOptions.getAccessLogFormat()
StageProps	build()	Builds the configured instance.
StageProps.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled)	Sets the value of StageOptions.getCacheClusterEnabled()
StageProps.Builder	cacheClusterSize(String cacheClusterSize)	Sets the value of StageOptions.getCacheClusterSize()
StageProps.Builder	cacheDataEncrypted(Boolean cacheDataEncrypted)	Sets the value of MethodDeploymentOptions.getCacheDataEncrypted()
StageProps.Builder	cacheTtl(Duration cacheTtl)	Sets the value of MethodDeploymentOptions.getCacheTtl()
StageProps.Builder	cachingEnabled(Boolean cachingEnabled)	Sets the value of MethodDeploymentOptions.getCachingEnabled()
StageProps.Builder	clientCertificateId(String clientCertificateId)	Sets the value of StageOptions.getClientCertificateId()
StageProps.Builder	dataTraceEnabled(Boolean dataTraceEnabled)	Sets the value of MethodDeploymentOptions.getDataTraceEnabled()
StageProps.Builder	deployment(Deployment deployment)	Sets the value of StageProps.getDeployment()
StageProps.Builder	description(String description)	Sets the value of StageOptions.getDescription()
StageProps.Builder	documentationVersion(String documentationVersion)	Sets the value of StageOptions.getDocumentationVersion()
StageProps.Builder	loggingLevel(MethodLoggingLevel loggingLevel)	Sets the value of MethodDeploymentOptions.getLoggingLevel()
StageProps.Builder	methodOptions(Map<String,? extends MethodDeploymentOptions> methodOptions)	Sets the value of StageOptions.getMethodOptions()
StageProps.Builder	metricsEnabled(Boolean metricsEnabled)	Sets the value of MethodDeploymentOptions.getMetricsEnabled()
StageProps.Builder	stageName(String stageName)	Sets the value of StageOptions.getStageName()
StageProps.Builder	throttlingBurstLimit(Number throttlingBurstLimit)	Sets the value of MethodDeploymentOptions.getThrottlingBurstLimit()
StageProps.Builder	throttlingRateLimit(Number throttlingRateLimit)	Sets the value of MethodDeploymentOptions.getThrottlingRateLimit()
StageProps.Builder	tracingEnabled(Boolean tracingEnabled)	Sets the value of StageOptions.getTracingEnabled()
StageProps.Builder	variables(Map<String,String> variables)	Sets the value of StageOptions.getVariables()

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

deployment

@Stability(Stable)
public StageProps.Builder deployment(Deployment deployment)

Sets the value of StageProps.getDeployment()

Parameters:

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

Returns:

this

accessLogDestination

@Stability(Stable)
public StageProps.Builder accessLogDestination(IAccessLogDestination accessLogDestination)

Sets the value of StageOptions.getAccessLogDestination()

Parameters:

accessLogDestination - The CloudWatch Logs log group or Firehose delivery stream where to write access logs.

Returns:

this

accessLogFormat

@Stability(Stable)
public StageProps.Builder accessLogFormat(AccessLogFormat accessLogFormat)

Sets the value of StageOptions.getAccessLogFormat()

Parameters:

accessLogFormat - A single line format of access logs of data, as specified by selected $content variables. The format must include either AccessLogFormat.contextRequestId() or AccessLogFormat.contextExtendedRequestId().

Returns:

this

cacheClusterEnabled

@Stability(Stable)
public StageProps.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)

Sets the value of StageOptions.getCacheClusterEnabled()

Parameters:

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

Returns:

this

cacheClusterSize

@Stability(Stable)
public StageProps.Builder cacheClusterSize(String cacheClusterSize)

Sets the value of StageOptions.getCacheClusterSize()

Parameters:

cacheClusterSize - The stage's cache cluster size.

Returns:

this

clientCertificateId

@Stability(Stable)
public StageProps.Builder clientCertificateId(String clientCertificateId)

Sets the value of StageOptions.getClientCertificateId()

Parameters:

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

Returns:

this

description

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

Sets the value of StageOptions.getDescription()

Parameters:

description - A description of the purpose of the stage.

Returns:

this

documentationVersion

@Stability(Stable)
public StageProps.Builder documentationVersion(String documentationVersion)

Sets the value of StageOptions.getDocumentationVersion()

Parameters:

documentationVersion - The version identifier of the API documentation snapshot.

Returns:

this

methodOptions

@Stability(Stable)
public StageProps.Builder methodOptions(Map<String,? extends MethodDeploymentOptions> methodOptions)

Sets the value of StageOptions.getMethodOptions()

Parameters:

methodOptions - Method deployment options for specific resources/methods. These will override common options defined in StageOptions#methodOptions.

Returns:

this

stageName

@Stability(Stable)
public StageProps.Builder stageName(String stageName)

Sets the value of StageOptions.getStageName()

Parameters:

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

Returns:

this

tracingEnabled

@Stability(Stable)
public StageProps.Builder tracingEnabled(Boolean tracingEnabled)

Sets the value of StageOptions.getTracingEnabled()

Parameters:

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

Returns:

this

variables

@Stability(Stable)
public StageProps.Builder variables(Map<String,String> variables)

Sets the value of StageOptions.getVariables()

Parameters:

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-._~:/?#&=,]+.

Returns:

this

cacheDataEncrypted

@Stability(Stable)
public StageProps.Builder cacheDataEncrypted(Boolean cacheDataEncrypted)

Sets the value of MethodDeploymentOptions.getCacheDataEncrypted()

Parameters:

cacheDataEncrypted - Indicates whether the cached responses are encrypted.

Returns:

this

cacheTtl

@Stability(Stable)
public StageProps.Builder cacheTtl(Duration cacheTtl)

Sets the value of MethodDeploymentOptions.getCacheTtl()

Parameters:

cacheTtl - Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.

Returns:

this

cachingEnabled

@Stability(Stable)
public StageProps.Builder cachingEnabled(Boolean cachingEnabled)

Sets the value of MethodDeploymentOptions.getCachingEnabled()

Parameters:

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.

Returns:

this

dataTraceEnabled

@Stability(Stable)
public StageProps.Builder dataTraceEnabled(Boolean dataTraceEnabled)

Sets the value of MethodDeploymentOptions.getDataTraceEnabled()

Parameters:

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.

Returns:

this

loggingLevel

@Stability(Stable)
public StageProps.Builder loggingLevel(MethodLoggingLevel loggingLevel)

Sets the value of MethodDeploymentOptions.getLoggingLevel()

Parameters:

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

Returns:

this

metricsEnabled

@Stability(Stable)
public StageProps.Builder metricsEnabled(Boolean metricsEnabled)

Sets the value of MethodDeploymentOptions.getMetricsEnabled()

Parameters:

metricsEnabled - Specifies whether Amazon CloudWatch metrics are enabled for this method.

Returns:

this

throttlingBurstLimit

@Stability(Stable)
public StageProps.Builder throttlingBurstLimit(Number throttlingBurstLimit)

Sets the value of MethodDeploymentOptions.getThrottlingBurstLimit()

Parameters:

throttlingBurstLimit - Specifies the throttling burst limit. The total rate of all requests in your AWS account is limited to 5,000 requests.

Returns:

this

throttlingRateLimit

@Stability(Stable)
public StageProps.Builder throttlingRateLimit(Number throttlingRateLimit)

Sets the value of MethodDeploymentOptions.getThrottlingRateLimit()

Parameters:

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).

Returns:

this

build

@Stability(Stable)
public StageProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StageProps

Throws:

NullPointerException - if any required attribute was not provided