aws_ssm_document

Documentation

Index

• type Args
• type AttachmentsSource
• type AttachmentsSourceAttributes
  • func (as AttachmentsSourceAttributes) InternalRef() (terra.Reference, error)
  • func (as AttachmentsSourceAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (as AttachmentsSourceAttributes) InternalWithRef(ref terra.Reference) AttachmentsSourceAttributes
  • func (as AttachmentsSourceAttributes) Key() terra.StringValue
  • func (as AttachmentsSourceAttributes) Name() terra.StringValue
  • func (as AttachmentsSourceAttributes) Values() terra.ListValue[terra.StringValue]
• type AttachmentsSourceState
• type DataArgs
• type DataSource
  • func Data(name string, args DataArgs) *DataSource
  • func (asd *DataSource) Attributes() dataAwsSsmDocumentAttributes
  • func (asd *DataSource) Configuration() interface{}
  • func (asd *DataSource) DataSource() string
  • func (asd *DataSource) LocalName() string
• type ParameterAttributes
  • func (p ParameterAttributes) DefaultValue() terra.StringValue
  • func (p ParameterAttributes) Description() terra.StringValue
  • func (p ParameterAttributes) InternalRef() (terra.Reference, error)
  • func (p ParameterAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (p ParameterAttributes) InternalWithRef(ref terra.Reference) ParameterAttributes
  • func (p ParameterAttributes) Name() terra.StringValue
  • func (p ParameterAttributes) Type() terra.StringValue
• type ParameterState
• type Resource
  • func New(name string, args Args) *Resource
  • func (asd *Resource) Attributes() awsSsmDocumentAttributes
  • func (asd *Resource) Configuration() interface{}
  • func (asd *Resource) DependOn() terra.Reference
  • func (asd *Resource) Dependencies() terra.Dependencies
  • func (asd *Resource) ImportState(state io.Reader) error
  • func (asd *Resource) LifecycleManagement() *terra.Lifecycle
  • func (asd *Resource) LocalName() string
  • func (asd *Resource) State() (*awsSsmDocumentState, bool)
  • func (asd *Resource) StateMust() *awsSsmDocumentState
  • func (asd *Resource) Type() string

Types

type Args

type Args struct {
	// Content: string, required
	Content terra.StringValue `hcl:"content,attr" validate:"required"`
	// DocumentFormat: string, optional
	DocumentFormat terra.StringValue `hcl:"document_format,attr"`
	// DocumentType: string, required
	DocumentType terra.StringValue `hcl:"document_type,attr" validate:"required"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// Permissions: map of string, optional
	Permissions terra.MapValue[terra.StringValue] `hcl:"permissions,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"`
	// TargetType: string, optional
	TargetType terra.StringValue `hcl:"target_type,attr"`
	// VersionName: string, optional
	VersionName terra.StringValue `hcl:"version_name,attr"`
	// AttachmentsSource: min=0,max=20
	AttachmentsSource []AttachmentsSource `hcl:"attachments_source,block" validate:"min=0,max=20"`
}

Args contains the configurations for aws_ssm_document.

type AttachmentsSource

type AttachmentsSource struct {
	// Key: string, required
	Key terra.StringValue `hcl:"key,attr" validate:"required"`
	// Name: string, optional
	Name terra.StringValue `hcl:"name,attr"`
	// Values: list of string, required
	Values terra.ListValue[terra.StringValue] `hcl:"values,attr" validate:"required"`
}

type AttachmentsSourceAttributes

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

func (AttachmentsSourceAttributes) InternalRef

func (as AttachmentsSourceAttributes) InternalRef() (terra.Reference, error)

func (AttachmentsSourceAttributes) InternalTokens

func (as AttachmentsSourceAttributes) InternalTokens() (hclwrite.Tokens, error)

func (AttachmentsSourceAttributes) InternalWithRef

func (as AttachmentsSourceAttributes) InternalWithRef(ref terra.Reference) AttachmentsSourceAttributes

func (AttachmentsSourceAttributes) Key

func (as AttachmentsSourceAttributes) Key() terra.StringValue

func (AttachmentsSourceAttributes) Name

func (as AttachmentsSourceAttributes) Name() terra.StringValue

func (AttachmentsSourceAttributes) Values

func (as AttachmentsSourceAttributes) Values() terra.ListValue[terra.StringValue]

type AttachmentsSourceState

type AttachmentsSourceState struct {
	Key    string   `json:"key"`
	Name   string   `json:"name"`
	Values []string `json:"values"`
}

type DataArgs

type DataArgs struct {
	// DocumentFormat: string, optional
	DocumentFormat terra.StringValue `hcl:"document_format,attr"`
	// DocumentVersion: string, optional
	DocumentVersion terra.StringValue `hcl:"document_version,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
}

DataArgs contains the configurations for aws_ssm_document.

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource aws_ssm_document.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (asd *DataSource) Attributes() dataAwsSsmDocumentAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

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

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (asd *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (asd *DataSource) LocalName() string

LocalName returns the local name for DataSource.

type ParameterAttributes

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

func (ParameterAttributes) DefaultValue

func (p ParameterAttributes) DefaultValue() terra.StringValue

func (ParameterAttributes) Description

func (p ParameterAttributes) Description() terra.StringValue

func (ParameterAttributes) InternalRef

func (p ParameterAttributes) InternalRef() (terra.Reference, error)

func (ParameterAttributes) InternalTokens

func (p ParameterAttributes) InternalTokens() (hclwrite.Tokens, error)

func (ParameterAttributes) InternalWithRef

func (p ParameterAttributes) InternalWithRef(ref terra.Reference) ParameterAttributes

func (ParameterAttributes) Name

func (p ParameterAttributes) Name() terra.StringValue

func (ParameterAttributes) Type

func (p ParameterAttributes) Type() terra.StringValue

type ParameterState

type ParameterState struct {
	DefaultValue string `json:"default_value"`
	Description  string `json:"description"`
	Name         string `json:"name"`
	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_ssm_document.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (asd *Resource) Attributes() awsSsmDocumentAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (asd *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (asd *Resource) State() (*awsSsmDocumentState, bool)

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

func (*Resource) StateMust

func (asd *Resource) StateMust() *awsSsmDocumentState

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

func (*Resource) Type

func (asd *Resource) Type() string

Type returns the Terraform object type for Resource.