aws-native.dynamodb.getTable

func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)
func LookupTableOutput(ctx *Context, args *LookupTableOutputArgs, opts ...InvokeOption) LookupTableResultOutput

> Note: This function is named LookupTable in the Go SDK.

TableName string

A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

TableName string

A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

tableName String

A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

tableName string

A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

table_name str

A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

tableName String

A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Arn string

The Amazon Resource Name (ARN) of the DynamoDB table, such as arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable .

AttributeDefinitions List<Pulumi.AwsNative.DynamoDb.Outputs.TableAttributeDefinition>

A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.

BillingMode string

Specify how you are charged for read and write throughput and how you manage capacity. Valid values include:

• 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.

If not specified, the default is PROVISIONED.

ContributorInsightsSpecification Pulumi.AwsNative.DynamoDb.Outputs.TableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

DeletionProtectionEnabled bool

Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.

GlobalSecondaryIndexes List<Pulumi.AwsNative.DynamoDb.Outputs.TableGlobalSecondaryIndex>

Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions:

• If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
• You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

KeySchema List<Pulumi.AwsNative.DynamoDb.Outputs.TableKeySchema> | object

Specifies the attributes that make up the primary key for the table. The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

KinesisStreamSpecification Pulumi.AwsNative.DynamoDb.Outputs.TableKinesisStreamSpecification

The Kinesis Data Streams configuration for the specified table.

LocalSecondaryIndexes List<Pulumi.AwsNative.DynamoDb.Outputs.TableLocalSecondaryIndex>

Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.

OnDemandThroughput Pulumi.AwsNative.DynamoDb.Outputs.TableOnDemandThroughput

Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

PointInTimeRecoverySpecification Pulumi.AwsNative.DynamoDb.Outputs.TablePointInTimeRecoverySpecification

The settings used to enable point in time recovery.

ProvisionedThroughput Pulumi.AwsNative.DynamoDb.Outputs.TableProvisionedThroughput

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

ResourcePolicy Pulumi.AwsNative.DynamoDb.Outputs.TableResourcePolicy

A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.

SseSpecification Pulumi.AwsNative.DynamoDb.Outputs.TableSseSpecification

Specifies the settings to enable server-side encryption.

StreamArn string

The ARN of the DynamoDB stream, such as arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000 .

You must specify the StreamSpecification property to use this attribute.

StreamSpecification Pulumi.AwsNative.DynamoDb.Outputs.TableStreamSpecification

The settings for the DDB table stream, which capture changes to items stored in the table.

TableClass string

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

Tags List<Pulumi.AwsNative.Outputs.Tag>

An array of key-value pairs to apply to this resource. For more information, see Tag.

TimeToLiveSpecification Pulumi.AwsNative.DynamoDb.Outputs.TableTimeToLiveSpecification

Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide.

WarmThroughput Pulumi.AwsNative.DynamoDb.Outputs.TableWarmThroughput

Arn string

The Amazon Resource Name (ARN) of the DynamoDB table, such as arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable .

AttributeDefinitions []TableAttributeDefinition

A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.

BillingMode string

Specify how you are charged for read and write throughput and how you manage capacity. Valid values include:

• 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.

If not specified, the default is PROVISIONED.

ContributorInsightsSpecification TableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

DeletionProtectionEnabled bool

Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.

GlobalSecondaryIndexes []TableGlobalSecondaryIndex

Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions:

• If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
• You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

KeySchema []TableKeySchema | interface{}

Specifies the attributes that make up the primary key for the table. The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

KinesisStreamSpecification TableKinesisStreamSpecification

The Kinesis Data Streams configuration for the specified table.

LocalSecondaryIndexes []TableLocalSecondaryIndex

Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.

OnDemandThroughput TableOnDemandThroughput

Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

PointInTimeRecoverySpecification TablePointInTimeRecoverySpecification

The settings used to enable point in time recovery.

ProvisionedThroughput TableProvisionedThroughput

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

ResourcePolicy TableResourcePolicy

A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.

SseSpecification TableSseSpecification

Specifies the settings to enable server-side encryption.

StreamArn string

The ARN of the DynamoDB stream, such as arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000 .

You must specify the StreamSpecification property to use this attribute.

StreamSpecification TableStreamSpecification

The settings for the DDB table stream, which capture changes to items stored in the table.

TableClass string

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

Tags Tag

An array of key-value pairs to apply to this resource. For more information, see Tag.

