aws_db_snapshot

Documentation

Index

• type Args
• type DataArgs
• type DataSource
  • func Data(name string, args DataArgs) *DataSource
  • func (ads *DataSource) Attributes() dataAwsDbSnapshotAttributes
  • func (ads *DataSource) Configuration() interface{}
  • func (ads *DataSource) DataSource() string
  • func (ads *DataSource) LocalName() string
• type Resource
  • func New(name string, args Args) *Resource
  • func (ads *Resource) Attributes() awsDbSnapshotAttributes
  • func (ads *Resource) Configuration() interface{}
  • func (ads *Resource) DependOn() terra.Reference
  • func (ads *Resource) Dependencies() terra.Dependencies
  • func (ads *Resource) ImportState(state io.Reader) error
  • func (ads *Resource) LifecycleManagement() *terra.Lifecycle
  • func (ads *Resource) LocalName() string
  • func (ads *Resource) State() (*awsDbSnapshotState, bool)
  • func (ads *Resource) StateMust() *awsDbSnapshotState
  • func (ads *Resource) Type() string
• type Timeouts
• type TimeoutsAttributes
  • func (t TimeoutsAttributes) Create() terra.StringValue
  • func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)
  • func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes
• type TimeoutsState

Types

type Args

type Args struct {
	// DbInstanceIdentifier: string, required
	DbInstanceIdentifier terra.StringValue `hcl:"db_instance_identifier,attr" validate:"required"`
	// DbSnapshotIdentifier: string, required
	DbSnapshotIdentifier terra.StringValue `hcl:"db_snapshot_identifier,attr" validate:"required"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// SharedAccounts: set of string, optional
	SharedAccounts terra.SetValue[terra.StringValue] `hcl:"shared_accounts,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"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for aws_db_snapshot.

type DataArgs

type DataArgs struct {
	// DbInstanceIdentifier: string, optional
	DbInstanceIdentifier terra.StringValue `hcl:"db_instance_identifier,attr"`
	// DbSnapshotIdentifier: string, optional
	DbSnapshotIdentifier terra.StringValue `hcl:"db_snapshot_identifier,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// IncludePublic: bool, optional
	IncludePublic terra.BoolValue `hcl:"include_public,attr"`
	// IncludeShared: bool, optional
	IncludeShared terra.BoolValue `hcl:"include_shared,attr"`
	// MostRecent: bool, optional
	MostRecent terra.BoolValue `hcl:"most_recent,attr"`
	// SnapshotType: string, optional
	SnapshotType terra.StringValue `hcl:"snapshot_type,attr"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
}

DataArgs contains the configurations for aws_db_snapshot.

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource aws_db_snapshot.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (ads *DataSource) Attributes() dataAwsDbSnapshotAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

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

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (ads *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (ads *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_db_snapshot.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (ads *Resource) Attributes() awsDbSnapshotAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (ads *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (ads *Resource) State() (*awsDbSnapshotState, bool)

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

func (*Resource) StateMust

func (ads *Resource) StateMust() *awsDbSnapshotState

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

func (*Resource) Type

func (ads *Resource) Type() string

Type returns the Terraform object type for Resource.

type Timeouts

type Timeouts struct {
	// Create: string, optional
	Create terra.StringValue `hcl:"create,attr"`
}

type TimeoutsAttributes

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

func (TimeoutsAttributes) Create

func (t TimeoutsAttributes) Create() terra.StringValue

func (TimeoutsAttributes) InternalRef

func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)

func (TimeoutsAttributes) InternalTokens

func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (TimeoutsAttributes) InternalWithRef

func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes

type TimeoutsState

type TimeoutsState struct {
	Create string `json:"create"`
}