AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CanarySettings

import "github.com/aws/aws-sdk-go/service/apigateway"

type CanarySettings struct { DeploymentId *string `locationName:"deploymentId" type:"string"` PercentTraffic *float64 `locationName:"percentTraffic" type:"double"` StageVariableOverrides map[string]*string `locationName:"stageVariableOverrides" type:"map"` UseStageCache *bool `locationName:"useStageCache" type:"boolean"` }

Configuration settings of a canary deployment.

DeploymentId

Type: *string

The ID of the canary deployment.

PercentTraffic

Type: *float64

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

StageVariableOverrides

Type: map[string]*string

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.

UseStageCache

Type: *bool

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

Method

GoString

func (s CanarySettings) GoString() string

GoString returns the string representation

SetDeploymentId

func (s *CanarySettings) SetDeploymentId(v string) *CanarySettings

SetDeploymentId sets the DeploymentId field's value.

SetPercentTraffic

func (s *CanarySettings) SetPercentTraffic(v float64) *CanarySettings

SetPercentTraffic sets the PercentTraffic field's value.

SetStageVariableOverrides

func (s *CanarySettings) SetStageVariableOverrides(v map[string]*string) *CanarySettings

SetStageVariableOverrides sets the StageVariableOverrides field's value.

SetUseStageCache

func (s *CanarySettings) SetUseStageCache(v bool) *CanarySettings

SetUseStageCache sets the UseStageCache field's value.

String

func (s CanarySettings) String() string

String returns the string representation

On this page: