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.

CreateDeploymentInput

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

type CreateDeploymentInput struct { CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` CacheClusterSize *string `locationName:"cacheClusterSize" type:"string" enum:"CacheClusterSize"` CanarySettings *DeploymentCanarySettings `locationName:"canarySettings" type:"structure"` Description *string `locationName:"description" type:"string"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` StageDescription *string `locationName:"stageDescription" type:"string"` StageName *string `locationName:"stageName" type:"string"` TracingEnabled *bool `locationName:"tracingEnabled" type:"boolean"` Variables map[string]*string `locationName:"variables" type:"map"` }

Requests API Gateway to create a Deployment resource.

CacheClusterEnabled

Type: *bool

Enables a cache cluster for the Stage resource specified in the input.

CacheClusterSize

Type: *string

Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

CanarySettings

The input configuration for a canary deployment.

Description

Type: *string

The description for the Deployment resource to create.

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

StageDescription

Type: *string

The description of the Stage resource for the Deployment resource to create.

StageName

Type: *string

The name of the Stage resource for the Deployment resource to create.

TracingEnabled

Type: *bool

Specifies whether active tracing with X-ray is enabled for the Stage.

Variables

Type: map[string]*string

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Method

GoString

func (s CreateDeploymentInput) GoString() string

GoString returns the string representation

SetCacheClusterEnabled

func (s *CreateDeploymentInput) SetCacheClusterEnabled(v bool) *CreateDeploymentInput

SetCacheClusterEnabled sets the CacheClusterEnabled field's value.

SetCacheClusterSize

func (s *CreateDeploymentInput) SetCacheClusterSize(v string) *CreateDeploymentInput

SetCacheClusterSize sets the CacheClusterSize field's value.

SetCanarySettings

func (s *CreateDeploymentInput) SetCanarySettings(v *DeploymentCanarySettings) *CreateDeploymentInput

SetCanarySettings sets the CanarySettings field's value.

SetDescription

func (s *CreateDeploymentInput) SetDescription(v string) *CreateDeploymentInput

SetDescription sets the Description field's value.

SetRestApiId

func (s *CreateDeploymentInput) SetRestApiId(v string) *CreateDeploymentInput

SetRestApiId sets the RestApiId field's value.

SetStageDescription

func (s *CreateDeploymentInput) SetStageDescription(v string) *CreateDeploymentInput

SetStageDescription sets the StageDescription field's value.

SetStageName

func (s *CreateDeploymentInput) SetStageName(v string) *CreateDeploymentInput

SetStageName sets the StageName field's value.

SetTracingEnabled

func (s *CreateDeploymentInput) SetTracingEnabled(v bool) *CreateDeploymentInput

SetTracingEnabled sets the TracingEnabled field's value.

SetVariables

func (s *CreateDeploymentInput) SetVariables(v map[string]*string) *CreateDeploymentInput

SetVariables sets the Variables field's value.

String

func (s CreateDeploymentInput) String() string

String returns the string representation

Validate

func (s *CreateDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: