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.

CreateApiKeyInput

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

type CreateApiKeyInput struct { CustomerId *string `locationName:"customerId" type:"string"` Description *string `locationName:"description" type:"string"` Enabled *bool `locationName:"enabled" type:"boolean"` GenerateDistinctId *bool `locationName:"generateDistinctId" type:"boolean"` Name *string `locationName:"name" type:"string"` StageKeys []*StageKey `locationName:"stageKeys" type:"list"` Value *string `locationName:"value" type:"string"` }

Request to create an ApiKey resource.

CustomerId

Type: *string

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Description

Type: *string

The description of the ApiKey.

Enabled

Type: *bool

Specifies whether the ApiKey can be used by callers.

GenerateDistinctId

Type: *bool

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

Name

Type: *string

The name of the ApiKey.

StageKeys

A reference to a unique stage identified in the format {restApiId}/{stage}.

Value

Type: *string

Specifies a value of the API key.

Method

GoString

func (s CreateApiKeyInput) GoString() string

GoString returns the string representation

SetCustomerId

func (s *CreateApiKeyInput) SetCustomerId(v string) *CreateApiKeyInput

SetCustomerId sets the CustomerId field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetEnabled

func (s *CreateApiKeyInput) SetEnabled(v bool) *CreateApiKeyInput

SetEnabled sets the Enabled field's value.

SetGenerateDistinctId

func (s *CreateApiKeyInput) SetGenerateDistinctId(v bool) *CreateApiKeyInput

SetGenerateDistinctId sets the GenerateDistinctId field's value.

SetName

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

SetName sets the Name field's value.

SetStageKeys

func (s *CreateApiKeyInput) SetStageKeys(v []*StageKey) *CreateApiKeyInput

SetStageKeys sets the StageKeys field's value.

SetValue

func (s *CreateApiKeyInput) SetValue(v string) *CreateApiKeyInput

SetValue sets the Value field's value.

String

func (s CreateApiKeyInput) String() string

String returns the string representation

On this page: