Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessLogSetting ¶
type AccessLogSetting struct {
// The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.
DestinationArn string `json:"DestinationArn,omitempty"`
// A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
Format string `json:"Format,omitempty"`
}
AccessLogSetting
func (*AccessLogSetting) MarshalJSON ¶
func (strct *AccessLogSetting) MarshalJSON() ([]byte, error)
func (*AccessLogSetting) UnmarshalJSON ¶
func (strct *AccessLogSetting) UnmarshalJSON(b []byte) error
type CanarySetting ¶
type CanarySetting struct {
// The percent (0-100) of traffic diverted to a canary deployment.
PercentTraffic float64 `json:"PercentTraffic,omitempty"`
// Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
StageVariableOverrides *StageVariableOverrides `json:"StageVariableOverrides,omitempty"`
// Whether the canary deployment uses the stage cache or not.
UseStageCache bool `json:"UseStageCache,omitempty"`
}
CanarySetting
func (*CanarySetting) MarshalJSON ¶
func (strct *CanarySetting) MarshalJSON() ([]byte, error)
func (*CanarySetting) UnmarshalJSON ¶
func (strct *CanarySetting) UnmarshalJSON(b []byte) error
type DeploymentCanarySettings ¶
type DeploymentCanarySettings struct {
// The percentage (0-100) of traffic diverted to a canary deployment.
PercentTraffic float64 `json:"PercentTraffic,omitempty"`
// Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. Duplicates are not allowed.
StageVariableOverrides *StageVariableOverrides `json:"StageVariableOverrides,omitempty"`
// Whether the canary deployment uses the stage cache.
UseStageCache bool `json:"UseStageCache,omitempty"`
}
DeploymentCanarySettings
func (*DeploymentCanarySettings) MarshalJSON ¶
func (strct *DeploymentCanarySettings) MarshalJSON() ([]byte, error)
func (*DeploymentCanarySettings) UnmarshalJSON ¶
func (strct *DeploymentCanarySettings) UnmarshalJSON(b []byte) error
type MethodSetting ¶
type MethodSetting struct {
// Indicates whether the cached responses are encrypted
CacheDataEncrypted bool `json:"CacheDataEncrypted,omitempty"`
// The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
CacheTtlInSeconds int `json:"CacheTtlInSeconds,omitempty"`
// Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.
CachingEnabled bool `json:"CachingEnabled,omitempty"`
// Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
DataTraceEnabled bool `json:"DataTraceEnabled,omitempty"`
// The HTTP method.
HttpMethod string `json:"HttpMethod,omitempty"`
// The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
LoggingLevel string `json:"LoggingLevel,omitempty"`
// Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
MetricsEnabled bool `json:"MetricsEnabled,omitempty"`
// The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash.
ResourcePath string `json:"ResourcePath,omitempty"`
// The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
ThrottlingBurstLimit int `json:"ThrottlingBurstLimit,omitempty"`
// The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
ThrottlingRateLimit float64 `json:"ThrottlingRateLimit,omitempty"`
}
MethodSetting
func (*MethodSetting) MarshalJSON ¶
func (strct *MethodSetting) MarshalJSON() ([]byte, error)
func (*MethodSetting) UnmarshalJSON ¶
func (strct *MethodSetting) UnmarshalJSON(b []byte) error
type Resource ¶
type Resource struct {
// Specifies settings for the canary deployment.
DeploymentCanarySettings *DeploymentCanarySettings `json:"DeploymentCanarySettings,omitempty"`
// Primary Id for this resource
DeploymentId string `json:"DeploymentId,omitempty"`
// A description of the purpose of the API Gateway deployment.
Description string `json:"Description,omitempty"`
// The ID of the RestApi resource to deploy.
RestApiId string `json:"RestApiId"`
// Configures the stage that API Gateway creates with this deployment.
StageDescription *StageDescription `json:"StageDescription,omitempty"`
// A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
StageName string `json:"StageName,omitempty"`
}
Resource Resource Type definition for AWS::ApiGateway::Deployment
func (*Resource) MarshalJSON ¶
func (*Resource) UnmarshalJSON ¶
type StageDescription ¶
type StageDescription struct {
// Specifies settings for logging access in this stage.
AccessLogSetting *AccessLogSetting `json:"AccessLogSetting,omitempty"`
// Indicates whether cache clustering is enabled for the stage.
CacheClusterEnabled bool `json:"CacheClusterEnabled,omitempty"`
// The size of the stage's cache cluster.
CacheClusterSize string `json:"CacheClusterSize,omitempty"`
// The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
CacheDataEncrypted bool `json:"CacheDataEncrypted,omitempty"`
// The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
CacheTtlInSeconds int `json:"CacheTtlInSeconds,omitempty"`
// Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.
CachingEnabled bool `json:"CachingEnabled,omitempty"`
// Specifies settings for the canary deployment in this stage.
CanarySetting *CanarySetting `json:"CanarySetting,omitempty"`
// The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
ClientCertificateId string `json:"ClientCertificateId,omitempty"`
// Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
DataTraceEnabled bool `json:"DataTraceEnabled,omitempty"`
// A description of the purpose of the stage.
Description string `json:"Description,omitempty"`
// The version identifier of the API documentation snapshot.
DocumentationVersion string `json:"DocumentationVersion,omitempty"`
// The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
LoggingLevel string `json:"LoggingLevel,omitempty"`
// Configures settings for all of the stage's methods.
MethodSettings []*MethodSetting `json:"MethodSettings,omitempty"`
// Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
MetricsEnabled bool `json:"MetricsEnabled,omitempty"`
// An array of arbitrary tags (key-value pairs) to associate with the stage.
Tags []*Tag `json:"Tags,omitempty"`
// The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
ThrottlingBurstLimit int `json:"ThrottlingBurstLimit,omitempty"`
// The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
ThrottlingRateLimit float64 `json:"ThrottlingRateLimit,omitempty"`
// Specifies whether active tracing with X-ray is enabled for this stage.
TracingEnabled bool `json:"TracingEnabled,omitempty"`
// A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
Variables *Variables `json:"Variables,omitempty"`
}
StageDescription
func (*StageDescription) MarshalJSON ¶
func (strct *StageDescription) MarshalJSON() ([]byte, error)
func (*StageDescription) UnmarshalJSON ¶
func (strct *StageDescription) UnmarshalJSON(b []byte) error
type StageVariableOverrides ¶
type StageVariableOverrides struct {
}
StageVariableOverrides Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
func (*StageVariableOverrides) MarshalJSON ¶
func (strct *StageVariableOverrides) MarshalJSON() ([]byte, error)
func (*StageVariableOverrides) UnmarshalJSON ¶
func (strct *StageVariableOverrides) UnmarshalJSON(b []byte) error
type Tag ¶
type Tag struct {
// The key name of the tag
Key string `json:"Key"`
// The value for the tag
Value string `json:"Value"`
}
Tag
func (*Tag) MarshalJSON ¶
func (*Tag) UnmarshalJSON ¶
type Variables ¶
type Variables struct {
}
Variables A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
func (*Variables) MarshalJSON ¶
func (*Variables) UnmarshalJSON ¶
Source Files
Click to show internal directories.
Click to hide internal directories.