aws_api_gateway_rest_api

Documentation

Index

• type Args
• type DataArgs
• type DataEndpointConfigurationAttributes
  • func (ec DataEndpointConfigurationAttributes) InternalRef() (terra.Reference, error)
  • func (ec DataEndpointConfigurationAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (ec DataEndpointConfigurationAttributes) InternalWithRef(ref terra.Reference) DataEndpointConfigurationAttributes
  • func (ec DataEndpointConfigurationAttributes) Types() terra.ListValue[terra.StringValue]
  • func (ec DataEndpointConfigurationAttributes) VpcEndpointIds() terra.SetValue[terra.StringValue]
• type DataEndpointConfigurationState
• type DataSource
  • func Data(name string, args DataArgs) *DataSource
  • func (aagra *DataSource) Attributes() dataAwsApiGatewayRestApiAttributes
  • func (aagra *DataSource) Configuration() interface{}
  • func (aagra *DataSource) DataSource() string
  • func (aagra *DataSource) LocalName() string
• type EndpointConfiguration
• type EndpointConfigurationAttributes
  • func (ec EndpointConfigurationAttributes) InternalRef() (terra.Reference, error)
  • func (ec EndpointConfigurationAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (ec EndpointConfigurationAttributes) InternalWithRef(ref terra.Reference) EndpointConfigurationAttributes
  • func (ec EndpointConfigurationAttributes) Types() terra.ListValue[terra.StringValue]
  • func (ec EndpointConfigurationAttributes) VpcEndpointIds() terra.SetValue[terra.StringValue]
• type EndpointConfigurationState
• type Resource
  • func New(name string, args Args) *Resource
  • func (aagra *Resource) Attributes() awsApiGatewayRestApiAttributes
  • func (aagra *Resource) Configuration() interface{}
  • func (aagra *Resource) DependOn() terra.Reference
  • func (aagra *Resource) Dependencies() terra.Dependencies
  • func (aagra *Resource) ImportState(state io.Reader) error
  • func (aagra *Resource) LifecycleManagement() *terra.Lifecycle
  • func (aagra *Resource) LocalName() string
  • func (aagra *Resource) State() (*awsApiGatewayRestApiState, bool)
  • func (aagra *Resource) StateMust() *awsApiGatewayRestApiState
  • func (aagra *Resource) Type() string

Types

type Args

type Args struct {
	// ApiKeySource: string, optional
	ApiKeySource terra.StringValue `hcl:"api_key_source,attr"`
	// BinaryMediaTypes: list of string, optional
	BinaryMediaTypes terra.ListValue[terra.StringValue] `hcl:"binary_media_types,attr"`
	// Body: string, optional
	Body terra.StringValue `hcl:"body,attr"`
	// Description: string, optional
	Description terra.StringValue `hcl:"description,attr"`
	// DisableExecuteApiEndpoint: bool, optional
	DisableExecuteApiEndpoint terra.BoolValue `hcl:"disable_execute_api_endpoint,attr"`
	// FailOnWarnings: bool, optional
	FailOnWarnings terra.BoolValue `hcl:"fail_on_warnings,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// MinimumCompressionSize: string, optional
	MinimumCompressionSize terra.StringValue `hcl:"minimum_compression_size,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// Parameters: map of string, optional
	Parameters terra.MapValue[terra.StringValue] `hcl:"parameters,attr"`
	// Policy: string, optional
	Policy terra.StringValue `hcl:"policy,attr"`
	// PutRestApiMode: string, optional
	PutRestApiMode terra.StringValue `hcl:"put_rest_api_mode,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"`
	// EndpointConfiguration: optional
	EndpointConfiguration *EndpointConfiguration `hcl:"endpoint_configuration,block"`
}

Args contains the configurations for aws_api_gateway_rest_api.

type DataArgs

type DataArgs struct {
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
}

DataArgs contains the configurations for aws_api_gateway_rest_api.

type DataEndpointConfigurationAttributes

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

func (DataEndpointConfigurationAttributes) InternalRef

func (ec DataEndpointConfigurationAttributes) InternalRef() (terra.Reference, error)

func (DataEndpointConfigurationAttributes) InternalTokens

func (ec DataEndpointConfigurationAttributes) InternalTokens() (hclwrite.Tokens, error)

func (DataEndpointConfigurationAttributes) InternalWithRef

func (ec DataEndpointConfigurationAttributes) InternalWithRef(ref terra.Reference) DataEndpointConfigurationAttributes

func (DataEndpointConfigurationAttributes) Types

func (ec DataEndpointConfigurationAttributes) Types() terra.ListValue[terra.StringValue]

func (DataEndpointConfigurationAttributes) VpcEndpointIds

func (ec DataEndpointConfigurationAttributes) VpcEndpointIds() terra.SetValue[terra.StringValue]

type DataEndpointConfigurationState

type DataEndpointConfigurationState struct {
	Types          []string `json:"types"`
	VpcEndpointIds []string `json:"vpc_endpoint_ids"`
}

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource aws_api_gateway_rest_api.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (aagra *DataSource) Attributes() dataAwsApiGatewayRestApiAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

func (aagra *DataSource) Configuration() interface{}

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (aagra *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (aagra *DataSource) LocalName() string

LocalName returns the local name for DataSource.

type EndpointConfiguration

type EndpointConfiguration struct {
	// Types: list of string, required
	Types terra.ListValue[terra.StringValue] `hcl:"types,attr" validate:"required"`
	// VpcEndpointIds: set of string, optional
	VpcEndpointIds terra.SetValue[terra.StringValue] `hcl:"vpc_endpoint_ids,attr"`
}

type EndpointConfigurationAttributes

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

func (EndpointConfigurationAttributes) InternalRef

func (ec EndpointConfigurationAttributes) InternalRef() (terra.Reference, error)

func (EndpointConfigurationAttributes) InternalTokens

func (ec EndpointConfigurationAttributes) InternalTokens() (hclwrite.Tokens, error)

func (EndpointConfigurationAttributes) InternalWithRef

func (ec EndpointConfigurationAttributes) InternalWithRef(ref terra.Reference) EndpointConfigurationAttributes

func (EndpointConfigurationAttributes) Types

func (ec EndpointConfigurationAttributes) Types() terra.ListValue[terra.StringValue]

func (EndpointConfigurationAttributes) VpcEndpointIds

func (ec EndpointConfigurationAttributes) VpcEndpointIds() terra.SetValue[terra.StringValue]

type EndpointConfigurationState

type EndpointConfigurationState struct {
	Types          []string `json:"types"`
	VpcEndpointIds []string `json:"vpc_endpoint_ids"`
}

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

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (aagra *Resource) Attributes() awsApiGatewayRestApiAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (aagra *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (aagra *Resource) State() (*awsApiGatewayRestApiState, bool)

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

func (*Resource) StateMust

func (aagra *Resource) StateMust() *awsApiGatewayRestApiState

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

func (*Resource) Type

func (aagra *Resource) Type() string

Type returns the Terraform object type for Resource.