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.

CreateStageInput

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

type CreateStageInput struct { CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` CacheClusterSize *string `locationName:"cacheClusterSize" type:"string" enum:"CacheClusterSize"` CanarySettings *CanarySettings `locationName:"canarySettings" type:"structure"` DeploymentId *string `locationName:"deploymentId" type:"string" required:"true"` Description *string `locationName:"description" type:"string"` DocumentationVersion *string `locationName:"documentationVersion" type:"string"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` StageName *string `locationName:"stageName" type:"string" required:"true"` Tags map[string]*string `locationName:"tags" type:"map"` TracingEnabled *bool `locationName:"tracingEnabled" type:"boolean"` Variables map[string]*string `locationName:"variables" type:"map"` }

Requests API Gateway to create a Stage resource.

CacheClusterEnabled

Type: *bool

Whether cache clustering is enabled for the stage.

CacheClusterSize

Type: *string

The stage's cache cluster size.

CanarySettings

Configuration settings of a canary deployment.

DeploymentId

Type: *string

[Required] The identifier of the Deployment resource for the Stage resource.

DeploymentId is a required field

Description

Type: *string

The description of the Stage resource.

DocumentationVersion

Type: *string

The version of the associated API documentation.

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

StageName

Type: *string

[Required] The name for the Stage resource.

StageName is a required field

Tags

Type: map[string]*string

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

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 new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Method

GoString

func (s CreateStageInput) GoString() string

GoString returns the string representation

SetCacheClusterEnabled

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

SetCacheClusterEnabled sets the CacheClusterEnabled field's value.

SetCacheClusterSize

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

SetCacheClusterSize sets the CacheClusterSize field's value.

SetCanarySettings

func (s *CreateStageInput) SetCanarySettings(v *CanarySettings) *CreateStageInput

SetCanarySettings sets the CanarySettings field's value.

SetDeploymentId

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

SetDeploymentId sets the DeploymentId field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetDocumentationVersion

func (s *CreateStageInput) SetDocumentationVersion(v string) *CreateStageInput

SetDocumentationVersion sets the DocumentationVersion field's value.

SetRestApiId

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

SetRestApiId sets the RestApiId field's value.

SetStageName

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

SetStageName sets the StageName field's value.

SetTags

func (s *CreateStageInput) SetTags(v map[string]*string) *CreateStageInput

SetTags sets the Tags field's value.

SetTracingEnabled

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

SetTracingEnabled sets the TracingEnabled field's value.

SetVariables

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

SetVariables sets the Variables field's value.

String

func (s CreateStageInput) String() string

String returns the string representation

Validate

func (s *CreateStageInput) Validate() error

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

On this page: