software.amazon.awscdk.services.apigateway

Class CfnStageProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnStageProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStageProps>

Enclosing interface:

CfnStageProps

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

A builder for CfnStageProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnStageProps.Builder	accessLogSetting(CfnStage.AccessLogSettingProperty accessLogSetting) Sets the value of CfnStageProps.getAccessLogSetting()
CfnStageProps.Builder	accessLogSetting(IResolvable accessLogSetting) Sets the value of CfnStageProps.getAccessLogSetting()
CfnStageProps	build() Builds the configured instance.
CfnStageProps.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled) Sets the value of CfnStageProps.getCacheClusterEnabled()
CfnStageProps.Builder	cacheClusterEnabled(IResolvable cacheClusterEnabled) Sets the value of CfnStageProps.getCacheClusterEnabled()
CfnStageProps.Builder	cacheClusterSize(String cacheClusterSize) Sets the value of CfnStageProps.getCacheClusterSize()
CfnStageProps.Builder	canarySetting(CfnStage.CanarySettingProperty canarySetting) Sets the value of CfnStageProps.getCanarySetting()
CfnStageProps.Builder	canarySetting(IResolvable canarySetting) Sets the value of CfnStageProps.getCanarySetting()
CfnStageProps.Builder	clientCertificateId(String clientCertificateId) Sets the value of CfnStageProps.getClientCertificateId()
CfnStageProps.Builder	deploymentId(String deploymentId) Sets the value of CfnStageProps.getDeploymentId()
CfnStageProps.Builder	description(String description) Sets the value of CfnStageProps.getDescription()
CfnStageProps.Builder	documentationVersion(String documentationVersion) Sets the value of CfnStageProps.getDocumentationVersion()
CfnStageProps.Builder	methodSettings(IResolvable methodSettings) Sets the value of CfnStageProps.getMethodSettings()
CfnStageProps.Builder	methodSettings(List<? extends Object> methodSettings) Sets the value of CfnStageProps.getMethodSettings()
CfnStageProps.Builder	restApiId(String restApiId) Sets the value of CfnStageProps.getRestApiId()
CfnStageProps.Builder	stageName(String stageName) Sets the value of CfnStageProps.getStageName()
CfnStageProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnStageProps.getTags()
CfnStageProps.Builder	tracingEnabled(Boolean tracingEnabled) Sets the value of CfnStageProps.getTracingEnabled()
CfnStageProps.Builder	tracingEnabled(IResolvable tracingEnabled) Sets the value of CfnStageProps.getTracingEnabled()
CfnStageProps.Builder	variables(IResolvable variables) Sets the value of CfnStageProps.getVariables()
CfnStageProps.Builder	variables(Map<String,String> variables) Sets the value of CfnStageProps.getVariables()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

restApiId

@Stability(value=Stable)
public CfnStageProps.Builder restApiId(String restApiId)

Sets the value of CfnStageProps.getRestApiId()

Parameters:

restApiId - The ID of the `RestApi` resource that you're deploying with this stage. This parameter is required.

Returns:

this

accessLogSetting

@Stability(value=Stable)
public CfnStageProps.Builder accessLogSetting(CfnStage.AccessLogSettingProperty accessLogSetting)

Sets the value of CfnStageProps.getAccessLogSetting()

Parameters:

accessLogSetting - Specifies settings for logging access in this stage.

Returns:

this

accessLogSetting

@Stability(value=Stable)
public CfnStageProps.Builder accessLogSetting(IResolvable accessLogSetting)

Sets the value of CfnStageProps.getAccessLogSetting()

Parameters:

accessLogSetting - Specifies settings for logging access in this stage.

Returns:

this

cacheClusterEnabled

@Stability(value=Stable)
public CfnStageProps.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)

Sets the value of CfnStageProps.getCacheClusterEnabled()

Parameters:

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

Returns:

this

cacheClusterEnabled

@Stability(value=Stable)
public CfnStageProps.Builder cacheClusterEnabled(IResolvable cacheClusterEnabled)

Sets the value of CfnStageProps.getCacheClusterEnabled()

Parameters:

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

Returns:

this

cacheClusterSize

@Stability(value=Stable)
public CfnStageProps.Builder cacheClusterSize(String cacheClusterSize)

Sets the value of CfnStageProps.getCacheClusterSize()

Parameters:

cacheClusterSize - The stage's cache cluster size.

Returns:

this

canarySetting

@Stability(value=Stable)
public CfnStageProps.Builder canarySetting(CfnStage.CanarySettingProperty canarySetting)

Sets the value of CfnStageProps.getCanarySetting()

Parameters:

canarySetting - Specifies settings for the canary deployment in this stage.

Returns:

this

canarySetting

@Stability(value=Stable)
public CfnStageProps.Builder canarySetting(IResolvable canarySetting)

Sets the value of CfnStageProps.getCanarySetting()

Parameters:

canarySetting - Specifies settings for the canary deployment in this stage.

Returns:

this

clientCertificateId

@Stability(value=Stable)
public CfnStageProps.Builder clientCertificateId(String clientCertificateId)

Sets the value of CfnStageProps.getClientCertificateId()

Parameters:

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

Returns:

this

deploymentId

@Stability(value=Stable)
public CfnStageProps.Builder deploymentId(String deploymentId)

Sets the value of CfnStageProps.getDeploymentId()

Parameters:

deploymentId - The ID of the deployment that the stage is associated with. This parameter is required to create a stage.

Returns:

this

description

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

Sets the value of CfnStageProps.getDescription()

Parameters:

description - A description of the stage.

Returns:

this

documentationVersion

@Stability(value=Stable)
public CfnStageProps.Builder documentationVersion(String documentationVersion)

Sets the value of CfnStageProps.getDocumentationVersion()

Parameters:

documentationVersion - The version ID of the API documentation snapshot.

Returns:

this

methodSettings

@Stability(value=Stable)
public CfnStageProps.Builder methodSettings(IResolvable methodSettings)

Sets the value of CfnStageProps.getMethodSettings()

Parameters:

methodSettings - Settings for all methods in the stage.

Returns:

this

methodSettings

@Stability(value=Stable)
public CfnStageProps.Builder methodSettings(List<? extends Object> methodSettings)

Sets the value of CfnStageProps.getMethodSettings()

Parameters:

methodSettings - Settings for all methods in the stage.

Returns:

this

stageName

@Stability(value=Stable)
public CfnStageProps.Builder stageName(String stageName)

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

tags

@Stability(value=Stable)
public CfnStageProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnStageProps.getTags()

Parameters:

tags - An array of arbitrary tags (key-value pairs) to associate with the stage.

Returns:

this

tracingEnabled

@Stability(value=Stable)
public CfnStageProps.Builder tracingEnabled(Boolean tracingEnabled)

Sets the value of CfnStageProps.getTracingEnabled()

Parameters:

tracingEnabled - Specifies whether active X-Ray tracing is enabled for this stage. For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .

Returns:

this

tracingEnabled

@Stability(value=Stable)
public CfnStageProps.Builder tracingEnabled(IResolvable tracingEnabled)

Sets the value of CfnStageProps.getTracingEnabled()

Parameters:

tracingEnabled - Specifies whether active X-Ray tracing is enabled for this stage. For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .

Returns:

this

variables

@Stability(value=Stable)
public CfnStageProps.Builder variables(IResolvable variables)

Sets the value of CfnStageProps.getVariables()

Parameters:

variables - A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

Returns:

this

variables

@Stability(value=Stable)
public CfnStageProps.Builder variables(Map<String,String> variables)

Sets the value of CfnStageProps.getVariables()

Parameters:

variables - A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnStageProps

Throws:

NullPointerException - if any required attribute was not provided