aws_dynamodb

account_id

Type: STRING

archival_summary

Type: STRUCT
Provider name: ArchivalSummary
Description: Contains information about the table archive.

  • archival_backup_arn
    Type: STRING
    Provider name: ArchivalBackupArn
    Description: The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
  • archival_date_time
    Type: TIMESTAMP
    Provider name: ArchivalDateTime
    Description: The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
  • archival_reason
    Type: STRING
    Provider name: ArchivalReason
    Description: The reason DynamoDB archived the table. Currently, the only possible value is:
    • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table’s KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.

attribute_definitions

Type: UNORDERED_LIST_STRUCT
Provider name: AttributeDefinitions
Description: An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema. Each AttributeDefinition object in this array is composed of:

  • AttributeName - The name of the attribute.
  • AttributeType - The data type for the attribute.

  • attribute_name
    Type: STRING
    Provider name: AttributeName
    Description: A name for the attribute.
  • attribute_type
    Type: STRING
    Provider name: AttributeType
    Description: The data type for the attribute, where:
    • S - the attribute is of type String
    • N - the attribute is of type Number
    • B - the attribute is of type Binary

billing_mode_summary

Type: STRUCT
Provider name: BillingModeSummary
Description: Contains the details for the read/write capacity mode.

  • billing_mode
    Type: STRING
    Provider name: BillingMode
    Description: Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
    • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
    • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
  • last_update_to_pay_per_request_date_time
    Type: TIMESTAMP
    Provider name: LastUpdateToPayPerRequestDateTime
    Description: Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

continuous_backups_description

Type: STRUCT
Provider name: ContinuousBackupsDescription
Description: Represents the continuous backups and point in time recovery settings on the table.

  • continuous_backups_status
    Type: STRING
    Provider name: ContinuousBackupsStatus
    Description: ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED
  • point_in_time_recovery_description
    Type: STRUCT
    Provider name: PointInTimeRecoveryDescription
    Description: The description of the point in time recovery settings applied to the table.
    • earliest_restorable_date_time
      Type: TIMESTAMP
      Provider name: EarliestRestorableDateTime
      Description: Specifies the earliest point in time you can restore your table to. You can restore your table to any point in time during the last 35 days.
    • latest_restorable_date_time
      Type: TIMESTAMP
      Provider name: LatestRestorableDateTime
      Description: LatestRestorableDateTime is typically 5 minutes before the current time.
    • point_in_time_recovery_status
      Type: STRING
      Provider name: PointInTimeRecoveryStatus
      Description: The current state of point in time recovery:
      • ENABLED - Point in time recovery is enabled.
      • DISABLED - Point in time recovery is disabled.

creation_date_time

Type: TIMESTAMP
Provider name: CreationDateTime
Description: The date and time when the table was created, in UNIX epoch time format.

deletion_protection_enabled

Type: BOOLEAN
Provider name: DeletionProtectionEnabled
Description: Indicates whether deletion protection is enabled (true) or disabled (false) on the table.

global_secondary_indexes

Type: UNORDERED_LIST_STRUCT
Provider name: GlobalSecondaryIndexes
Description: The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. If the table is in the DELETING state, no information about indexes will be returned.

  • backfilling
    Type: BOOLEAN
    Provider name: Backfilling
    Description: Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false. You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can’t delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
  • index_arn
    Type: STRING
    Provider name: IndexArn
    Description: The Amazon Resource Name (ARN) that uniquely identifies the index.
  • index_name
    Type: STRING
    Provider name: IndexName
    Description: The name of the global secondary index.
  • index_size_bytes
    Type: INT64
    Provider name: IndexSizeBytes
    Description: The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  • index_status
    Type: STRING
    Provider name: IndexStatus
    Description: The current state of the global secondary index:
    • CREATING - The index is being created.
    • UPDATING - The index is being updated.
    • DELETING - The index is being deleted.
    • ACTIVE - The index is ready for use.
  • item_count
    Type: INT64
    Provider name: ItemCount
    Description: The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  • key_schema
    Type: UNORDERED_LIST_STRUCT
    Provider name: KeySchema
    Description: The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
    • 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’s 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.
    • attribute_name
      Type: STRING
      Provider name: AttributeName
      Description: The name of a key attribute.
    • key_type
      Type: STRING
      Provider name: KeyType
      Description: The role that this 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’s 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.
  • projection
    Type: STRUCT
    Provider name: Projection
    Description: Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
    • non_key_attributes
      Type: UNORDERED_LIST_STRING
      Provider name: NonKeyAttributes
      Description: Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of NonKeyAttributes summed across all of the local 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.
    • projection_type
      Type: STRING
      Provider name: ProjectionType
      Description: The set of attributes that are projected into the index:
      • KEYS_ONLY - Only the index and primary keys are projected into the index.
      • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
      • ALL - All of the table attributes are projected into the index.
  • provisioned_throughput
    Type: STRUCT
    Provider name: ProvisionedThroughput
    Description: Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
    • last_decrease_date_time
      Type: TIMESTAMP
      Provider name: LastDecreaseDateTime
      Description: The date and time of the last provisioned throughput decrease for this table.
    • last_increase_date_time
      Type: TIMESTAMP
      Provider name: LastIncreaseDateTime
      Description: The date and time of the last provisioned throughput increase for this table.
    • number_of_decreases_today
      Type: INT64
      Provider name: NumberOfDecreasesToday
      Description: The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
    • read_capacity_units
      Type: INT64
      Provider name: ReadCapacityUnits
      Description: The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
    • write_capacity_units
      Type: INT64
      Provider name: WriteCapacityUnits
      Description: The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

