aws_api_gateway_resource

Documentation

Index

• type Args
• type DataArgs
• type DataSource
  • func Data(name string, args DataArgs) *DataSource
  • func (aagr *DataSource) Attributes() dataAwsApiGatewayResourceAttributes
  • func (aagr *DataSource) Configuration() interface{}
  • func (aagr *DataSource) DataSource() string
  • func (aagr *DataSource) LocalName() string
• type Resource
  • func New(name string, args Args) *Resource
  • func (aagr *Resource) Attributes() awsApiGatewayResourceAttributes
  • func (aagr *Resource) Configuration() interface{}
  • func (aagr *Resource) DependOn() terra.Reference
  • func (aagr *Resource) Dependencies() terra.Dependencies
  • func (aagr *Resource) ImportState(state io.Reader) error
  • func (aagr *Resource) LifecycleManagement() *terra.Lifecycle
  • func (aagr *Resource) LocalName() string
  • func (aagr *Resource) State() (*awsApiGatewayResourceState, bool)
  • func (aagr *Resource) StateMust() *awsApiGatewayResourceState
  • func (aagr *Resource) Type() string

Types

type Args

type Args struct {
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// ParentId: string, required
	ParentId terra.StringValue `hcl:"parent_id,attr" validate:"required"`
	// PathPart: string, required
	PathPart terra.StringValue `hcl:"path_part,attr" validate:"required"`
	// RestApiId: string, required
	RestApiId terra.StringValue `hcl:"rest_api_id,attr" validate:"required"`
}

Args contains the configurations for aws_api_gateway_resource.

type DataArgs

type DataArgs struct {
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Path: string, required
	Path terra.StringValue `hcl:"path,attr" validate:"required"`
	// RestApiId: string, required
	RestApiId terra.StringValue `hcl:"rest_api_id,attr" validate:"required"`
}

DataArgs contains the configurations for aws_api_gateway_resource.

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource aws_api_gateway_resource.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (aagr *DataSource) Attributes() dataAwsApiGatewayResourceAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

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

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (aagr *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (aagr *DataSource) LocalName() string

LocalName returns the local name for DataSource.

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

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (aagr *Resource) Attributes() awsApiGatewayResourceAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (aagr *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (aagr *Resource) State() (*awsApiGatewayResourceState, bool)

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

func (*Resource) StateMust

func (aagr *Resource) StateMust() *awsApiGatewayResourceState

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

func (*Resource) Type

func (aagr *Resource) Type() string

Type returns the Terraform object type for Resource.