TimeToLiveSpecification TableTimeToLiveSpecification

Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide.

WarmThroughput TableWarmThroughput

arn String

The Amazon Resource Name (ARN) of the DynamoDB table, such as arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable .

attributeDefinitions List<TableAttributeDefinition>

A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.

billingMode String

Specify how you are charged for read and write throughput and how you manage capacity. Valid values include:

• 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.

If not specified, the default is PROVISIONED.

contributorInsightsSpecification TableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

deletionProtectionEnabled Boolean

Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.

globalSecondaryIndexes List<TableGlobalSecondaryIndex>

Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions:

• If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
• You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

keySchema List<TableKeySchema> | Object

Specifies the attributes that make up the primary key for the table. The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

kinesisStreamSpecification TableKinesisStreamSpecification

The Kinesis Data Streams configuration for the specified table.

localSecondaryIndexes List<TableLocalSecondaryIndex>

Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.

onDemandThroughput TableOnDemandThroughput

Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

pointInTimeRecoverySpecification TablePointInTimeRecoverySpecification

The settings used to enable point in time recovery.

provisionedThroughput TableProvisionedThroughput

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

resourcePolicy TableResourcePolicy

A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.

sseSpecification TableSseSpecification

Specifies the settings to enable server-side encryption.

streamArn String

The ARN of the DynamoDB stream, such as arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000 .

You must specify the StreamSpecification property to use this attribute.

streamSpecification TableStreamSpecification

The settings for the DDB table stream, which capture changes to items stored in the table.

tableClass String

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

tags List<Tag>

An array of key-value pairs to apply to this resource. For more information, see Tag.

timeToLiveSpecification TableTimeToLiveSpecification

Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide.

warmThroughput TableWarmThroughput

arn string

The Amazon Resource Name (ARN) of the DynamoDB table, such as arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable .

attributeDefinitions TableAttributeDefinition[]

A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.

billingMode string

Specify how you are charged for read and write throughput and how you manage capacity. Valid values include:

• 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.

If not specified, the default is PROVISIONED.

contributorInsightsSpecification TableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

deletionProtectionEnabled boolean

Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.

globalSecondaryIndexes TableGlobalSecondaryIndex[]

Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions:

• If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
• You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

keySchema TableKeySchema[] | any

Specifies the attributes that make up the primary key for the table. The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

kinesisStreamSpecification TableKinesisStreamSpecification

The Kinesis Data Streams configuration for the specified table.

localSecondaryIndexes TableLocalSecondaryIndex[]

Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.

onDemandThroughput TableOnDemandThroughput

Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

pointInTimeRecoverySpecification TablePointInTimeRecoverySpecification

The settings used to enable point in time recovery.

provisionedThroughput TableProvisionedThroughput

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

resourcePolicy TableResourcePolicy

A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.

sseSpecification TableSseSpecification

Specifies the settings to enable server-side encryption.

streamArn string

The ARN of the DynamoDB stream, such as arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000 .

You must specify the StreamSpecification property to use this attribute.

streamSpecification TableStreamSpecification

The settings for the DDB table stream, which capture changes to items stored in the table.

tableClass string

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

tags Tag[]

An array of key-value pairs to apply to this resource. For more information, see Tag.

timeToLiveSpecification TableTimeToLiveSpecification

Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide.

warmThroughput TableWarmThroughput

arn str

The Amazon Resource Name (ARN) of the DynamoDB table, such as arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable .

attribute_definitions Sequence[TableAttributeDefinition]

A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.

billing_mode str

Specify how you are charged for read and write throughput and how you manage capacity. Valid values include:

• 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.

If not specified, the default is PROVISIONED.

contributor_insights_specification TableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

deletion_protection_enabled bool

Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.

global_secondary_indexes Sequence[TableGlobalSecondaryIndex]

Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions:

• If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
• You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

key_schema Sequence[TableKeySchema] | Any

Specifies the attributes that make up the primary key for the table. The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

kinesis_stream_specification TableKinesisStreamSpecification

The Kinesis Data Streams configuration for the specified table.

local_secondary_indexes Sequence[TableLocalSecondaryIndex]

Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.

on_demand_throughput TableOnDemandThroughput

Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

point_in_time_recovery_specification TablePointInTimeRecoverySpecification

The settings used to enable point in time recovery.

provisioned_throughput TableProvisionedThroughput

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

resource_policy TableResourcePolicy

A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.

sse_specification TableSseSpecification

Specifies the settings to enable server-side encryption.

