Package software.amazon.awscdk.services.apigateway

Interface CfnDeployment.CanarySettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.CanarySettingProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

@Stability(Stable)
public static interface CfnDeployment.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 StageDescription property type.

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()
         .percentTraffic(123)
         .stageVariableOverrides(Map.of(
                 "stageVariableOverridesKey", "stageVariableOverrides"))
         .useStageCache(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeployment.CanarySettingProperty.Builder	builder()
default Number	getPercentTraffic()	The percent (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()	A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPercentTraffic

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-percenttraffic

getStageVariableOverrides

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-stagevariableoverrides

getUseStageCache

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-usestagecache

builder

@Stability(Stable)
static CfnDeployment.CanarySettingProperty.Builder builder()

Returns:

a CfnDeployment.CanarySettingProperty.Builder of CfnDeployment.CanarySettingProperty