/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the dynamodb-2012-08-10.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.DynamoDBv2.Model
{
///
/// Container for the parameters to the CreateTable operation.
/// 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
action to check the table status.
///
///
public partial class CreateTableRequest : AmazonDynamoDBRequest
{
private List _attributeDefinitions = new List();
private BillingMode _billingMode;
private List _globalSecondaryIndexes = new List();
private List _keySchema = new List();
private List _localSecondaryIndexes = new List();
private ProvisionedThroughput _provisionedThroughput;
private SSESpecification _sseSpecification;
private StreamSpecification _streamSpecification;
private string _tableName;
private List _tags = new List();
///
/// Empty constructor used to set properties independently even when a simple constructor is available
///
public CreateTableRequest() { }
///
/// Instantiates CreateTableRequest with the parameterized properties
///
/// The name of the table to create.
/// 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 the 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 Working with Tables in the Amazon DynamoDB Developer Guide.
public CreateTableRequest(string tableName, List keySchema)
{
_tableName = tableName;
_keySchema = keySchema;
}
///
/// Instantiates CreateTableRequest with the parameterized properties
///
/// The name of the table to create.
/// 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 the 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 Working with Tables in the Amazon DynamoDB Developer Guide.
/// An array of attributes that describe the key schema for the table and indexes.
/// Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable
operation. If you set BillingMode as PROVISIONED
, you must specify this property. If you set BillingMode as PAY_PER_REQUEST
, you cannot specify this property. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
public CreateTableRequest(string tableName, List keySchema, List attributeDefinitions, ProvisionedThroughput provisionedThroughput)
{
_tableName = tableName;
_keySchema = keySchema;
_attributeDefinitions = attributeDefinitions;
_provisionedThroughput = provisionedThroughput;
}
///
/// Gets and sets the property AttributeDefinitions.
///
/// An array of attributes that describe the key schema for the table and indexes.
///
///
[AWSProperty(Required=true)]
public List AttributeDefinitions
{
get { return this._attributeDefinitions; }
set { this._attributeDefinitions = value; }
}
// Check to see if AttributeDefinitions property is set
internal bool IsSetAttributeDefinitions()
{
return this._attributeDefinitions != null && this._attributeDefinitions.Count > 0;
}
///
/// Gets and sets the property BillingMode.
///
/// Controls how you are charged for read and write throughput and how you manage capacity.
/// This setting can be changed later.
///
/// -
///
///
PROVISIONED
- We recommend using PROVISIONED
for predictable
/// workloads. PROVISIONED
sets the billing mode to Provisioned
/// Mode.
///
/// -
///
///
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for
/// unpredictable workloads. PAY_PER_REQUEST
sets the billing mode to On-Demand
/// Mode.
///
///
///
public BillingMode BillingMode
{
get { return this._billingMode; }
set { this._billingMode = value; }
}
// Check to see if BillingMode property is set
internal bool IsSetBillingMode()
{
return this._billingMode != null;
}
///
/// Gets and sets the property GlobalSecondaryIndexes.
///
/// One or more global secondary indexes (the maximum is 20) 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 is 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 100. 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.
///
///
///
public List GlobalSecondaryIndexes
{
get { return this._globalSecondaryIndexes; }
set { this._globalSecondaryIndexes = value; }
}
// Check to see if GlobalSecondaryIndexes property is set
internal bool IsSetGlobalSecondaryIndexes()
{
return this._globalSecondaryIndexes != null && this._globalSecondaryIndexes.Count > 0;
}
///
/// Gets and sets the property KeySchema.
///
/// 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 the 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 Working
/// with Tables in the Amazon DynamoDB Developer Guide.
///
///
[AWSProperty(Required=true, Min=1, Max=2)]
public List KeySchema
{
get { return this._keySchema; }
set { this._keySchema = value; }
}
// Check to see if KeySchema property is set
internal bool IsSetKeySchema()
{
return this._keySchema != null && this._keySchema.Count > 0;
}
///
/// Gets and sets the property LocalSecondaryIndexes.
///
/// One or more local secondary indexes (the maximum is 5) 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 is 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 100. If you project the same attribute into two different indexes, this counts
/// as two distinct attributes when determining the total.
///
///
///
public List LocalSecondaryIndexes
{
get { return this._localSecondaryIndexes; }
set { this._localSecondaryIndexes = value; }
}
// Check to see if LocalSecondaryIndexes property is set
internal bool IsSetLocalSecondaryIndexes()
{
return this._localSecondaryIndexes != null && this._localSecondaryIndexes.Count > 0;
}
///
/// Gets and sets the property ProvisionedThroughput.
///
/// Represents the provisioned throughput settings for a specified table or index. The
/// settings can be modified using the UpdateTable
operation.
///
///
///
/// If you set BillingMode as PROVISIONED
, you must specify this property.
/// If you set BillingMode as PAY_PER_REQUEST
, you cannot specify this property.
///
///
///
///
/// For current minimum and maximum provisioned throughput values, see Limits
/// in the Amazon DynamoDB Developer Guide.
///
///
public ProvisionedThroughput ProvisionedThroughput
{
get { return this._provisionedThroughput; }
set { this._provisionedThroughput = value; }
}
// Check to see if ProvisionedThroughput property is set
internal bool IsSetProvisionedThroughput()
{
return this._provisionedThroughput != null;
}
///
/// Gets and sets the property SSESpecification.
///
/// Represents the settings used to enable server-side encryption.
///
///
public SSESpecification SSESpecification
{
get { return this._sseSpecification; }
set { this._sseSpecification = value; }
}
// Check to see if SSESpecification property is set
internal bool IsSetSSESpecification()
{
return this._sseSpecification != null;
}
///
/// Gets and sets the property StreamSpecification.
///
/// The settings for DynamoDB Streams on the table. These settings consist of:
///
/// -
///
///
StreamEnabled
- Indicates whether DynamoDB 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.
///
///
///
public StreamSpecification StreamSpecification
{
get { return this._streamSpecification; }
set { this._streamSpecification = value; }
}
// Check to see if StreamSpecification property is set
internal bool IsSetStreamSpecification()
{
return this._streamSpecification != null;
}
///
/// Gets and sets the property TableName.
///
/// The name of the table to create.
///
///
[AWSProperty(Required=true, Min=3, Max=255)]
public string TableName
{
get { return this._tableName; }
set { this._tableName = value; }
}
// Check to see if TableName property is set
internal bool IsSetTableName()
{
return this._tableName != null;
}
///
/// Gets and sets the property Tags.
///
/// A list of key-value pairs to label the table. For more information, see Tagging
/// for DynamoDB.
///
///
public List Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
}
}