stream_arn str

The ARN of the DynamoDB stream, such as arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000 .

You must specify the StreamSpecification property to use this attribute.

stream_specification TableStreamSpecification

The settings for the DDB table stream, which capture changes to items stored in the table.

table_class str

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

tags Sequence[root_Tag]

An array of key-value pairs to apply to this resource. For more information, see Tag.

time_to_live_specification TableTimeToLiveSpecification

Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide.

warm_throughput TableWarmThroughput

arn String

The Amazon Resource Name (ARN) of the DynamoDB table, such as arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable .

attributeDefinitions List<Property Map>

A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.

billingMode String

Specify how you are charged for read and write throughput and how you manage capacity. Valid values include:

• 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.

If not specified, the default is PROVISIONED.

contributorInsightsSpecification Property Map

The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

deletionProtectionEnabled Boolean

Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.

globalSecondaryIndexes List<Property Map>

Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions:

• If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
• You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

keySchema List<Property Map> | Any

Specifies the attributes that make up the primary key for the table. The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

kinesisStreamSpecification Property Map

The Kinesis Data Streams configuration for the specified table.

localSecondaryIndexes List<Property Map>

Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.

onDemandThroughput Property Map

Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

pointInTimeRecoverySpecification Property Map

The settings used to enable point in time recovery.

provisionedThroughput Property Map

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

resourcePolicy Property Map

A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.

sseSpecification Property Map

Specifies the settings to enable server-side encryption.

streamArn String

The ARN of the DynamoDB stream, such as arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000 .

You must specify the StreamSpecification property to use this attribute.

streamSpecification Property Map

The settings for the DDB table stream, which capture changes to items stored in the table.

tableClass String

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

tags List<Property Map>

An array of key-value pairs to apply to this resource. For more information, see Tag.

timeToLiveSpecification Property Map

Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide.

warmThroughput Property Map

AttributeName string

A name for the attribute.

AttributeType string

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

AttributeName string

A name for the attribute.

AttributeType string

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

attributeName String

A name for the attribute.

attributeType String

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

attributeName string

A name for the attribute.

attributeType string

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

attribute_name str

A name for the attribute.

attribute_type str

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

attributeName String

A name for the attribute.

attributeType String

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

Enabled bool

Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

Enabled bool

Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

enabled Boolean

Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

enabled boolean

Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

enabled bool

Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

enabled Boolean

Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

IndexName string

The name of the global secondary index. The name must be unique among all other indexes on this table.

KeySchema List<Pulumi.AwsNative.DynamoDb.Inputs.TableKeySchema>

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.

Projection Pulumi.AwsNative.DynamoDb.Inputs.TableProjection

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.

ContributorInsightsSpecification Pulumi.AwsNative.DynamoDb.Inputs.TableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.

OnDemandThroughput Pulumi.AwsNative.DynamoDb.Inputs.TableOnDemandThroughput

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

ProvisionedThroughput Pulumi.AwsNative.DynamoDb.Inputs.TableProvisionedThroughput

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.

WarmThroughput Pulumi.AwsNative.DynamoDb.Inputs.TableWarmThroughput

IndexName string

The name of the global secondary index. The name must be unique among all other indexes on this table.

KeySchema []TableKeySchema

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.

Projection TableProjection

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.

ContributorInsightsSpecification TableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.

OnDemandThroughput TableOnDemandThroughput

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

ProvisionedThroughput TableProvisionedThroughput

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.

WarmThroughput TableWarmThroughput

indexName String

The name of the global secondary index. The name must be unique among all other indexes on this table.

keySchema List<TableKeySchema>

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.

projection TableProjection

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.

contributorInsightsSpecification TableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.

onDemandThroughput TableOnDemandThroughput

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

provisionedThroughput TableProvisionedThroughput

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.

warmThroughput TableWarmThroughput

indexName string

The name of the global secondary index. The name must be unique among all other indexes on this table.

keySchema TableKeySchema[]

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.

projection TableProjection

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.

contributorInsightsSpecification TableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.

onDemandThroughput TableOnDemandThroughput

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

provisionedThroughput TableProvisionedThroughput

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.

warmThroughput TableWarmThroughput

index_name str

The name of the global secondary index. The name must be unique among all other indexes on this table.

key_schema Sequence[TableKeySchema]

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.

projection TableProjection

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.

contributor_insights_specification TableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.

on_demand_throughput TableOnDemandThroughput

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

provisioned_throughput TableProvisionedThroughput

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.

