software.amazon.awssdk.services.apigateway.model

Interface CanarySettings.Builder

All Superinterfaces:

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

Enclosing class:

CanarySettings

public static interface CanarySettings.Builder
extends SdkPojo, CopyableBuilder<CanarySettings.Builder,CanarySettings>

Method Summary

Modifier and Type	Method and Description
CanarySettings.Builder	deploymentId(String deploymentId) The ID of the canary deployment.
CanarySettings.Builder	percentTraffic(Double percentTraffic) The percent (0-100) of traffic diverted to a canary deployment.
CanarySettings.Builder	stageVariableOverrides(Map<String,String> stageVariableOverrides) Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
CanarySettings.Builder	useStageCache(Boolean useStageCache) A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

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

sdkFields

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

copy

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

applyMutation, build

Method Detail

percentTraffic

CanarySettings.Builder percentTraffic(Double percentTraffic)

The percent (0-100) of traffic diverted to a canary deployment.

Parameters:

percentTraffic - The percent (0-100) of traffic diverted to a canary deployment.

Returns:

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

deploymentId

CanarySettings.Builder deploymentId(String deploymentId)

The ID of the canary deployment.

Parameters:

deploymentId - The ID of the canary deployment.

Returns:

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

stageVariableOverrides

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

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

Parameters:

stageVariableOverrides - Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

Returns:

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

useStageCache

CanarySettings.Builder useStageCache(Boolean useStageCache)

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

Parameters:

useStageCache - A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

Returns:

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