apigateway

Documentation

Index

• Constants
• type API
  • func (a *API) GetMetadata() *types.Metadata
  • func (a *API) GetRawValue() interface{}
• type APIGateway
• type AccessLogging
• type DomainName
  • func (d *DomainName) GetMetadata() *types.Metadata
  • func (d *DomainName) GetRawValue() interface{}
• type RESTMethod
  • func (m *RESTMethod) GetMetadata() *types.Metadata
  • func (m *RESTMethod) GetRawValue() interface{}
• type RESTMethodSettings
• type Stage
  • func (s *Stage) GetMetadata() *types.Metadata
  • func (s *Stage) GetRawValue() interface{}

Constants

const (
	ProtocolTypeUnknown   string = ""
	ProtocolTypeREST      string = "REST"
	ProtocolTypeHTTP      string = "HTTP"
	ProtocolTypeWebsocket string = "WEBSOCKET"
)

const (
	AuthorizationNone             = "NONE"
	AuthorizationCustom           = "CUSTOM"
	AuthorizationIAM              = "AWS_IAM"
	AuthorizationCognitoUserPools = "COGNITO_USER_POOLS"
)

Types

type API

type API struct {
	types.Metadata
	Name         types.StringValue
	Version      types.IntValue
	ProtocolType types.StringValue
	Stages       []Stage
	RESTMethods  []RESTMethod
}

func (*API) GetMetadata

func (a *API) GetMetadata() *types.Metadata

func (*API) GetRawValue

func (a *API) GetRawValue() interface{}

type APIGateway

type APIGateway struct {
	APIs        []API
	DomainNames []DomainName
}

type AccessLogging

type AccessLogging struct {
	types.Metadata
	CloudwatchLogGroupARN types.StringValue
}

type DomainName

type DomainName struct {
	types.Metadata
	Name           types.StringValue
	Version        types.IntValue
	SecurityPolicy types.StringValue
}

func (*DomainName) GetMetadata

func (d *DomainName) GetMetadata() *types.Metadata

func (*DomainName) GetRawValue

func (d *DomainName) GetRawValue() interface{}

type RESTMethod

type RESTMethod struct {
	types.Metadata
	HTTPMethod        types.StringValue
	AuthorizationType types.StringValue
	APIKeyRequired    types.BoolValue
}

func (*RESTMethod) GetMetadata

func (m *RESTMethod) GetMetadata() *types.Metadata

func (*RESTMethod) GetRawValue

func (m *RESTMethod) GetRawValue() interface{}

type RESTMethodSettings

type RESTMethodSettings struct {
	CacheDataEncrypted types.BoolValue
}

type Stage

type Stage struct {
	types.Metadata
	Name               types.StringValue
	Version            types.IntValue
	AccessLogging      AccessLogging
	RESTMethodSettings RESTMethodSettings
	XRayTracingEnabled types.BoolValue
}

func (*Stage) GetMetadata

func (s *Stage) GetMetadata() *types.Metadata

func (*Stage) GetRawValue

func (s *Stage) GetRawValue() interface{}