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.

CreateBasePathMappingInput

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

type CreateBasePathMappingInput struct { BasePath *string `locationName:"basePath" type:"string"` DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` RestApiId *string `locationName:"restApiId" type:"string" required:"true"` Stage *string `locationName:"stage" type:"string"` }

Requests API Gateway to create a new BasePathMapping resource.

BasePath

Type: *string

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.

DomainName

Type: *string

[Required] The domain name of the BasePathMapping resource to create.

DomainName is a required field

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

Stage

Type: *string

The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.

Method

GoString

func (s CreateBasePathMappingInput) GoString() string

GoString returns the string representation

SetBasePath

func (s *CreateBasePathMappingInput) SetBasePath(v string) *CreateBasePathMappingInput

SetBasePath sets the BasePath field's value.

SetDomainName

func (s *CreateBasePathMappingInput) SetDomainName(v string) *CreateBasePathMappingInput

SetDomainName sets the DomainName field's value.

SetRestApiId

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

SetRestApiId sets the RestApiId field's value.

SetStage

func (s *CreateBasePathMappingInput) SetStage(v string) *CreateBasePathMappingInput

SetStage sets the Stage field's value.

String

func (s CreateBasePathMappingInput) String() string

String returns the string representation

Validate

func (s *CreateBasePathMappingInput) Validate() error

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

On this page: