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.

Stage

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

type Stage struct { AccessLogSettings *AccessLogSettings `locationName:"accessLogSettings" type:"structure"` CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` CacheClusterSize *string `locationName:"cacheClusterSize" type:"string" enum:"CacheClusterSize"` CacheClusterStatus *string `locationName:"cacheClusterStatus" type:"string" enum:"CacheClusterStatus"` CanarySettings *CanarySettings `locationName:"canarySettings" type:"structure"` ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` DeploymentId *string `locationName:"deploymentId" type:"string"` Description *string `locationName:"description" type:"string"` DocumentationVersion *string `locationName:"documentationVersion" type:"string"` LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp"` MethodSettings map[string]*MethodSetting `locationName:"methodSettings" type:"map"` StageName *string `locationName:"stageName" type:"string"` Tags map[string]*string `locationName:"tags" type:"map"` TracingEnabled *bool `locationName:"tracingEnabled" type:"boolean"` Variables map[string]*string `locationName:"variables" type:"map"` WebAclArn *string `locationName:"webAclArn" type:"string"` }

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Deploy an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html)

AccessLogSettings

Access log settings, including the access log format and access log destination ARN.

CacheClusterEnabled

Type: *bool

Specifies whether a cache cluster is enabled for the stage.

CacheClusterSize

Type: *string

The size of the cache cluster for the stage, if enabled.

CacheClusterStatus

Type: *string

The status of the cache cluster for the stage, if enabled.

CanarySettings

Configuration settings of a canary deployment.

ClientCertificateId

Type: *string

The identifier of a client certificate for an API stage.

CreatedDate

Type: *time.Time

The timestamp when the stage was created.

DeploymentId

Type: *string

The identifier of the Deployment that the stage points to.

Description

Type: *string

The stage's description.

DocumentationVersion

Type: *string

The version of the associated API documentation.

LastUpdatedDate

Type: *time.Time

The timestamp when the stage last updated.

MethodSettings

Type: map[string]*MethodSetting

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

StageName

Type: *string

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.

Tags

Type: map[string]*string

The collection of tags. Each tag element is associated with a given resource.

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

WebAclArn

Type: *string

The ARN of the WebAcl associated with the Stage.

Method

GoString

func (s Stage) GoString() string

GoString returns the string representation

SetAccessLogSettings

func (s *Stage) SetAccessLogSettings(v *AccessLogSettings) *Stage

SetAccessLogSettings sets the AccessLogSettings field's value.

SetCacheClusterEnabled

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

SetCacheClusterEnabled sets the CacheClusterEnabled field's value.

SetCacheClusterSize

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

SetCacheClusterSize sets the CacheClusterSize field's value.

SetCacheClusterStatus

func (s *Stage) SetCacheClusterStatus(v string) *Stage

SetCacheClusterStatus sets the CacheClusterStatus field's value.

SetCanarySettings

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

SetCanarySettings sets the CanarySettings field's value.

SetClientCertificateId

func (s *Stage) SetClientCertificateId(v string) *Stage

SetClientCertificateId sets the ClientCertificateId field's value.

SetCreatedDate

func (s *Stage) SetCreatedDate(v time.Time) *Stage

SetCreatedDate sets the CreatedDate field's value.

SetDeploymentId

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

SetDeploymentId sets the DeploymentId field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetDocumentationVersion

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

SetDocumentationVersion sets the DocumentationVersion field's value.

SetLastUpdatedDate

func (s *Stage) SetLastUpdatedDate(v time.Time) *Stage

SetLastUpdatedDate sets the LastUpdatedDate field's value.

SetMethodSettings

func (s *Stage) SetMethodSettings(v map[string]*MethodSetting) *Stage

SetMethodSettings sets the MethodSettings field's value.

SetStageName

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

SetStageName sets the StageName field's value.

SetTags

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

SetTags sets the Tags field's value.

SetTracingEnabled

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

SetTracingEnabled sets the TracingEnabled field's value.

SetVariables

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

SetVariables sets the Variables field's value.

SetWebAclArn

func (s *Stage) SetWebAclArn(v string) *Stage

SetWebAclArn sets the WebAclArn field's value.

String

func (s Stage) String() string

String returns the string representation

On this page: