aws_ssm_parameter

Documentation

Index

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

Types

type Args

type Args struct {
	// AllowedPattern: string, optional
	AllowedPattern terra.StringValue `hcl:"allowed_pattern,attr"`
	// Arn: string, optional
	Arn terra.StringValue `hcl:"arn,attr"`
	// DataType: string, optional
	DataType terra.StringValue `hcl:"data_type,attr"`
	// Description: string, optional
	Description terra.StringValue `hcl:"description,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// InsecureValue: string, optional
	InsecureValue terra.StringValue `hcl:"insecure_value,attr"`
	// KeyId: string, optional
	KeyId terra.StringValue `hcl:"key_id,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// Overwrite: bool, optional
	Overwrite terra.BoolValue `hcl:"overwrite,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"`
	// Tier: string, optional
	Tier terra.StringValue `hcl:"tier,attr"`
	// Type: string, required
	Type terra.StringValue `hcl:"type,attr" validate:"required"`
	// Value: string, optional
	Value terra.StringValue `hcl:"value,attr"`
}

Args contains the configurations for aws_ssm_parameter.

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"`
	// WithDecryption: bool, optional
	WithDecryption terra.BoolValue `hcl:"with_decryption,attr"`
}

DataArgs contains the configurations for aws_ssm_parameter.

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource aws_ssm_parameter.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (asp *DataSource) Attributes() dataAwsSsmParameterAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

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

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (asp *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (asp *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_ssm_parameter.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (asp *Resource) Attributes() awsSsmParameterAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (asp *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (asp *Resource) State() (*awsSsmParameterState, bool)

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

func (*Resource) StateMust

func (asp *Resource) StateMust() *awsSsmParameterState

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

func (*Resource) Type

func (asp *Resource) Type() string

Type returns the Terraform object type for Resource.