dynamodb

package
v0.16.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 22, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetTableArgs 

type GetTableArgs struct {
	// The name of the DynamoDB table.
	Name                 interface{}
	ServerSideEncryption interface{}
	Tags                 interface{}
}

A collection of arguments for invoking getTable.

type GetTableResult 

type GetTableResult struct {
	Arn                    interface{}
	Attributes             interface{}
	BillingMode            interface{}
	GlobalSecondaryIndexes interface{}
	HashKey                interface{}
	LocalSecondaryIndexes  interface{}
	PointInTimeRecovery    interface{}
	RangeKey               interface{}
	ReadCapacity           interface{}
	ServerSideEncryption   interface{}
	StreamArn              interface{}
	StreamEnabled          interface{}
	StreamLabel            interface{}
	StreamViewType         interface{}
	Tags                   interface{}
	Ttl                    interface{}
	WriteCapacity          interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getTable.

func LookupTable 

func LookupTable(ctx *pulumi.Context, args *GetTableArgs) (*GetTableResult, error)

Provides information about a DynamoDB table.

type GlobalTable 

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

Provides a resource to manage a DynamoDB Global Table. These are layered on top of existing DynamoDB Tables.

> Note: There are many restrictions before you can properly create DynamoDB Global Tables in multiple regions. See the [AWS DynamoDB Global Table Requirements](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables_reqs_bestpractices.html) for more information.

func GetGlobalTable 

func GetGlobalTable(ctx *pulumi.Context,
	name string, id pulumi.ID, state *GlobalTableState, opts ...pulumi.ResourceOpt) (*GlobalTable, error)

GetGlobalTable gets an existing GlobalTable resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGlobalTable 

func NewGlobalTable(ctx *pulumi.Context,
	name string, args *GlobalTableArgs, opts ...pulumi.ResourceOpt) (*GlobalTable, error)

NewGlobalTable registers a new resource with the given unique name, arguments, and options.

func (*GlobalTable) Arn 

func (r *GlobalTable) Arn() *pulumi.StringOutput

The ARN of the DynamoDB Global Table

func (*GlobalTable) ID 

func (r *GlobalTable) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*GlobalTable) Name 

func (r *GlobalTable) Name() *pulumi.StringOutput

The name of the global table. Must match underlying DynamoDB Table names in all regions.

func (*GlobalTable) Replicas 

func (r *GlobalTable) Replicas() *pulumi.ArrayOutput

Underlying DynamoDB Table. At least 1 replica must be defined. See below.

func (*GlobalTable) URN 

func (r *GlobalTable) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type GlobalTableArgs 

type GlobalTableArgs struct {
	// The name of the global table. Must match underlying DynamoDB Table names in all regions.
	Name interface{}
	// Underlying DynamoDB Table. At least 1 replica must be defined. See below.
	Replicas interface{}
}

The set of arguments for constructing a GlobalTable resource.

type GlobalTableState 

type GlobalTableState struct {
	// The ARN of the DynamoDB Global Table
	Arn interface{}
	// The name of the global table. Must match underlying DynamoDB Table names in all regions.
	Name interface{}
	// Underlying DynamoDB Table. At least 1 replica must be defined. See below.
	Replicas interface{}
}

Input properties used for looking up and filtering GlobalTable resources.

type Table 

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

Provides a DynamoDB table resource

> **Note:** It is recommended to use `lifecycle` [`ignore_changes`](https://www.terraform.io/docs/configuration/resources.html#ignore_changes) for `read_capacity` and/or `write_capacity` if there's [autoscaling policy](https://www.terraform.io/docs/providers/aws/r/appautoscaling_policy.html) attached to the table.

func GetTable 

func GetTable(ctx *pulumi.Context,
	name string, id pulumi.ID, state *TableState, opts ...pulumi.ResourceOpt) (*Table, error)

GetTable gets an existing Table resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTable 

func NewTable(ctx *pulumi.Context,
	name string, args *TableArgs, opts ...pulumi.ResourceOpt) (*Table, error)

NewTable registers a new resource with the given unique name, arguments, and options.

func (*Table) Arn 

func (r *Table) Arn() *pulumi.StringOutput

The arn of the table

func (*Table) Attributes 

func (r *Table) Attributes() *pulumi.ArrayOutput

List of nested attribute definitions. Only required for `hash_key` and `range_key` attributes. Each attribute has two properties:

func (*Table) BillingMode added in v0.16.4 

func (r *Table) BillingMode() *pulumi.StringOutput

Controls how you are charged for read and write throughput and how you manage capacity. The valid values are `PROVISIONED` and `PAY_PER_REQUEST`. Defaults to `PROVISIONED`.

func (*Table) GlobalSecondaryIndexes 

func (r *Table) GlobalSecondaryIndexes() *pulumi.ArrayOutput

Describe a GSI for the table; subject to the normal limits on the number of GSIs, projected attributes, etc.

func (*Table) HashKey 

func (r *Table) HashKey() *pulumi.StringOutput

The name of the hash key in the index; must be defined as an attribute in the resource.

func (*Table) ID 

func (r *Table) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Table) LocalSecondaryIndexes 