global_table_version

Type: STRING
Provider name: GlobalTableVersion
Description: Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.

item_count

Type: INT64
Provider name: ItemCount
Description: The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

key_schema

Type: UNORDERED_LIST_STRUCT
Provider name: KeySchema
Description: The primary key structure for the table. Each KeySchemaElement consists of:

  • AttributeName - The name of the attribute.
  • KeyType - The role of the attribute:
    • 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’s 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 more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

  • attribute_name
    Type: STRING
    Provider name: AttributeName
    Description: The name of a key attribute.
  • key_type
    Type: STRING
    Provider name: KeyType
    Description: The role that this 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’s 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.

latest_stream_arn

Type: STRING
Provider name: LatestStreamArn
Description: The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

latest_stream_label

Type: STRING
Provider name: LatestStreamLabel
Description: A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • Amazon Web Services customer ID
  • Table name
  • StreamLabel

local_secondary_indexes

Type: UNORDERED_LIST_STRUCT
Provider name: LocalSecondaryIndexes
Description: Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. If the table is in the DELETING state, no information about indexes will be returned.

  • index_arn
    Type: STRING
    Provider name: IndexArn
    Description: The Amazon Resource Name (ARN) that uniquely identifies the index.
  • index_name
    Type: STRING
    Provider name: IndexName
    Description: Represents the name of the local secondary index.
  • index_size_bytes
    Type: INT64
    Provider name: IndexSizeBytes
    Description: The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  • item_count
    Type: INT64
    Provider name: ItemCount
    Description: The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  • key_schema
    Type: UNORDERED_LIST_STRUCT
    Provider name: KeySchema
    Description: The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
    • 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’s 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.
    • attribute_name
      Type: STRING
      Provider name: AttributeName
      Description: The name of a key attribute.
    • key_type
      Type: STRING
      Provider name: KeyType
      Description: The role that this 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’s 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.
  • projection
    Type: STRUCT
    Provider name: Projection
    Description: Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
    • non_key_attributes
      Type: UNORDERED_LIST_STRING
      Provider name: NonKeyAttributes
      Description: Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of NonKeyAttributes summed across all of the local 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.
    • projection_type
      Type: STRING
      Provider name: ProjectionType
      Description: The set of attributes that are projected into the index:
      • KEYS_ONLY - Only the index and primary keys are projected into the index.
      • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
      • ALL - All of the table attributes are projected into the index.

provisioned_throughput

Type: STRUCT
Provider name: ProvisionedThroughput
Description: The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

  • last_decrease_date_time
    Type: TIMESTAMP
    Provider name: LastDecreaseDateTime
    Description: The date and time of the last provisioned throughput decrease for this table.
  • last_increase_date_time
    Type: TIMESTAMP
    Provider name: LastIncreaseDateTime
    Description: The date and time of the last provisioned throughput increase for this table.
  • number_of_decreases_today
    Type: INT64
    Provider name: NumberOfDecreasesToday
    Description: The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
  • read_capacity_units
    Type: INT64
    Provider name: ReadCapacityUnits
    Description: The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
  • write_capacity_units
    Type: INT64
    Provider name: WriteCapacityUnits
    Description: The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

replicas

