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(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDeployment.DeploymentCanarySettingsProperty.Builder	builder()
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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

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.

builder

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

Returns:

a CfnDeployment.DeploymentCanarySettingsProperty.Builder of CfnDeployment.DeploymentCanarySettingsProperty