Package software.amazon.awscdk.services.sam

Interface CfnApi.CanarySettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApi.CanarySettingProperty.Jsii$Proxy

Enclosing class:

CfnApi

@Stability(Stable)
public static interface CfnApi.CanarySettingProperty
extends software.amazon.jsii.JsiiSerializable

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.sam.*;
 CanarySettingProperty canarySettingProperty = CanarySettingProperty.builder()
         .deploymentId("deploymentId")
         .percentTraffic(123)
         .stageVariableOverrides(Map.of(
                 "stageVariableOverridesKey", "stageVariableOverrides"))
         .useStageCache(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApi.CanarySettingProperty.Builder	builder()
default String	getDeploymentId()
default Number	getPercentTraffic()
default Object	getStageVariableOverrides()	Returns union: either Mapinvalid input: '<'String, String> or IResolvable
default Object	getUseStageCache()	Returns union: either Boolean or IResolvable

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeploymentId

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-canarysetting.html#cfn-serverless-api-canarysetting-deploymentid

getPercentTraffic

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

See Also:

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

getStageVariableOverrides

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

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getUseStageCache

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

Returns union: either Boolean or IResolvable

See Also:

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

builder

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

Returns:

a CfnApi.CanarySettingProperty.Builder of CfnApi.CanarySettingProperty