Type: UNORDERED_LIST_STRUCT
Provider name: Replicas
Description: Represents replicas of the table.

  • global_secondary_indexes
    Type: UNORDERED_LIST_STRUCT
    Provider name: GlobalSecondaryIndexes
    Description: Replica-specific global secondary index settings.
    • index_name
      Type: STRING
      Provider name: IndexName
      Description: The name of the global secondary index.
    • provisioned_throughput_override
      Type: STRUCT
      Provider name: ProvisionedThroughputOverride
      Description: If not described, uses the source table GSI’s read capacity settings.
      • read_capacity_units
        Type: INT64
        Provider name: ReadCapacityUnits
        Description: Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.
  • kms_master_key_id
    Type: STRING
    Provider name: KMSMasterKeyId
    Description: The KMS key of the replica that will be used for KMS encryption.
  • provisioned_throughput_override
    Type: STRUCT
    Provider name: ProvisionedThroughputOverride
    Description: Replica-specific provisioned throughput. If not described, uses the source table’s provisioned throughput settings.
    • read_capacity_units
      Type: INT64
      Provider name: ReadCapacityUnits
      Description: Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.
  • region_name
    Type: STRING
    Provider name: RegionName
    Description: The name of the Region.
  • replica_inaccessible_date_time
    Type: TIMESTAMP
    Provider name: ReplicaInaccessibleDateTime
    Description: The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
  • replica_status
    Type: STRING
    Provider name: ReplicaStatus
    Description: The current state of the replica:
    • CREATING - The replica is being created.
    • UPDATING - The replica is being updated.
    • DELETING - The replica is being deleted.
    • ACTIVE - The replica is ready for use.
    • REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled. If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
    • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible. If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
  • replica_status_description
    Type: STRING
    Provider name: ReplicaStatusDescription
    Description: Detailed information about the replica status.
  • replica_status_percent_progress
    Type: STRING
    Provider name: ReplicaStatusPercentProgress
    Description: Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
  • replica_table_class_summary
    Type: STRUCT
    Provider name: ReplicaTableClassSummary
    • last_update_date_time
      Type: TIMESTAMP
      Provider name: LastUpdateDateTime
      Description: The date and time at which the table class was last updated.
    • table_class
      Type: STRING
      Provider name: TableClass
      Description: The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

restore_summary

Type: STRUCT
Provider name: RestoreSummary
Description: Contains details for the restore.

  • restore_date_time
    Type: TIMESTAMP
    Provider name: RestoreDateTime
    Description: Point in time or source backup time.
  • restore_in_progress
    Type: BOOLEAN
    Provider name: RestoreInProgress
    Description: Indicates if a restore is in progress or not.
  • source_backup_arn
    Type: STRING
    Provider name: SourceBackupArn
    Description: The Amazon Resource Name (ARN) of the backup from which the table was restored.
  • source_table_arn
    Type: STRING
    Provider name: SourceTableArn
    Description: The ARN of the source table of the backup that is being restored.

sse_description

Type: STRUCT
Provider name: SSEDescription
Description: The description of the server-side encryption status on the specified table.

  • inaccessible_encryption_date_time
    Type: TIMESTAMP
    Provider name: InaccessibleEncryptionDateTime
    Description: Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table’s KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table’s KMS key is accessible again. DynamoDB will initiate the table archival process when table’s KMS key remains inaccessible for more than seven days from this date.
  • kms_master_key_arn
    Type: STRING
    Provider name: KMSMasterKeyArn
    Description: The KMS key ARN used for the KMS encryption.
  • sse_type
    Type: STRING
    Provider name: SSEType
    Description: Server-side encryption type. The only supported value is:
    • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
  • status
    Type: STRING
    Provider name: Status
    Description: Represents the current state of server-side encryption. The only supported values are:
    • ENABLED - Server-side encryption is enabled.
    • UPDATING - Server-side encryption is being updated.

stream_specification

Type: STRUCT
Provider name: StreamSpecification
Description: The current DynamoDB Streams configuration for the table.

  • stream_enabled
    Type: BOOLEAN
    Provider name: StreamEnabled
    Description: Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
  • stream_view_type
    Type: STRING
    Provider name: StreamViewType
    Description: When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. 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.

table_arn

Type: STRING
Provider name: TableArn
Description: The Amazon Resource Name (ARN) that uniquely identifies the table.

table_class_summary

Type: STRUCT
Provider name: TableClassSummary
Description: Contains details of the table class.

  • last_update_date_time
    Type: TIMESTAMP
    Provider name: LastUpdateDateTime
    Description: The date and time at which the table class was last updated.
  • table_class
    Type: STRING
    Provider name: TableClass
    Description: The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

table_id

Type: STRING
Provider name: TableId
Description: Unique identifier for the table for which the backup was created.

table_name

Type: STRING
Provider name: TableName
Description: The name of the table.

table_size_bytes

Type: INT64
Provider name: TableSizeBytes
Description: The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

table_status

Type: STRING
Provider name: TableStatus
Description: The current state of the table:

  • CREATING - The table is being created.
  • UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING.
  • DELETING - The table is being deleted.
  • ACTIVE - The table is ready for use.
  • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table’s KMS key remains inaccessible for more than seven days.
  • ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
  • ARCHIVED - The table has been archived. See the ArchivalReason for more information.

tags

Type: UNORDERED_LIST_STRING