aws_api_gateway_method_settings

Documentation

Index

• type Args
• type Resource
  • func New(name string, args Args) *Resource
  • func (aagms *Resource) Attributes() awsApiGatewayMethodSettingsAttributes
  • func (aagms *Resource) Configuration() interface{}
  • func (aagms *Resource) DependOn() terra.Reference
  • func (aagms *Resource) Dependencies() terra.Dependencies
  • func (aagms *Resource) ImportState(state io.Reader) error
  • func (aagms *Resource) LifecycleManagement() *terra.Lifecycle
  • func (aagms *Resource) LocalName() string
  • func (aagms *Resource) State() (*awsApiGatewayMethodSettingsState, bool)
  • func (aagms *Resource) StateMust() *awsApiGatewayMethodSettingsState
  • func (aagms *Resource) Type() string
• type Settings
• type SettingsAttributes
  • func (s SettingsAttributes) CacheDataEncrypted() terra.BoolValue
  • func (s SettingsAttributes) CacheTtlInSeconds() terra.NumberValue
  • func (s SettingsAttributes) CachingEnabled() terra.BoolValue
  • func (s SettingsAttributes) DataTraceEnabled() terra.BoolValue
  • func (s SettingsAttributes) InternalRef() (terra.Reference, error)
  • func (s SettingsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (s SettingsAttributes) InternalWithRef(ref terra.Reference) SettingsAttributes
  • func (s SettingsAttributes) LoggingLevel() terra.StringValue
  • func (s SettingsAttributes) MetricsEnabled() terra.BoolValue
  • func (s SettingsAttributes) RequireAuthorizationForCacheControl() terra.BoolValue
  • func (s SettingsAttributes) ThrottlingBurstLimit() terra.NumberValue
  • func (s SettingsAttributes) ThrottlingRateLimit() terra.NumberValue
  • func (s SettingsAttributes) UnauthorizedCacheControlHeaderStrategy() terra.StringValue
• type SettingsState

Types

type Args

type Args struct {
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// MethodPath: string, required
	MethodPath terra.StringValue `hcl:"method_path,attr" validate:"required"`
	// RestApiId: string, required
	RestApiId terra.StringValue `hcl:"rest_api_id,attr" validate:"required"`
	// StageName: string, required
	StageName terra.StringValue `hcl:"stage_name,attr" validate:"required"`
	// Settings: required
	Settings *Settings `hcl:"settings,block" validate:"required"`
}

Args contains the configurations for aws_api_gateway_method_settings.

type Resource

type Resource struct {
	Name string
	Args Args

	DependsOn terra.Dependencies
	Lifecycle *terra.Lifecycle
	// contains filtered or unexported fields
}

Resource represents the Terraform resource aws_api_gateway_method_settings.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (aagms *Resource) Attributes() awsApiGatewayMethodSettingsAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

func (aagms *Resource) Configuration() interface{}

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

func (aagms *Resource) DependOn() terra.Reference

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

func (aagms *Resource) Dependencies() terra.Dependencies

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

func (aagms *Resource) ImportState(state io.Reader) error

ImportState imports the given attribute values into Resource's state.

func (*Resource) LifecycleManagement

func (aagms *Resource) LifecycleManagement() *terra.Lifecycle

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (aagms *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (aagms *Resource) State() (*awsApiGatewayMethodSettingsState, bool)

State returns the state and a bool indicating if Resource has state.

func (*Resource) StateMust

func (aagms *Resource) StateMust() *awsApiGatewayMethodSettingsState

StateMust returns the state for Resource. Panics if the state is nil.

func (*Resource) Type

func (aagms *Resource) Type() string

Type returns the Terraform object type for Resource.

type Settings

type Settings struct {
	// CacheDataEncrypted: bool, optional
	CacheDataEncrypted terra.BoolValue `hcl:"cache_data_encrypted,attr"`
	// CacheTtlInSeconds: number, optional
	CacheTtlInSeconds terra.NumberValue `hcl:"cache_ttl_in_seconds,attr"`
	// CachingEnabled: bool, optional
	CachingEnabled terra.BoolValue `hcl:"caching_enabled,attr"`
	// DataTraceEnabled: bool, optional
	DataTraceEnabled terra.BoolValue `hcl:"data_trace_enabled,attr"`
	// LoggingLevel: string, optional
	LoggingLevel terra.StringValue `hcl:"logging_level,attr"`
	// MetricsEnabled: bool, optional
	MetricsEnabled terra.BoolValue `hcl:"metrics_enabled,attr"`
	// RequireAuthorizationForCacheControl: bool, optional
	RequireAuthorizationForCacheControl terra.BoolValue `hcl:"require_authorization_for_cache_control,attr"`
	// ThrottlingBurstLimit: number, optional
	ThrottlingBurstLimit terra.NumberValue `hcl:"throttling_burst_limit,attr"`
	// ThrottlingRateLimit: number, optional
	ThrottlingRateLimit terra.NumberValue `hcl:"throttling_rate_limit,attr"`
	// UnauthorizedCacheControlHeaderStrategy: string, optional
	UnauthorizedCacheControlHeaderStrategy terra.StringValue `hcl:"unauthorized_cache_control_header_strategy,attr"`
}

type SettingsAttributes

type SettingsAttributes struct {
	// contains filtered or unexported fields
}

func (SettingsAttributes) CacheDataEncrypted

func (s SettingsAttributes) CacheDataEncrypted() terra.BoolValue

func (SettingsAttributes) CacheTtlInSeconds

func (s SettingsAttributes) CacheTtlInSeconds() terra.NumberValue

func (SettingsAttributes) CachingEnabled

func (s SettingsAttributes) CachingEnabled() terra.BoolValue

func (SettingsAttributes) DataTraceEnabled

func (s SettingsAttributes) DataTraceEnabled() terra.BoolValue

func (SettingsAttributes) InternalRef

func (s SettingsAttributes) InternalRef() (terra.Reference, error)

func (SettingsAttributes) InternalTokens

func (s SettingsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (SettingsAttributes) InternalWithRef

func (s SettingsAttributes) InternalWithRef(ref terra.Reference) SettingsAttributes

func (SettingsAttributes) LoggingLevel

func (s SettingsAttributes) LoggingLevel() terra.StringValue

func (SettingsAttributes) MetricsEnabled

func (s SettingsAttributes) MetricsEnabled() terra.BoolValue

func (SettingsAttributes) RequireAuthorizationForCacheControl

func (s SettingsAttributes) RequireAuthorizationForCacheControl() terra.BoolValue

func (SettingsAttributes) ThrottlingBurstLimit

func (s SettingsAttributes) ThrottlingBurstLimit() terra.NumberValue

func (SettingsAttributes) ThrottlingRateLimit

func (s SettingsAttributes) ThrottlingRateLimit() terra.NumberValue

func (SettingsAttributes) UnauthorizedCacheControlHeaderStrategy

func (s SettingsAttributes) UnauthorizedCacheControlHeaderStrategy() terra.StringValue

type SettingsState

type SettingsState struct {
	CacheDataEncrypted                     bool    `json:"cache_data_encrypted"`
	CacheTtlInSeconds                      float64 `json:"cache_ttl_in_seconds"`
	CachingEnabled                         bool    `json:"caching_enabled"`
	DataTraceEnabled                       bool    `json:"data_trace_enabled"`
	LoggingLevel                           string  `json:"logging_level"`
	MetricsEnabled                         bool    `json:"metrics_enabled"`
	RequireAuthorizationForCacheControl    bool    `json:"require_authorization_for_cache_control"`
	ThrottlingBurstLimit                   float64 `json:"throttling_burst_limit"`
	ThrottlingRateLimit                    float64 `json:"throttling_rate_limit"`
	UnauthorizedCacheControlHeaderStrategy string  `json:"unauthorized_cache_control_header_strategy"`
}