aws_apigatewayv2_route

Documentation

Index

• type Args
• type RequestParameter
• type RequestParameterAttributes
  • func (rp RequestParameterAttributes) InternalRef() (terra.Reference, error)
  • func (rp RequestParameterAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (rp RequestParameterAttributes) InternalWithRef(ref terra.Reference) RequestParameterAttributes
  • func (rp RequestParameterAttributes) RequestParameterKey() terra.StringValue
  • func (rp RequestParameterAttributes) Required() terra.BoolValue
• type RequestParameterState
• type Resource
  • func New(name string, args Args) *Resource
  • func (aar *Resource) Attributes() awsApigatewayv2RouteAttributes
  • func (aar *Resource) Configuration() interface{}
  • func (aar *Resource) DependOn() terra.Reference
  • func (aar *Resource) Dependencies() terra.Dependencies
  • func (aar *Resource) ImportState(state io.Reader) error
  • func (aar *Resource) LifecycleManagement() *terra.Lifecycle
  • func (aar *Resource) LocalName() string
  • func (aar *Resource) State() (*awsApigatewayv2RouteState, bool)
  • func (aar *Resource) StateMust() *awsApigatewayv2RouteState
  • func (aar *Resource) Type() string

Types

type Args

type Args struct {
	// ApiId: string, required
	ApiId terra.StringValue `hcl:"api_id,attr" validate:"required"`
	// ApiKeyRequired: bool, optional
	ApiKeyRequired terra.BoolValue `hcl:"api_key_required,attr"`
	// AuthorizationScopes: set of string, optional
	AuthorizationScopes terra.SetValue[terra.StringValue] `hcl:"authorization_scopes,attr"`
	// AuthorizationType: string, optional
	AuthorizationType terra.StringValue `hcl:"authorization_type,attr"`
	// AuthorizerId: string, optional
	AuthorizerId terra.StringValue `hcl:"authorizer_id,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// ModelSelectionExpression: string, optional
	ModelSelectionExpression terra.StringValue `hcl:"model_selection_expression,attr"`
	// OperationName: string, optional
	OperationName terra.StringValue `hcl:"operation_name,attr"`
	// RequestModels: map of string, optional
	RequestModels terra.MapValue[terra.StringValue] `hcl:"request_models,attr"`
	// RouteKey: string, required
	RouteKey terra.StringValue `hcl:"route_key,attr" validate:"required"`
	// RouteResponseSelectionExpression: string, optional
	RouteResponseSelectionExpression terra.StringValue `hcl:"route_response_selection_expression,attr"`
	// Target: string, optional
	Target terra.StringValue `hcl:"target,attr"`
	// RequestParameter: min=0
	RequestParameter []RequestParameter `hcl:"request_parameter,block" validate:"min=0"`
}

Args contains the configurations for aws_apigatewayv2_route.

type RequestParameter

type RequestParameter struct {
	// RequestParameterKey: string, required
	RequestParameterKey terra.StringValue `hcl:"request_parameter_key,attr" validate:"required"`
	// Required: bool, required
	Required terra.BoolValue `hcl:"required,attr" validate:"required"`
}

type RequestParameterAttributes

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

func (RequestParameterAttributes) InternalRef

func (rp RequestParameterAttributes) InternalRef() (terra.Reference, error)

func (RequestParameterAttributes) InternalTokens

func (rp RequestParameterAttributes) InternalTokens() (hclwrite.Tokens, error)

func (RequestParameterAttributes) InternalWithRef

func (rp RequestParameterAttributes) InternalWithRef(ref terra.Reference) RequestParameterAttributes

func (RequestParameterAttributes) RequestParameterKey

func (rp RequestParameterAttributes) RequestParameterKey() terra.StringValue

func (RequestParameterAttributes) Required

func (rp RequestParameterAttributes) Required() terra.BoolValue

type RequestParameterState

type RequestParameterState struct {
	RequestParameterKey string `json:"request_parameter_key"`
	Required            bool   `json:"required"`
}

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

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (aar *Resource) Attributes() awsApigatewayv2RouteAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (aar *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (aar *Resource) State() (*awsApigatewayv2RouteState, bool)

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

func (*Resource) StateMust

func (aar *Resource) StateMust() *awsApigatewayv2RouteState

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

func (*Resource) Type

func (aar *Resource) Type() string

Type returns the Terraform object type for Resource.