aws_api_gateway_documentation_part

Documentation

Index

• type Args
• type Location
• type LocationAttributes
  • func (l LocationAttributes) InternalRef() (terra.Reference, error)
  • func (l LocationAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (l LocationAttributes) InternalWithRef(ref terra.Reference) LocationAttributes
  • func (l LocationAttributes) Method() terra.StringValue
  • func (l LocationAttributes) Name() terra.StringValue
  • func (l LocationAttributes) Path() terra.StringValue
  • func (l LocationAttributes) StatusCode() terra.StringValue
  • func (l LocationAttributes) Type() terra.StringValue
• type LocationState
• type Resource
  • func New(name string, args Args) *Resource
  • func (aagdp *Resource) Attributes() awsApiGatewayDocumentationPartAttributes
  • func (aagdp *Resource) Configuration() interface{}
  • func (aagdp *Resource) DependOn() terra.Reference
  • func (aagdp *Resource) Dependencies() terra.Dependencies
  • func (aagdp *Resource) ImportState(state io.Reader) error
  • func (aagdp *Resource) LifecycleManagement() *terra.Lifecycle
  • func (aagdp *Resource) LocalName() string
  • func (aagdp *Resource) State() (*awsApiGatewayDocumentationPartState, bool)
  • func (aagdp *Resource) StateMust() *awsApiGatewayDocumentationPartState
  • func (aagdp *Resource) Type() string

Types

type Args

type Args struct {
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Properties: string, required
	Properties terra.StringValue `hcl:"properties,attr" validate:"required"`
	// RestApiId: string, required
	RestApiId terra.StringValue `hcl:"rest_api_id,attr" validate:"required"`
	// Location: required
	Location *Location `hcl:"location,block" validate:"required"`
}

Args contains the configurations for aws_api_gateway_documentation_part.

type Location

type Location struct {
	// Method: string, optional
	Method terra.StringValue `hcl:"method,attr"`
	// Name: string, optional
	Name terra.StringValue `hcl:"name,attr"`
	// Path: string, optional
	Path terra.StringValue `hcl:"path,attr"`
	// StatusCode: string, optional
	StatusCode terra.StringValue `hcl:"status_code,attr"`
	// Type: string, required
	Type terra.StringValue `hcl:"type,attr" validate:"required"`
}

type LocationAttributes

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

func (LocationAttributes) InternalRef

func (l LocationAttributes) InternalRef() (terra.Reference, error)

func (LocationAttributes) InternalTokens

func (l LocationAttributes) InternalTokens() (hclwrite.Tokens, error)

func (LocationAttributes) InternalWithRef

func (l LocationAttributes) InternalWithRef(ref terra.Reference) LocationAttributes

func (LocationAttributes) Method

func (l LocationAttributes) Method() terra.StringValue

func (LocationAttributes) Name

func (l LocationAttributes) Name() terra.StringValue

func (LocationAttributes) Path

func (l LocationAttributes) Path() terra.StringValue

func (LocationAttributes) StatusCode

func (l LocationAttributes) StatusCode() terra.StringValue

func (LocationAttributes) Type

func (l LocationAttributes) Type() terra.StringValue

type LocationState

type LocationState struct {
	Method     string `json:"method"`
	Name       string `json:"name"`
	Path       string `json:"path"`
	StatusCode string `json:"status_code"`
	Type       string `json:"type"`
}

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

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (aagdp *Resource) Attributes() awsApiGatewayDocumentationPartAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (aagdp *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (aagdp *Resource) State() (*awsApiGatewayDocumentationPartState, bool)

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

func (*Resource) StateMust

func (aagdp *Resource) StateMust() *awsApiGatewayDocumentationPartState

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

func (*Resource) Type

func (aagdp *Resource) Type() string

Type returns the Terraform object type for Resource.