software.amazon.awscdk.services.apigateway

Interface CfnStage.CanarySettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStage.CanarySettingProperty.Jsii$Proxy

Enclosing class:

CfnStage

@Stability(value=Stable)
public static interface CfnStage.CanarySettingProperty
extends software.amazon.jsii.JsiiSerializable

The `CanarySetting` property type specifies settings for the canary deployment in this stage.

CanarySetting is a property of the AWS::ApiGateway::Stage resource.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CanarySettingProperty canarySettingProperty = CanarySettingProperty.builder()
         .deploymentId("deploymentId")
         .percentTraffic(123)
         .stageVariableOverrides(Map.of(
                 "stageVariableOverridesKey", "stageVariableOverrides"))
         .useStageCache(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnStage.CanarySettingProperty.Builder A builder for CfnStage.CanarySettingProperty
static class	CfnStage.CanarySettingProperty.Jsii$Proxy An implementation for CfnStage.CanarySettingProperty

Method Summary

Modifier and Type	Method and Description
static CfnStage.CanarySettingProperty.Builder	builder()
default String	getDeploymentId() The identifier of the deployment that the stage points to.
default Number	getPercentTraffic() The percentage (0-100) of traffic diverted to a canary deployment.
default Object	getStageVariableOverrides() Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
default Object	getUseStageCache() Whether the canary deployment uses the stage cache or not.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeploymentId

@Stability(value=Stable)
 @Nullable
default String getDeploymentId()

The identifier of the deployment that the stage points to.

getPercentTraffic

@Stability(value=Stable)
 @Nullable
default Number getPercentTraffic()

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

getStageVariableOverrides

@Stability(value=Stable)
 @Nullable
default Object getStageVariableOverrides()

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.

Duplicates are not allowed.

getUseStageCache

@Stability(value=Stable)
 @Nullable
default Object getUseStageCache()

Whether the canary deployment uses the stage cache or not.

builder

@Stability(value=Stable)
static CfnStage.CanarySettingProperty.Builder builder()

Returns:

a CfnStage.CanarySettingProperty.Builder of CfnStage.CanarySettingProperty