warm_throughput TableWarmThroughput

indexName String

The name of the global secondary index. The name must be unique among all other indexes on this table.

keySchema List<Property Map>

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.

projection Property Map

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.

contributorInsightsSpecification Property Map

The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.

onDemandThroughput Property Map

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

provisionedThroughput Property Map

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.

warmThroughput Property Map

AttributeName string

The name of a key attribute.

KeyType string

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.

AttributeName string

The name of a key attribute.

KeyType string

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.

attributeName String

The name of a key attribute.

keyType String

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.

attributeName string

The name of a key attribute.

keyType string

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.

attribute_name str

The name of a key attribute.

key_type str

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.

attributeName String

The name of a key attribute.

keyType String

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.

StreamArn string

The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.

ApproximateCreationDateTimePrecision Pulumi.AwsNative.DynamoDb.TableKinesisStreamSpecificationApproximateCreationDateTimePrecision

The precision for the time and date that the stream was created.

StreamArn string

The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.

ApproximateCreationDateTimePrecision TableKinesisStreamSpecificationApproximateCreationDateTimePrecision

The precision for the time and date that the stream was created.

streamArn String

The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.

approximateCreationDateTimePrecision TableKinesisStreamSpecificationApproximateCreationDateTimePrecision

The precision for the time and date that the stream was created.

streamArn string

The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.

approximateCreationDateTimePrecision TableKinesisStreamSpecificationApproximateCreationDateTimePrecision

The precision for the time and date that the stream was created.

stream_arn str

The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.

approximate_creation_date_time_precision TableKinesisStreamSpecificationApproximateCreationDateTimePrecision

The precision for the time and date that the stream was created.

streamArn String

The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.

approximateCreationDateTimePrecision "MICROSECOND" | "MILLISECOND"

The precision for the time and date that the stream was created.

IndexName string

The name of the local secondary index. The name must be unique among all other indexes on this table.

KeySchema List<Pulumi.AwsNative.DynamoDb.Inputs.TableKeySchema>

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.

Projection Pulumi.AwsNative.DynamoDb.Inputs.TableProjection

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

IndexName string

The name of the local secondary index. The name must be unique among all other indexes on this table.

KeySchema []TableKeySchema

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.

Projection TableProjection

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

indexName String

The name of the local secondary index. The name must be unique among all other indexes on this table.

keySchema List<TableKeySchema>

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.

projection TableProjection

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

indexName string

The name of the local secondary index. The name must be unique among all other indexes on this table.

keySchema TableKeySchema[]

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.

projection TableProjection

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

index_name str

The name of the local secondary index. The name must be unique among all other indexes on this table.

key_schema Sequence[TableKeySchema]

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.

projection TableProjection

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

indexName String

The name of the local secondary index. The name must be unique among all other indexes on this table.

keySchema List<Property Map>

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.

projection Property Map

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

MaxReadRequestUnits int

Maximum number of read request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

MaxWriteRequestUnits int

Maximum number of write request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

MaxReadRequestUnits int

Maximum number of read request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

MaxWriteRequestUnits int

Maximum number of write request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

maxReadRequestUnits Integer

Maximum number of read request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

maxWriteRequestUnits Integer

Maximum number of write request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

maxReadRequestUnits number

Maximum number of read request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

maxWriteRequestUnits number

Maximum number of write request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

max_read_request_units int

Maximum number of read request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

max_write_request_units int

Maximum number of write request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

maxReadRequestUnits Number

Maximum number of read request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

maxWriteRequestUnits Number

Maximum number of write request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

PointInTimeRecoveryEnabled bool

Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

PointInTimeRecoveryEnabled bool

Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

pointInTimeRecoveryEnabled Boolean

Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

pointInTimeRecoveryEnabled boolean

Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

point_in_time_recovery_enabled bool

Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

pointInTimeRecoveryEnabled Boolean

Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

NonKeyAttributes List<string>

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.

ProjectionType string

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.

When using the DynamoDB console, ALL is selected by default.

NonKeyAttributes []string

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.

ProjectionType string

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.

When using the DynamoDB console, ALL is selected by default.

nonKeyAttributes List<String>

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.

projectionType String

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.

When using the DynamoDB console, ALL is selected by default.

nonKeyAttributes string[]

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.

projectionType string

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.

When using the DynamoDB console, ALL is selected by default.

non_key_attributes Sequence[str]

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 str

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.

When using the DynamoDB console, ALL is selected by default.

