Package software.amazon.awscdk.services.apigateway

Interface CfnDeployment.DeploymentCanarySettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.DeploymentCanarySettingsProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

@Stability(Stable)
public static interface CfnDeployment.DeploymentCanarySettingsProperty
extends software.amazon.jsii.JsiiSerializable

The DeploymentCanarySettings property type specifies settings for the canary deployment.

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.*;
 DeploymentCanarySettingsProperty deploymentCanarySettingsProperty = DeploymentCanarySettingsProperty.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-deploymentcanarysettings.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeployment.DeploymentCanarySettingsProperty.Builder	builder()
default Number	getPercentTraffic()	The percentage (0.0-100.0) of traffic routed to the canary deployment.
default Object	getStageVariableOverrides()	A stage variable overrides used for the canary release deployment.
default Object	getUseStageCache()	A Boolean flag to indicate whether the canary release 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 percentage (0.0-100.0) of traffic routed to the canary deployment.

See Also:

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

getStageVariableOverrides

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

A stage variable overrides used for the canary release deployment.

They can override existing stage variables or add new stage variables for the canary release deployment. 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-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-stagevariableoverrides

getUseStageCache

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

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

See Also:

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

builder

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

Returns:

a CfnDeployment.DeploymentCanarySettingsProperty.Builder of CfnDeployment.DeploymentCanarySettingsProperty