aws_api_gateway_usage_plan

package
v5.45.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 16, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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"`
	// ApiStagesThrottle: min=0
	Throttle []ApiStagesThrottle `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[ApiStagesThrottleAttributes]

type ApiStagesState 

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

type ApiStagesThrottle 

type ApiStagesThrottle 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 ApiStagesThrottleAttributes 

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

func (ApiStagesThrottleAttributes) BurstLimit 

func (t ApiStagesThrottleAttributes) BurstLimit() terra.NumberValue

func (ApiStagesThrottleAttributes) InternalRef 

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

func (ApiStagesThrottleAttributes) InternalTokens 

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

func (ApiStagesThrottleAttributes) InternalWithRef 

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

func (ApiStagesThrottleAttributes) Path 

func (t ApiStagesThrottleAttributes) Path() terra.StringValue

func (ApiStagesThrottleAttributes) RateLimit 

func (t ApiStagesThrottleAttributes) RateLimit() terra.NumberValue

type ApiStagesThrottleState 

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

type Args 

type Args struct {
	// Description: string, optional
	Description terra.StringValue `hcl:"description,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// ProductCode: string, optional
	ProductCode terra.StringValue `hcl:"product_code,attr"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
	// TagsAll: map of string, optional
	TagsAll terra.MapValue[terra.StringValue] `hcl:"tags_all,attr"`
	// ApiStages: min=0
	ApiStages []ApiStages `hcl:"api_stages,block" validate:"min=0"`
	// QuotaSettings: optional
	QuotaSettings *QuotaSettings `hcl:"quota_settings,block"`
	// ThrottleSettings: optional
	ThrottleSettings *ThrottleSettings `hcl:"throttle_settings,block"`
}

Args contains the configurations for aws_api_gateway_usage_plan.

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 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_usage_plan.

func New 

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes 

func (aagup *Resource) Attributes() awsApiGatewayUsagePlanAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration 

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn 

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies 

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState 

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

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

func (*Resource) LifecycleManagement 

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName 

func (aagup *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State 

func (aagup *Resource) State() (*awsApiGatewayUsagePlanState, bool)

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

func (*Resource) StateMust 

func (aagup *Resource) StateMust() *awsApiGatewayUsagePlanState

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

func (*Resource) Type 

func (aagup *Resource) Type() string

Type returns the Terraform object type for Resource.

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"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.