github.com/nevins-b/terraform@v0.3.8-0.20170215184714-bbae22007d5a/website/source/docs/providers/aws/r/dynamodb_table.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: dynamodb_table"
     4  sidebar_current: "docs-aws-resource-dynamodb-table"
     5  description: |-
     6    Provides a DynamoDB table resource
     7  ---
     8  
     9  # aws\_dynamodb\_table
    10  
    11  Provides a DynamoDB table resource
    12  
    13  ## Example Usage
    14  
    15  The following dynamodb table description models the table and GSI shown
    16  in the [AWS SDK example documentation](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.html)
    17  
    18  ```
    19  resource "aws_dynamodb_table" "basic-dynamodb-table" {
    20      name = "GameScores"
    21      read_capacity = 20
    22      write_capacity = 20
    23      hash_key = "UserId"
    24      range_key = "GameTitle"
    25      attribute {
    26        name = "UserId"
    27        type = "S"
    28      }
    29      attribute {
    30        name = "GameTitle"
    31        type = "S"
    32      }
    33      attribute {
    34        name = "TopScore"
    35        type = "N"
    36      }
    37      global_secondary_index {
    38        name = "GameTitleIndex"
    39        hash_key = "GameTitle"
    40        range_key = "TopScore"
    41        write_capacity = 10
    42        read_capacity = 10
    43        projection_type = "INCLUDE"
    44        non_key_attributes = [ "UserId" ]
    45      }
    46      tags {
    47        Name = "dynamodb-table-1"
    48        Environment = "production"
    49      }
    50  }
    51  ```
    52  
    53  ## Argument Reference
    54  
    55  The following arguments are supported:
    56  
    57  * `name` - (Required) The name of the table, this needs to be unique
    58    within a region.
    59  * `read_capacity` - (Required) The number of read units for this table
    60  * `write_capacity` - (Required) The number of write units for this table
    61  * `hash_key` - (Required, Forces new resource) The attribute to use as the hash key (the
    62    attribute must also be defined as an attribute record
    63  * `range_key` - (Optional, Forces new resource) The attribute to use as the range key (must
    64    also be defined)
    65  * `attribute` - Define an attribute, has two properties:
    66    * `name` - The name of the attribute
    67    * `type` - One of: S, N, or B for (S)tring, (N)umber or (B)inary data
    68  * `stream_enabled` - (Optional) Indicates whether Streams are to be enabled (true) or disabled (false).
    69  * `stream_view_type` - (Optional) 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.
    70  * `local_secondary_index` - (Optional, Forces new resource) Describe an LSI on the table;
    71    these can only be allocated *at creation* so you cannot change this
    72  definition after you have created the resource.
    73  * `global_secondary_index` - (Optional) Describe a GSO for the table;
    74    subject to the normal limits on the number of GSIs, projected
    75  attributes, etc.
    76  * `tags` - (Optional) A map of tags to populate on the created table.
    77  
    78  For both `local_secondary_index` and `global_secondary_index` objects,
    79  the following properties are supported:
    80  
    81  * `name` - (Required) The name of the LSI or GSI
    82  * `hash_key` - (Required for GSI) The name of the hash key in the index; must be
    83  defined as an attribute in the resource. Only applies to
    84    `global_secondary_index`
    85  * `range_key` - (Required) The name of the range key; must be defined
    86  * `projection_type` - (Required) One of "ALL", "INCLUDE" or "KEYS_ONLY"
    87     where *ALL* projects every attribute into the index, *KEYS_ONLY*
    88      projects just the hash and range key into the index, and *INCLUDE*
    89      projects only the keys specified in the _non_key_attributes_
    90  parameter.
    91  * `non_key_attributes` - (Optional) Only required with *INCLUDE* as a
    92    projection type; a list of attributes to project into the index. These
    93  do not need to be defined as attributes on the table.
    94  
    95  For `global_secondary_index` objects only, you need to specify
    96  `write_capacity` and `read_capacity` in the same way you would for the
    97  table as they have separate I/O capacity.
    98  
    99  ### A note about attributes
   100  
   101  Only define attributes on the table object that are going to be used as:
   102  
   103  * Table hash key or range key
   104  * LSI or GSI hash key or range key
   105  
   106  The DynamoDB API expects attribute structure (name and type) to be
   107  passed along when creating or updating GSI/LSIs or creating the initial
   108  table. In these cases it expects the Hash / Range keys to be provided;
   109  because these get re-used in numerous places (i.e the table's range key
   110  could be a part of one or more GSIs), they are stored on the table
   111  object to prevent duplication and increase consistency. If you add
   112  attributes here that are not used in these scenarios it can cause an
   113  infinite loop in planning.
   114  
   115  
   116  ## Attributes Reference
   117  
   118  The following attributes are exported:
   119  
   120  * `arn` - The arn of the table
   121  * `id` - The name of the table
   122  * `stream_arn` - The ARN of the Table Stream. Only available when `stream_enabled = true`
   123  
   124  
   125  ## Import
   126  
   127  DynamoDB tables can be imported using the `name`, e.g. 
   128  
   129  ```
   130  $ terraform import aws_dynamodb_table.basic-dynamodb-table GameScores
   131  ```