func (r *Table) LocalSecondaryIndexes() *pulumi.ArrayOutput

Describe an LSI on the table; these can only be allocated *at creation* so you cannot change this definition after you have created the resource.

func (*Table) Name 

func (r *Table) Name() *pulumi.StringOutput

The name of the index

func (*Table) PointInTimeRecovery 

func (r *Table) PointInTimeRecovery() *pulumi.Output

Point-in-time recovery options.

func (*Table) RangeKey 

func (r *Table) RangeKey() *pulumi.StringOutput

The name of the range key; must be defined

func (*Table) ReadCapacity 

func (r *Table) ReadCapacity() *pulumi.IntOutput

The number of read units for this index. Must be set if billing_mode is set to PROVISIONED.

func (*Table) ServerSideEncryption 

func (r *Table) ServerSideEncryption() *pulumi.Output

Encryption at rest options. AWS DynamoDB tables are automatically encrypted at rest with an AWS owned Customer Master Key if this argument isn't specified.

func (*Table) StreamArn 

func (r *Table) StreamArn() *pulumi.StringOutput

The ARN of the Table Stream. Only available when `stream_enabled = true`

func (*Table) StreamEnabled 

func (r *Table) StreamEnabled() *pulumi.BoolOutput

Indicates whether Streams are to be enabled (true) or disabled (false).

func (*Table) StreamLabel 

func (r *Table) StreamLabel() *pulumi.StringOutput

A timestamp, in ISO 8601 format, for this stream. Note that this timestamp is not a unique identifier for the stream on its own. However, the combination of AWS customer ID, table name and this field is guaranteed to be unique. It can be used for creating CloudWatch Alarms. Only available when `stream_enabled = true`

func (*Table) StreamViewType 

func (r *Table) StreamViewType() *pulumi.StringOutput

When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values are `KEYS_ONLY`, `NEW_IMAGE`, `OLD_IMAGE`, `NEW_AND_OLD_IMAGES`.

func (*Table) Tags 

func (r *Table) Tags() *pulumi.MapOutput

A map of tags to populate on the created table.

func (*Table) Ttl 

func (r *Table) Ttl() *pulumi.Output

Defines ttl, has two properties, and can only be specified once:

func (*Table) URN 

func (r *Table) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Table) WriteCapacity 

func (r *Table) WriteCapacity() *pulumi.IntOutput

The number of write units for this index. Must be set if billing_mode is set to PROVISIONED.

type TableArgs 

type TableArgs struct {
	// List of nested attribute definitions. Only required for `hash_key` and `range_key` attributes. Each attribute has two properties:
	Attributes interface{}
	// Controls how you are charged for read and write throughput and how you manage capacity. The valid values are `PROVISIONED` and `PAY_PER_REQUEST`. Defaults to `PROVISIONED`.
	BillingMode interface{}
	// Describe a GSI for the table;
	// subject to the normal limits on the number of GSIs, projected
	// attributes, etc.
	GlobalSecondaryIndexes interface{}
	// The name of the hash key in the index; must be
	// defined as an attribute in the resource.
	HashKey interface{}
	// Describe an LSI on the table;
	// these can only be allocated *at creation* so you cannot change this
	// definition after you have created the resource.
	LocalSecondaryIndexes interface{}
	// The name of the index
	Name interface{}
	// Point-in-time recovery options.
	PointInTimeRecovery interface{}
	// The name of the range key; must be defined
	RangeKey interface{}
	// The number of read units for this index. Must be set if billing_mode is set to PROVISIONED.
	ReadCapacity interface{}
	// Encryption at rest options. AWS DynamoDB tables are automatically encrypted at rest with an AWS owned Customer Master Key if this argument isn't specified.
	ServerSideEncryption interface{}
	// Indicates whether Streams are to be enabled (true) or disabled (false).
	StreamEnabled interface{}
	// When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values are `KEYS_ONLY`, `NEW_IMAGE`, `OLD_IMAGE`, `NEW_AND_OLD_IMAGES`.
	StreamViewType interface{}
	// A map of tags to populate on the created table.
	Tags interface{}
	// Defines ttl, has two properties, and can only be specified once:
	Ttl interface{}
	// The number of write units for this index. Must be set if billing_mode is set to PROVISIONED.
	WriteCapacity interface{}
}

