apigatewayusageplan

Documentation

Index

• type ApiStages
• type ApiStagesAttributes
  • func (as ApiStagesAttributes) ApiId() terra.StringValue
  • func (as ApiStagesAttributes) InternalRef() (terra.Reference, error)
  • func (as ApiStagesAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (as ApiStagesAttributes) InternalWithRef(ref terra.Reference) ApiStagesAttributes
  • func (as ApiStagesAttributes) Stage() terra.StringValue
  • func (as ApiStagesAttributes) Throttle() terra.SetValue[ThrottleAttributes]
• type ApiStagesState
• type QuotaSettings
• type QuotaSettingsAttributes
  • func (qs QuotaSettingsAttributes) InternalRef() (terra.Reference, error)
  • func (qs QuotaSettingsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (qs QuotaSettingsAttributes) InternalWithRef(ref terra.Reference) QuotaSettingsAttributes
  • func (qs QuotaSettingsAttributes) Limit() terra.NumberValue
  • func (qs QuotaSettingsAttributes) Offset() terra.NumberValue
  • func (qs QuotaSettingsAttributes) Period() terra.StringValue
• type QuotaSettingsState
• type Throttle
• type ThrottleAttributes
  • func (t ThrottleAttributes) BurstLimit() terra.NumberValue
  • func (t ThrottleAttributes) InternalRef() (terra.Reference, error)
  • func (t ThrottleAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (t ThrottleAttributes) InternalWithRef(ref terra.Reference) ThrottleAttributes
  • func (t ThrottleAttributes) Path() terra.StringValue
  • func (t ThrottleAttributes) RateLimit() terra.NumberValue
• type ThrottleSettings
• type ThrottleSettingsAttributes
  • func (ts ThrottleSettingsAttributes) BurstLimit() terra.NumberValue
  • func (ts ThrottleSettingsAttributes) InternalRef() (terra.Reference, error)
  • func (ts ThrottleSettingsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (ts ThrottleSettingsAttributes) InternalWithRef(ref terra.Reference) ThrottleSettingsAttributes
  • func (ts ThrottleSettingsAttributes) RateLimit() terra.NumberValue
• type ThrottleSettingsState
• type ThrottleState

Types

type ApiStages

type ApiStages struct {
	// ApiId: string, required
	ApiId terra.StringValue `hcl:"api_id,attr" validate:"required"`
	// Stage: string, required
	Stage terra.StringValue `hcl:"stage,attr" validate:"required"`
	// Throttle: min=0
	Throttle []Throttle `hcl:"throttle,block" validate:"min=0"`
}

type ApiStagesAttributes

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

func (ApiStagesAttributes) ApiId

func (as ApiStagesAttributes) ApiId() terra.StringValue

func (ApiStagesAttributes) InternalRef

func (as ApiStagesAttributes) InternalRef() (terra.Reference, error)

func (ApiStagesAttributes) InternalTokens

func (as ApiStagesAttributes) InternalTokens() (hclwrite.Tokens, error)

func (ApiStagesAttributes) InternalWithRef

func (as ApiStagesAttributes) InternalWithRef(ref terra.Reference) ApiStagesAttributes

func (ApiStagesAttributes) Stage

func (as ApiStagesAttributes) Stage() terra.StringValue

func (ApiStagesAttributes) Throttle

func (as ApiStagesAttributes) Throttle() terra.SetValue[ThrottleAttributes]

type ApiStagesState

type ApiStagesState struct {
	ApiId    string          `json:"api_id"`
	Stage    string          `json:"stage"`
	Throttle []ThrottleState `json:"throttle"`
}

type QuotaSettings

type QuotaSettings struct {
	// Limit: number, required
	Limit terra.NumberValue `hcl:"limit,attr" validate:"required"`
	// Offset: number, optional
	Offset terra.NumberValue `hcl:"offset,attr"`
	// Period: string, required
	Period terra.StringValue `hcl:"period,attr" validate:"required"`
}

type QuotaSettingsAttributes

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

func (QuotaSettingsAttributes) InternalRef

func (qs QuotaSettingsAttributes) InternalRef() (terra.Reference, error)

func (QuotaSettingsAttributes) InternalTokens

func (qs QuotaSettingsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (QuotaSettingsAttributes) InternalWithRef

func (qs QuotaSettingsAttributes) InternalWithRef(ref terra.Reference) QuotaSettingsAttributes

func (QuotaSettingsAttributes) Limit

func (qs QuotaSettingsAttributes) Limit() terra.NumberValue

func (QuotaSettingsAttributes) Offset

func (qs QuotaSettingsAttributes) Offset() terra.NumberValue

func (QuotaSettingsAttributes) Period

func (qs QuotaSettingsAttributes) Period() terra.StringValue

type QuotaSettingsState

type QuotaSettingsState struct {
	Limit  float64 `json:"limit"`
	Offset float64 `json:"offset"`
	Period string  `json:"period"`
}

type Throttle

type Throttle struct {
	// BurstLimit: number, optional
	BurstLimit terra.NumberValue `hcl:"burst_limit,attr"`
	// Path: string, required
	Path terra.StringValue `hcl:"path,attr" validate:"required"`
	// RateLimit: number, optional
	RateLimit terra.NumberValue `hcl:"rate_limit,attr"`
}

type ThrottleAttributes

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

func (ThrottleAttributes) BurstLimit

func (t ThrottleAttributes) BurstLimit() terra.NumberValue

func (ThrottleAttributes) InternalRef

func (t ThrottleAttributes) InternalRef() (terra.Reference, error)

func (ThrottleAttributes) InternalTokens

func (t ThrottleAttributes) InternalTokens() (hclwrite.Tokens, error)

func (ThrottleAttributes) InternalWithRef

func (t ThrottleAttributes) InternalWithRef(ref terra.Reference) ThrottleAttributes

func (ThrottleAttributes) Path

func (t ThrottleAttributes) Path() terra.StringValue

func (ThrottleAttributes) RateLimit

func (t ThrottleAttributes) RateLimit() terra.NumberValue

type ThrottleSettings

type ThrottleSettings struct {
	// BurstLimit: number, optional
	BurstLimit terra.NumberValue `hcl:"burst_limit,attr"`
	// RateLimit: number, optional
	RateLimit terra.NumberValue `hcl:"rate_limit,attr"`
}

type ThrottleSettingsAttributes

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

func (ThrottleSettingsAttributes) BurstLimit

func (ts ThrottleSettingsAttributes) BurstLimit() terra.NumberValue

func (ThrottleSettingsAttributes) InternalRef

func (ts ThrottleSettingsAttributes) InternalRef() (terra.Reference, error)

func (ThrottleSettingsAttributes) InternalTokens

func (ts ThrottleSettingsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (ThrottleSettingsAttributes) InternalWithRef

func (ts ThrottleSettingsAttributes) InternalWithRef(ref terra.Reference) ThrottleSettingsAttributes

func (ThrottleSettingsAttributes) RateLimit

func (ts ThrottleSettingsAttributes) RateLimit() terra.NumberValue

type ThrottleSettingsState

type ThrottleSettingsState struct {
	BurstLimit float64 `json:"burst_limit"`
	RateLimit  float64 `json:"rate_limit"`
}

type ThrottleState

type ThrottleState struct {
	BurstLimit float64 `json:"burst_limit"`
	Path       string  `json:"path"`
	RateLimit  float64 `json:"rate_limit"`
}