Docs
PackagesTry AWS Native preview for resources not in the classic version.
aws.dynamodb.TableItem
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
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.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleTable = new Aws.DynamoDB.Table("exampleTable", new()
{
ReadCapacity = 10,
WriteCapacity = 10,
HashKey = "exampleHashKey",
Attributes = new[]
{
new Aws.DynamoDB.Inputs.TableAttributeArgs
{
Name = "exampleHashKey",
Type = "S",
},
},
});
var exampleTableItem = new Aws.DynamoDB.TableItem("exampleTableItem", new()
{
TableName = exampleTable.Name,
HashKey = exampleTable.HashKey,
Item = @"{
""exampleHashKey"": {""S"": ""something""},
""one"": {""N"": ""11111""},
""two"": {""N"": ""22222""},
""three"": {""N"": ""33333""},
""four"": {""N"": ""44444""}
}
",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dynamodb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleTable, err := dynamodb.NewTable(ctx, "exampleTable", &dynamodb.TableArgs{
ReadCapacity: pulumi.Int(10),
WriteCapacity: pulumi.Int(10),
HashKey: pulumi.String("exampleHashKey"),
Attributes: dynamodb.TableAttributeArray{
&dynamodb.TableAttributeArgs{
Name: pulumi.String("exampleHashKey"),
Type: pulumi.String("S"),
},
},
})
if err != nil {
return err
}
_, err = dynamodb.NewTableItem(ctx, "exampleTableItem", &dynamodb.TableItemArgs{
TableName: exampleTable.Name,
HashKey: exampleTable.HashKey,
Item: pulumi.String(`{
"exampleHashKey": {"S": "something"},
"one": {"N": "11111"},
"two": {"N": "22222"},
"three": {"N": "33333"},
"four": {"N": "44444"}
}
`),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dynamodb.Table;
import com.pulumi.aws.dynamodb.TableArgs;
import com.pulumi.aws.dynamodb.inputs.TableAttributeArgs;
import com.pulumi.aws.dynamodb.TableItem;
import com.pulumi.aws.dynamodb.TableItemArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleTable = new Table("exampleTable", TableArgs.builder()
.readCapacity(10)
.writeCapacity(10)
.hashKey("exampleHashKey")
.attributes(TableAttributeArgs.builder()
.name("exampleHashKey")
.type("S")
.build())
.build());
var exampleTableItem = new TableItem("exampleTableItem", TableItemArgs.builder()
.tableName(exampleTable.name())
.hashKey(exampleTable.hashKey())
.item("""
{
"exampleHashKey": {"S": "something"},
"one": {"N": "11111"},
"two": {"N": "22222"},
"three": {"N": "33333"},
"four": {"N": "44444"}
}
""")
.build());
}
}
import pulumi
import pulumi_aws as aws
example_table = aws.dynamodb.Table("exampleTable",
read_capacity=10,
write_capacity=10,
hash_key="exampleHashKey",
attributes=[aws.dynamodb.TableAttributeArgs(
name="exampleHashKey",
type="S",
)])
example_table_item = aws.dynamodb.TableItem("exampleTableItem",
table_name=example_table.name,
hash_key=example_table.hash_key,
item="""{
"exampleHashKey": {"S": "something"},
"one": {"N": "11111"},
"two": {"N": "22222"},
"three": {"N": "33333"},
"four": {"N": "44444"}
}
""")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleTable = new aws.dynamodb.Table("exampleTable", {
readCapacity: 10,
writeCapacity: 10,
hashKey: "exampleHashKey",
attributes: [{
name: "exampleHashKey",
type: "S",
}],
});
const exampleTableItem = new aws.dynamodb.TableItem("exampleTableItem", {
tableName: exampleTable.name,
hashKey: exampleTable.hashKey,
item: `{
"exampleHashKey": {"S": "something"},
"one": {"N": "11111"},
"two": {"N": "22222"},
"three": {"N": "33333"},
"four": {"N": "44444"}
}
`,
});
resources:
exampleTableItem:
type: aws:dynamodb:TableItem
properties:
tableName: ${exampleTable.name}
hashKey: ${exampleTable.hashKey}
item: |
{
"exampleHashKey": {"S": "something"},
"one": {"N": "11111"},
"two": {"N": "22222"},
"three": {"N": "33333"},
"four": {"N": "44444"}
}
exampleTable:
type: aws:dynamodb:Table
properties:
readCapacity: 10
writeCapacity: 10
hashKey: exampleHashKey
attributes:
- name: exampleHashKey
type: S
Create TableItem Resource
new TableItem(name: string, args: TableItemArgs, opts?: CustomResourceOptions);@overload
def TableItem(resource_name: str,
opts: Optional[ResourceOptions] = None,
hash_key: Optional[str] = None,
item: Optional[str] = None,
range_key: Optional[str] = None,
table_name: Optional[str] = None)
@overload
def TableItem(resource_name: str,
args: TableItemArgs,
opts: Optional[ResourceOptions] = None)func NewTableItem(ctx *Context, name string, args TableItemArgs, opts ...ResourceOption) (*TableItem, error)public TableItem(string name, TableItemArgs args, CustomResourceOptions? opts = null)
public TableItem(String name, TableItemArgs args)
public TableItem(String name, TableItemArgs args, CustomResourceOptions options)
type: aws:dynamodb:TableItem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TableItemArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TableItemArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TableItemArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TableItemArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TableItemArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
TableItem Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The TableItem resource accepts the following input properties:
- Hash
Key string Hash key to use for lookups and identification of the item
- Item string
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.
- Table
Name string Name of the table to contain the item.
- Range
Key string Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- Hash
Key string Hash key to use for lookups and identification of the item
- Item string
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.
- Table
Name string Name of the table to contain the item.
- Range
Key string Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- hash
Key String Hash key to use for lookups and identification of the item
- item String
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.
- table
Name String Name of the table to contain the item.
- range
Key String Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- hash
Key string Hash key to use for lookups and identification of the item
- item string
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.
- table
Name string Name of the table to contain the item.
- range
Key string Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- hash_
key str Hash key to use for lookups and identification of the item
- item str
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.
- table_
name str Name of the table to contain the item.
- range_
key str Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- hash
Key String Hash key to use for lookups and identification of the item
- item String
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.
- table
Name String Name of the table to contain the item.
- range
Key String Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
Outputs
All input properties are implicitly available as output properties. Additionally, the TableItem resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing TableItem Resource
Get an existing TableItem resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TableItemState, opts?: CustomResourceOptions): TableItem@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
hash_key: Optional[str] = None,
item: Optional[str] = None,
range_key: Optional[str] = None,
table_name: Optional[str] = None) -> TableItemfunc GetTableItem(ctx *Context, name string, id IDInput, state *TableItemState, opts ...ResourceOption) (*TableItem, error)public static TableItem Get(string name, Input<string> id, TableItemState? state, CustomResourceOptions? opts = null)public static TableItem get(String name, Output<String> id, TableItemState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Hash
Key string Hash key to use for lookups and identification of the item
- Item string
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.
- Range
Key string Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- Table
Name string Name of the table to contain the item.
- Hash
Key string Hash key to use for lookups and identification of the item
- Item string
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.
- Range
Key string Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- Table
Name string Name of the table to contain the item.
- hash
Key String Hash key to use for lookups and identification of the item
- item String
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.
- range
Key String Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- table
Name String Name of the table to contain the item.
- hash
Key string Hash key to use for lookups and identification of the item
- item string
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.
- range
Key string Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- table
Name string Name of the table to contain the item.
- hash_
key str Hash key to use for lookups and identification of the item
- item str
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.
- range_
key str Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- table_
name str Name of the table to contain the item.
- hash
Key String Hash key to use for lookups and identification of the item
- item String
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.
- range
Key String Range key to use for lookups and identification of the item. Required if there is range key defined in the table.
- table
Name String Name of the table to contain the item.
Import
You cannot import DynamoDB table items.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
awsTerraform Provider.
Try AWS Native preview for resources not in the classic version.