The set of arguments for constructing a Table resource.

type TableItem 

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

Provides a DynamoDB table item resource

> **Note:** This resource is not meant to be used for managing large amounts of data in your table, it is not designed to scale. 

You should perform **regular backups** of all data in the table, see [AWS docs for more](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html).

func GetTableItem 

func GetTableItem(ctx *pulumi.Context,
	name string, id pulumi.ID, state *TableItemState, opts ...pulumi.ResourceOpt) (*TableItem, error)

GetTableItem gets an existing TableItem resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTableItem 

func NewTableItem(ctx *pulumi.Context,
	name string, args *TableItemArgs, opts ...pulumi.ResourceOpt) (*TableItem, error)

NewTableItem registers a new resource with the given unique name, arguments, and options.

func (*TableItem) HashKey 

func (r *TableItem) HashKey() *pulumi.StringOutput

Hash key to use for lookups and identification of the item

func (*TableItem) ID 

func (r *TableItem) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*TableItem) Item 

func (r *TableItem) Item() *pulumi.StringOutput

JSON representation of a map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

func (*TableItem) RangeKey 

func (r *TableItem) RangeKey() *pulumi.StringOutput

Range key to use for lookups and identification of the item. Required if there is range key defined in the table.

func (*TableItem) TableName 

func (r *TableItem) TableName() *pulumi.StringOutput

The name of the table to contain the item.

func (*TableItem) URN 

func (r *TableItem) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type TableItemArgs 

type TableItemArgs struct {
	// Hash key to use for lookups and identification of the item
	HashKey interface{}
	// JSON representation of a map of attribute name/value pairs, one for each attribute.
	// Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
	Item interface{}
	// Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
	RangeKey interface{}
	// The name of the table to contain the item.
	TableName interface{}
}

The set of arguments for constructing a TableItem resource.

type TableItemState 

type TableItemState struct {
	// Hash key to use for lookups and identification of the item
	HashKey interface{}
	// JSON representation of a map of attribute name/value pairs, one for each attribute.
	// Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
	Item interface{}
	// Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
	RangeKey interface{}
	// The name of the table to contain the item.
	TableName interface{}
}

Input properties used for looking up and filtering TableItem resources.

type TableState 

type TableState struct {
	// The arn of the table
	Arn interface{}
	// List of nested attribute definitions. Only required for `hash_key` and `range_key` attributes. Each attribute has two properties:
	Attributes interface{}
	// Controls how you are charged for read and write throughput and how you manage capacity. The valid values are `PROVISIONED` and `PAY_PER_REQUEST`. Defaults to `PROVISIONED`.
	BillingMode interface{}
	// Describe a GSI for the table;
	// subject to the normal limits on the number of GSIs, projected
	// attributes, etc.
	GlobalSecondaryIndexes interface{}
	// The name of the hash key in the index; must be
	// defined as an attribute in the resource.
	HashKey interface{}
	// Describe an LSI on the table;
	// these can only be allocated *at creation* so you cannot change this
	// definition after you have created the resource.
	LocalSecondaryIndexes interface{}
	// The name of the index
	Name interface{}
	// Point-in-time recovery options.
	PointInTimeRecovery interface{}
	// The name of the range key; must be defined
	RangeKey interface{}
	// The number of read units for this index. Must be set if billing_mode is set to PROVISIONED.
	ReadCapacity interface{}
	// Encryption at rest options. AWS DynamoDB tables are automatically encrypted at rest with an AWS owned Customer Master Key if this argument isn't specified.
	ServerSideEncryption interface{}
	// The ARN of the Table Stream. Only available when `stream_enabled = true`
	StreamArn interface{}
	// Indicates whether Streams are to be enabled (true) or disabled (false).
	StreamEnabled interface{}
	// A timestamp, in ISO 8601 format, for this stream. Note that this timestamp is not
	// a unique identifier for the stream on its own. However, the combination of AWS customer ID,
	// table name and this field is guaranteed to be unique.
	// It can be used for creating CloudWatch Alarms. Only available when `stream_enabled = true`
	StreamLabel interface{}
	// When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values are `KEYS_ONLY`, `NEW_IMAGE`, `OLD_IMAGE`, `NEW_AND_OLD_IMAGES`.
	StreamViewType interface{}
	// A map of tags to populate on the created table.
	Tags interface{}
	// Defines ttl, has two properties, and can only be specified once:
	Ttl interface{}
	// The number of write units for this index. Must be set if billing_mode is set to PROVISIONED.
	WriteCapacity interface{}
}

Input properties used for looking up and filtering Table resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.