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