nonKeyAttributes List<String>

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.

projectionType String

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.

When using the DynamoDB console, ALL is selected by default.

ReadCapacityUnits int

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

WriteCapacityUnits int

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

ReadCapacityUnits int

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

WriteCapacityUnits int

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

readCapacityUnits Integer

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

writeCapacityUnits Integer

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

readCapacityUnits number

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

writeCapacityUnits number

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

read_capacity_units int

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

write_capacity_units int

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

readCapacityUnits Number

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

writeCapacityUnits Number

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

PolicyDocument object

A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

PolicyDocument interface{}

A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

policyDocument Object

A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

policyDocument any

A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

policy_document Any

A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

policyDocument Any

A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

SseEnabled bool

Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to KMS and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.

KmsMasterKeyId string

The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.

SseType string

Server-side encryption type. The only supported value is:

• KMS - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).

SseEnabled bool

Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to KMS and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.

KmsMasterKeyId string

The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.

SseType string

Server-side encryption type. The only supported value is:

• KMS - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).

sseEnabled Boolean

Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to KMS and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.

kmsMasterKeyId String

The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.

sseType String

Server-side encryption type. The only supported value is:

• KMS - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).

sseEnabled boolean

Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to KMS and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.

kmsMasterKeyId string

The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.

sseType string

Server-side encryption type. The only supported value is:

• KMS - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).

sse_enabled bool

Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to KMS and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.

kms_master_key_id str

The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.

sse_type str

Server-side encryption type. The only supported value is:

• KMS - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).

sseEnabled Boolean

Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to KMS and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.

kmsMasterKeyId String

The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.

sseType String

Server-side encryption type. The only supported value is:

• KMS - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).

StreamViewType string

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.

ResourcePolicy Pulumi.AwsNative.DynamoDb.Inputs.TableResourcePolicy

Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

StreamViewType string

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.

ResourcePolicy TableResourcePolicy

Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

streamViewType String

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.

resourcePolicy TableResourcePolicy

Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

streamViewType string

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.

resourcePolicy TableResourcePolicy

Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

stream_view_type str

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.

resource_policy TableResourcePolicy

Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

streamViewType String

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.

resourcePolicy Property Map

Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples.

Enabled bool

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

AttributeName string

The name of the TTL attribute used to store the expiration time for items in the table.

• The AttributeName property is required when enabling the TTL, or when TTL is already enabled.
• To update this property, you must first disable TTL and then enable TTL with the new attribute name.

Enabled bool

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

AttributeName string

The name of the TTL attribute used to store the expiration time for items in the table.

• The AttributeName property is required when enabling the TTL, or when TTL is already enabled.
• To update this property, you must first disable TTL and then enable TTL with the new attribute name.

enabled Boolean

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

attributeName String

The name of the TTL attribute used to store the expiration time for items in the table.

• The AttributeName property is required when enabling the TTL, or when TTL is already enabled.
• To update this property, you must first disable TTL and then enable TTL with the new attribute name.

enabled boolean

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

attributeName string

The name of the TTL attribute used to store the expiration time for items in the table.

• The AttributeName property is required when enabling the TTL, or when TTL is already enabled.
• To update this property, you must first disable TTL and then enable TTL with the new attribute name.

enabled bool

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

attribute_name str

The name of the TTL attribute used to store the expiration time for items in the table.

• The AttributeName property is required when enabling the TTL, or when TTL is already enabled.
• To update this property, you must first disable TTL and then enable TTL with the new attribute name.

enabled Boolean

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

attributeName String

The name of the TTL attribute used to store the expiration time for items in the table.

• The AttributeName property is required when enabling the TTL, or when TTL is already enabled.
• To update this property, you must first disable TTL and then enable TTL with the new attribute name.

ReadUnitsPerSecond int

WriteUnitsPerSecond int

ReadUnitsPerSecond int

WriteUnitsPerSecond int

readUnitsPerSecond Integer

writeUnitsPerSecond Integer

readUnitsPerSecond number

writeUnitsPerSecond number

read_units_per_second int

write_units_per_second int

readUnitsPerSecond Number

writeUnitsPerSecond Number

Key string

The key name of the tag

Value string

The value of the tag

Key string

The key name of the tag

Value string

The value of the tag

key String

The key name of the tag

value String

The value of the tag

key string

The key name of the tag

value string

The value of the tag

key str

The key name of the tag

value str

The value of the tag

key String

The key name of the tag

value String

The value of the tag