aws_kinesis_stream

Documentation

Index

• type Args
• type DataArgs
• type DataSource
  • func Data(name string, args DataArgs) *DataSource
  • func (aks *DataSource) Attributes() dataAwsKinesisStreamAttributes
  • func (aks *DataSource) Configuration() interface{}
  • func (aks *DataSource) DataSource() string
  • func (aks *DataSource) LocalName() string
• type DataStreamModeDetailsAttributes
  • func (smd DataStreamModeDetailsAttributes) InternalRef() (terra.Reference, error)
  • func (smd DataStreamModeDetailsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (smd DataStreamModeDetailsAttributes) InternalWithRef(ref terra.Reference) DataStreamModeDetailsAttributes
  • func (smd DataStreamModeDetailsAttributes) StreamMode() terra.StringValue
• type DataStreamModeDetailsState
• type Resource
  • func New(name string, args Args) *Resource
  • func (aks *Resource) Attributes() awsKinesisStreamAttributes
  • func (aks *Resource) Configuration() interface{}
  • func (aks *Resource) DependOn() terra.Reference
  • func (aks *Resource) Dependencies() terra.Dependencies
  • func (aks *Resource) ImportState(state io.Reader) error
  • func (aks *Resource) LifecycleManagement() *terra.Lifecycle
  • func (aks *Resource) LocalName() string
  • func (aks *Resource) State() (*awsKinesisStreamState, bool)
  • func (aks *Resource) StateMust() *awsKinesisStreamState
  • func (aks *Resource) Type() string
• type StreamModeDetails
• type StreamModeDetailsAttributes
  • func (smd StreamModeDetailsAttributes) InternalRef() (terra.Reference, error)
  • func (smd StreamModeDetailsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (smd StreamModeDetailsAttributes) InternalWithRef(ref terra.Reference) StreamModeDetailsAttributes
  • func (smd StreamModeDetailsAttributes) StreamMode() terra.StringValue
• type StreamModeDetailsState
• type Timeouts
• type TimeoutsAttributes
  • func (t TimeoutsAttributes) Create() terra.StringValue
  • func (t TimeoutsAttributes) Delete() terra.StringValue
  • func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)
  • func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes
  • func (t TimeoutsAttributes) Update() terra.StringValue
• type TimeoutsState

Types

type Args

type Args struct {
	// Arn: string, optional
	Arn terra.StringValue `hcl:"arn,attr"`
	// EncryptionType: string, optional
	EncryptionType terra.StringValue `hcl:"encryption_type,attr"`
	// EnforceConsumerDeletion: bool, optional
	EnforceConsumerDeletion terra.BoolValue `hcl:"enforce_consumer_deletion,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// KmsKeyId: string, optional
	KmsKeyId terra.StringValue `hcl:"kms_key_id,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// RetentionPeriod: number, optional
	RetentionPeriod terra.NumberValue `hcl:"retention_period,attr"`
	// ShardCount: number, optional
	ShardCount terra.NumberValue `hcl:"shard_count,attr"`
	// ShardLevelMetrics: set of string, optional
	ShardLevelMetrics terra.SetValue[terra.StringValue] `hcl:"shard_level_metrics,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"`
	// StreamModeDetails: optional
	StreamModeDetails *StreamModeDetails `hcl:"stream_mode_details,block"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for aws_kinesis_stream.

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"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
}

DataArgs contains the configurations for aws_kinesis_stream.

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource aws_kinesis_stream.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (aks *DataSource) Attributes() dataAwsKinesisStreamAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

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

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (aks *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (aks *DataSource) LocalName() string

LocalName returns the local name for DataSource.

type DataStreamModeDetailsAttributes

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

func (DataStreamModeDetailsAttributes) InternalRef

func (smd DataStreamModeDetailsAttributes) InternalRef() (terra.Reference, error)

func (DataStreamModeDetailsAttributes) InternalTokens

func (smd DataStreamModeDetailsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (DataStreamModeDetailsAttributes) InternalWithRef

func (smd DataStreamModeDetailsAttributes) InternalWithRef(ref terra.Reference) DataStreamModeDetailsAttributes

func (DataStreamModeDetailsAttributes) StreamMode

func (smd DataStreamModeDetailsAttributes) StreamMode() terra.StringValue

type DataStreamModeDetailsState

type DataStreamModeDetailsState struct {
	StreamMode string `json:"stream_mode"`
}

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

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (aks *Resource) Attributes() awsKinesisStreamAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (aks *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (aks *Resource) State() (*awsKinesisStreamState, bool)

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

func (*Resource) StateMust

func (aks *Resource) StateMust() *awsKinesisStreamState

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

func (*Resource) Type

func (aks *Resource) Type() string

Type returns the Terraform object type for Resource.

type StreamModeDetails

type StreamModeDetails struct {
	// StreamMode: string, required
	StreamMode terra.StringValue `hcl:"stream_mode,attr" validate:"required"`
}

type StreamModeDetailsAttributes

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

func (StreamModeDetailsAttributes) InternalRef

func (smd StreamModeDetailsAttributes) InternalRef() (terra.Reference, error)

func (StreamModeDetailsAttributes) InternalTokens

func (smd StreamModeDetailsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (StreamModeDetailsAttributes) InternalWithRef

func (smd StreamModeDetailsAttributes) InternalWithRef(ref terra.Reference) StreamModeDetailsAttributes

func (StreamModeDetailsAttributes) StreamMode

func (smd StreamModeDetailsAttributes) StreamMode() terra.StringValue

type StreamModeDetailsState

type StreamModeDetailsState struct {
	StreamMode string `json:"stream_mode"`
}

type Timeouts

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

type TimeoutsAttributes

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

func (TimeoutsAttributes) Create

func (t TimeoutsAttributes) Create() terra.StringValue

func (TimeoutsAttributes) Delete

func (t TimeoutsAttributes) Delete() 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

func (TimeoutsAttributes) Update

func (t TimeoutsAttributes) Update() terra.StringValue

type TimeoutsState

type TimeoutsState struct {
	Create string `json:"create"`
	Delete string `json:"delete"`
	Update string `json:"update"`
}