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.

CreateUsagePlanInput

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

type CreateUsagePlanInput struct { ApiStages []*ApiStage `locationName:"apiStages" type:"list"` Description *string `locationName:"description" type:"string"` Name *string `locationName:"name" type:"string" required:"true"` Quota *QuotaSettings `locationName:"quota" type:"structure"` Throttle *ThrottleSettings `locationName:"throttle" type:"structure"` }

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

ApiStages

API stage name of the associated API stage in a usage plan.

Description

Type: *string

The description of the usage plan.

Name

Type: *string

[Required] The name of the usage plan.

Name is a required field

Quota

Quotas configured for a usage plan.

Throttle

The API request rate limits.

Method

GoString

func (s CreateUsagePlanInput) GoString() string

GoString returns the string representation

SetApiStages

func (s *CreateUsagePlanInput) SetApiStages(v []*ApiStage) *CreateUsagePlanInput

SetApiStages sets the ApiStages field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetName

func (s *CreateUsagePlanInput) SetName(v string) *CreateUsagePlanInput

SetName sets the Name field's value.

SetQuota

func (s *CreateUsagePlanInput) SetQuota(v *QuotaSettings) *CreateUsagePlanInput

SetQuota sets the Quota field's value.

SetThrottle

func (s *CreateUsagePlanInput) SetThrottle(v *ThrottleSettings) *CreateUsagePlanInput

SetThrottle sets the Throttle field's value.

String

func (s CreateUsagePlanInput) String() string

String returns the string representation

Validate

func (s *CreateUsagePlanInput) Validate() error

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

On this page: