Interface AwsApiGatewayCanarySettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AwsApiGatewayCanarySettings.Builder,AwsApiGatewayCanarySettings>, SdkBuilder<AwsApiGatewayCanarySettings.Builder,AwsApiGatewayCanarySettings>, SdkPojo

Enclosing class:

AwsApiGatewayCanarySettings

@Mutable
@NotThreadSafe
public static interface AwsApiGatewayCanarySettings.Builder
extends SdkPojo, CopyableBuilder<AwsApiGatewayCanarySettings.Builder,AwsApiGatewayCanarySettings>

Method Summary

Modifier and Type	Method	Description
AwsApiGatewayCanarySettings.Builder	deploymentId(String deploymentId)	The deployment identifier for the canary deployment.
AwsApiGatewayCanarySettings.Builder	percentTraffic(Double percentTraffic)	The percentage of traffic that is diverted to a canary deployment.
AwsApiGatewayCanarySettings.Builder	stageVariableOverrides(Map<String,String> stageVariableOverrides)	Stage variables that are overridden in the canary release deployment.
AwsApiGatewayCanarySettings.Builder	useStageCache(Boolean useStageCache)	Indicates whether the canary deployment uses the stage cache.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

percentTraffic

AwsApiGatewayCanarySettings.Builder percentTraffic(Double percentTraffic)

The percentage of traffic that is diverted to a canary deployment.

Parameters:

percentTraffic - The percentage of traffic that is diverted to a canary deployment.

Returns:

Returns a reference to this object so that method calls can be chained together.

deploymentId

AwsApiGatewayCanarySettings.Builder deploymentId(String deploymentId)

The deployment identifier for the canary deployment.

Parameters:

deploymentId - The deployment identifier for the canary deployment.

Returns:

Returns a reference to this object so that method calls can be chained together.

stageVariableOverrides

AwsApiGatewayCanarySettings.Builder stageVariableOverrides(Map<String,String> stageVariableOverrides)

Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

Parameters:

stageVariableOverrides - Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

Returns:

Returns a reference to this object so that method calls can be chained together.

useStageCache

AwsApiGatewayCanarySettings.Builder useStageCache(Boolean useStageCache)

Indicates whether the canary deployment uses the stage cache.

Parameters:

useStageCache - Indicates whether the canary deployment uses the stage cache.

Returns:

Returns a reference to this object so that method calls can be chained together.