Network.AWS.DynamoDB.CreateTable

The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable API to check the table status.

Creating a Request

createTable

Arguments

:: Text

ctTableName

-> NonEmpty KeySchemaElement

ctKeySchema

-> ProvisionedThroughput

ctProvisionedThroughput

-> CreateTable

Creates a value of CreateTable with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ctGlobalSecondaryIndexes
• ctLocalSecondaryIndexes
• ctStreamSpecification
• ctAttributeDefinitions
• ctTableName
• ctKeySchema
• ctProvisionedThroughput

data CreateTable

Represents the input of a CreateTable operation.

See: createTable smart constructor.

Instances

Eq CreateTable

Methods

(==) :: CreateTable -> CreateTable -> Bool

(/=) :: CreateTable -> CreateTable -> Bool

Data CreateTable

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateTable -> c CreateTable

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateTable

toConstr :: CreateTable -> Constr

dataTypeOf :: CreateTable -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateTable)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateTable)

gmapT :: (forall b. Data b => b -> b) -> CreateTable -> CreateTable

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateTable -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateTable -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateTable -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateTable -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateTable -> m CreateTable

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateTable -> m CreateTable

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateTable -> m CreateTable

Read CreateTable

Methods

readsPrec :: Int -> ReadS CreateTable

readList :: ReadS [CreateTable]

readPrec :: ReadPrec CreateTable

readListPrec :: ReadPrec [CreateTable]

Show CreateTable

Methods

showsPrec :: Int -> CreateTable -> ShowS

show :: CreateTable -> String

showList :: [CreateTable] -> ShowS

Generic CreateTable

Associated Types

type Rep CreateTable :: * -> *

Methods

from :: CreateTable -> Rep CreateTable x

to :: Rep CreateTable x -> CreateTable

Hashable CreateTable

Methods

hashWithSalt :: Int -> CreateTable -> Int

hash :: CreateTable -> Int

ToJSON CreateTable

Methods

toJSON :: CreateTable -> Value

toEncoding :: CreateTable -> Encoding

toJSONList :: [CreateTable] -> Value

toEncodingList :: [CreateTable] -> Encoding

NFData CreateTable

Methods

rnf :: CreateTable -> ()

AWSRequest CreateTable

Associated Types

type Rs CreateTable :: *

Methods

request :: CreateTable -> Request CreateTable

response :: MonadResource m => Logger -> Service -> Proxy * CreateTable -> ClientResponse -> m (Response CreateTable)

ToQuery CreateTable

Methods

toQuery :: CreateTable -> QueryString

ToPath CreateTable

Methods

toPath :: CreateTable -> ByteString

ToHeaders CreateTable

Methods

toHeaders :: CreateTable -> [Header]

type Rep CreateTable

type Rep CreateTable = D1 (MetaData "CreateTable" "Network.AWS.DynamoDB.CreateTable" "amazonka-dynamodb-1.4.1-EDJMnsbTy8jB9EiV7kUT3s" False) (C1 (MetaCons "CreateTable'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ctGlobalSecondaryIndexes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GlobalSecondaryIndex]))) ((:*:) (S1 (MetaSel (Just Symbol "_ctLocalSecondaryIndexes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [LocalSecondaryIndex]))) (S1 (MetaSel (Just Symbol "_ctStreamSpecification") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StreamSpecification))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ctAttributeDefinitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [AttributeDefinition])) (S1 (MetaSel (Just Symbol "_ctTableName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ctKeySchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 KeySchemaElement))) (S1 (MetaSel (Just Symbol "_ctProvisionedThroughput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ProvisionedThroughput))))))

type Rs CreateTable

type Rs CreateTable = CreateTableResponse

Request Lenses

ctGlobalSecondaryIndexes :: Lens' CreateTable [GlobalSecondaryIndex]

One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:

• IndexName - The name of the global secondary index. Must be unique only for this table.
• KeySchema - Specifies the key schema for the global secondary index.

• Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

  • ProjectionType - One of the following:

    • KEYS_ONLY - Only the index and primary keys are projected into the index.
    • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
    • ALL - All of the table attributes are projected into the index.
  • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
• ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

ctLocalSecondaryIndexes :: Lens' CreateTable [LocalSecondaryIndex]

One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

• IndexName - The name of the local secondary index. Must be unique only for this table.
• KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

• Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

  • ProjectionType - One of the following:

    • KEYS_ONLY - Only the index and primary keys are projected into the index.
    • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
    • ALL - All of the table attributes are projected into the index.
  • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

ctStreamSpecification :: Lens' CreateTable (Maybe StreamSpecification)

The settings for DynamoDB Streams on the table. These settings consist of:

• StreamEnabled - Indicates whether Streams is to be enabled (true) or disabled (false).

• StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

  • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
  • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
  • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
  • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

ctAttributeDefinitions :: Lens' CreateTable [AttributeDefinition]

An array of attributes that describe the key schema for the table and indexes.

ctTableName :: Lens' CreateTable Text

The name of the table to create.

ctKeySchema :: Lens' CreateTable (NonEmpty KeySchemaElement)

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

• AttributeName - The name of this key attribute.

• KeyType - The role that the key attribute will assume:

  • HASH - partition key
  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.

ctProvisionedThroughput :: Lens' CreateTable ProvisionedThroughput

Undocumented member.

Destructuring the Response

createTableResponse

Arguments

:: Int

ctrsResponseStatus

-> CreateTableResponse

Creates a value of CreateTableResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ctrsTableDescription
• ctrsResponseStatus

data CreateTableResponse

Represents the output of a CreateTable operation.

See: createTableResponse smart constructor.

Instances

Eq CreateTableResponse

Methods

(==) :: CreateTableResponse -> CreateTableResponse -> Bool

(/=) :: CreateTableResponse -> CreateTableResponse -> Bool

Data CreateTableResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateTableResponse -> c CreateTableResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateTableResponse

toConstr :: CreateTableResponse -> Constr

dataTypeOf :: CreateTableResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateTableResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateTableResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateTableResponse -> CreateTableResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateTableResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateTableResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateTableResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateTableResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateTableResponse -> m CreateTableResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateTableResponse -> m CreateTableResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateTableResponse -> m CreateTableResponse

Read CreateTableResponse

Methods

readsPrec :: Int -> ReadS CreateTableResponse

readList :: ReadS [CreateTableResponse]

readPrec :: ReadPrec CreateTableResponse

readListPrec :: ReadPrec [CreateTableResponse]

Show CreateTableResponse

Methods

showsPrec :: Int -> CreateTableResponse -> ShowS

show :: CreateTableResponse -> String

showList :: [CreateTableResponse] -> ShowS

Generic CreateTableResponse

Associated Types

type Rep CreateTableResponse :: * -> *

Methods

from :: CreateTableResponse -> Rep CreateTableResponse x

to :: Rep CreateTableResponse x -> CreateTableResponse

NFData CreateTableResponse

Methods

rnf :: CreateTableResponse -> ()

type Rep CreateTableResponse

type Rep CreateTableResponse = D1 (MetaData "CreateTableResponse" "Network.AWS.DynamoDB.CreateTable" "amazonka-dynamodb-1.4.1-EDJMnsbTy8jB9EiV7kUT3s" False) (C1 (MetaCons "CreateTableResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ctrsTableDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TableDescription))) (S1 (MetaSel (Just Symbol "_ctrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ctrsTableDescription :: Lens' CreateTableResponse (Maybe TableDescription)

Undocumented member.

ctrsResponseStatus :: Lens' CreateTableResponse Int

The response status code.