Add-VSApiGatewayDeploymentCanarySetting
Add-VSApiGatewayDeploymentCanarySetting
SYNOPSIS
Adds an AWS::ApiGateway::Deployment.CanarySetting resource property to the template. The CanarySetting property type specifies settings for the canary deployment in this stage.
SYNTAX
Add-VSApiGatewayDeploymentCanarySetting [[-PercentTraffic] <Object>] [[-StageVariableOverrides] <Hashtable>]
[[-UseStageCache] <Object>] [<CommonParameters>]
DESCRIPTION
Adds an AWS::ApiGateway::Deployment.CanarySetting resource property to the template. The CanarySetting property type specifies settings for the canary deployment in this stage.
CanarySetting is a property of the StageDescription: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html property type.
PARAMETERS
-PercentTraffic
The percent 0-100 of traffic diverted to a canary deployment.
Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-percenttraffic PrimitiveType: Double UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StageVariableOverrides
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.
Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-stagevariableoverrides DuplicatesAllowed: False PrimitiveItemType: String Type: Map UpdateType: Mutable
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UseStageCache
Whether the canary deployment uses the stage cache or not.
Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-usestagecache PrimitiveType: Boolean UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.