We recommend new projects start with resources from the AWS provider.
aws-native.dynamodb.getGlobalTable
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Version: None. Resource Type definition for AWS::DynamoDB::GlobalTable
Using getGlobalTable
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGlobalTable(args: GetGlobalTableArgs, opts?: InvokeOptions): Promise<GetGlobalTableResult>
function getGlobalTableOutput(args: GetGlobalTableOutputArgs, opts?: InvokeOptions): Output<GetGlobalTableResult>
def get_global_table(table_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGlobalTableResult
def get_global_table_output(table_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGlobalTableResult]
func LookupGlobalTable(ctx *Context, args *LookupGlobalTableArgs, opts ...InvokeOption) (*LookupGlobalTableResult, error)
func LookupGlobalTableOutput(ctx *Context, args *LookupGlobalTableOutputArgs, opts ...InvokeOption) LookupGlobalTableResultOutput
> Note: This function is named LookupGlobalTable
in the Go SDK.
public static class GetGlobalTable
{
public static Task<GetGlobalTableResult> InvokeAsync(GetGlobalTableArgs args, InvokeOptions? opts = null)
public static Output<GetGlobalTableResult> Invoke(GetGlobalTableInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGlobalTableResult> getGlobalTable(GetGlobalTableArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:dynamodb:getGlobalTable
arguments:
# arguments dictionary
The following arguments are supported:
- Table
Name string A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as 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 string A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as 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 String A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as 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 string A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as 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 global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as 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 String A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as 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.
getGlobalTable Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) of the DynamoDB table, such as
arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable
. The ARN returned is that of the replica in the region the stack is deployed to. - Attribute
Definitions List<Pulumi.Aws Native. Dynamo Db. Outputs. Global Table Attribute Definition> - A list of attributes that describe the key schema for the global table and indexes.
- Billing
Mode string Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:
PAY_PER_REQUEST
PROVISIONED
All replicas in your global table will have the same billing mode. If you use
PROVISIONED
billing mode, you must provide an auto scaling configuration via theWriteProvisionedThroughputSettings
property. The default value of this property isPROVISIONED
.- Global
Secondary List<Pulumi.Indexes Aws Native. Dynamo Db. Outputs. Global Table Global Secondary Index> Global secondary indexes to be created on the global table. You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.
Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.
- Replicas
List<Pulumi.
Aws Native. Dynamo Db. Outputs. Global Table Replica Specification> Specifies the list of replicas for your global table. The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in
Replicas
with the region us-east-1. You cannot remove the replica in the stack region.Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an
UpdateStack
operation containing only that change.If you add or delete a replica 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 replica, you might need to manually delete the replica.
You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.
- Sse
Specification Pulumi.Aws Native. Dynamo Db. Outputs. Global Table Sse Specification - Specifies the settings to enable server-side encryption. These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the
ReplicaSpecification.ReplicaSSESpecification
property. - Stream
Arn 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
. TheStreamArn
returned is that of the replica in the region the stack is deployed to.You must specify the
StreamSpecification
property to use this attribute.- Stream
Specification Pulumi.Aws Native. Dynamo Db. Outputs. Global Table Stream Specification - Specifies the streams settings on your global table. You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.
- Table
Id string - Unique identifier for the table, such as
a123b456-01ab-23cd-123a-111222aaabbb
. TheTableId
returned is that of the replica in the region the stack is deployed to. - Time
To Pulumi.Live Specification Aws Native. Dynamo Db. Outputs. Global Table Time To Live Specification - Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
- Warm
Throughput Pulumi.Aws Native. Dynamo Db. Outputs. Global Table Warm Throughput - Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the
UpdateTable
operation to meet the throughput requirements of an upcoming peak event. - Write
On Pulumi.Demand Throughput Settings Aws Native. Dynamo Db. Outputs. Global Table Write On Demand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - Write
Provisioned Pulumi.Throughput Settings Aws Native. Dynamo Db. Outputs. Global Table Write Provisioned Throughput Settings - Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if
BillingMode
is set toPROVISIONED
.
- Arn string
- The Amazon Resource Name (ARN) of the DynamoDB table, such as
arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable
. The ARN returned is that of the replica in the region the stack is deployed to. - Attribute
Definitions []GlobalTable Attribute Definition - A list of attributes that describe the key schema for the global table and indexes.
- Billing
Mode string Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:
PAY_PER_REQUEST
PROVISIONED
All replicas in your global table will have the same billing mode. If you use
PROVISIONED
billing mode, you must provide an auto scaling configuration via theWriteProvisionedThroughputSettings
property. The default value of this property isPROVISIONED
.- Global
Secondary []GlobalIndexes Table Global Secondary Index Global secondary indexes to be created on the global table. You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.
Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.
- Replicas
[]Global
Table Replica Specification Specifies the list of replicas for your global table. The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in
Replicas
with the region us-east-1. You cannot remove the replica in the stack region.Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an
UpdateStack
operation containing only that change.If you add or delete a replica 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 replica, you might need to manually delete the replica.
You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.
- Sse
Specification GlobalTable Sse Specification - Specifies the settings to enable server-side encryption. These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the
ReplicaSpecification.ReplicaSSESpecification
property. - Stream
Arn 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
. TheStreamArn
returned is that of the replica in the region the stack is deployed to.You must specify the
StreamSpecification
property to use this attribute.- Stream
Specification GlobalTable Stream Specification - Specifies the streams settings on your global table. You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.
- Table
Id string - Unique identifier for the table, such as
a123b456-01ab-23cd-123a-111222aaabbb
. TheTableId
returned is that of the replica in the region the stack is deployed to. - Time
To GlobalLive Specification Table Time To Live Specification - Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
- Warm
Throughput GlobalTable Warm Throughput - Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the
UpdateTable
operation to meet the throughput requirements of an upcoming peak event. - Write
On GlobalDemand Throughput Settings Table Write On Demand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - Write
Provisioned GlobalThroughput Settings Table Write Provisioned Throughput Settings - Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if
BillingMode
is set toPROVISIONED
.
- arn String
- The Amazon Resource Name (ARN) of the DynamoDB table, such as
arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable
. The ARN returned is that of the replica in the region the stack is deployed to. - attribute
Definitions List<GlobalTable Attribute Definition> - A list of attributes that describe the key schema for the global table and indexes.
- billing
Mode String Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:
PAY_PER_REQUEST
PROVISIONED
All replicas in your global table will have the same billing mode. If you use
PROVISIONED
billing mode, you must provide an auto scaling configuration via theWriteProvisionedThroughputSettings
property. The default value of this property isPROVISIONED
.- global
Secondary List<GlobalIndexes Table Global Secondary Index> Global secondary indexes to be created on the global table. You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.
Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.
- replicas
List<Global
Table Replica Specification> Specifies the list of replicas for your global table. The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in
Replicas
with the region us-east-1. You cannot remove the replica in the stack region.Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an
UpdateStack
operation containing only that change.If you add or delete a replica 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 replica, you might need to manually delete the replica.
You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.
- sse
Specification GlobalTable Sse Specification - Specifies the settings to enable server-side encryption. These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the
ReplicaSpecification.ReplicaSSESpecification
property. - stream
Arn 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
. TheStreamArn
returned is that of the replica in the region the stack is deployed to.You must specify the
StreamSpecification
property to use this attribute.- stream
Specification GlobalTable Stream Specification - Specifies the streams settings on your global table. You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.
- table
Id String - Unique identifier for the table, such as
a123b456-01ab-23cd-123a-111222aaabbb
. TheTableId
returned is that of the replica in the region the stack is deployed to. - time
To GlobalLive Specification Table Time To Live Specification - Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
- warm
Throughput GlobalTable Warm Throughput - Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the
UpdateTable
operation to meet the throughput requirements of an upcoming peak event. - write
On GlobalDemand Throughput Settings Table Write On Demand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - write
Provisioned GlobalThroughput Settings Table Write Provisioned Throughput Settings - Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if
BillingMode
is set toPROVISIONED
.
- arn string
- The Amazon Resource Name (ARN) of the DynamoDB table, such as
arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable
. The ARN returned is that of the replica in the region the stack is deployed to. - attribute
Definitions GlobalTable Attribute Definition[] - A list of attributes that describe the key schema for the global table and indexes.
- billing
Mode string Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:
PAY_PER_REQUEST
PROVISIONED
All replicas in your global table will have the same billing mode. If you use
PROVISIONED
billing mode, you must provide an auto scaling configuration via theWriteProvisionedThroughputSettings
property. The default value of this property isPROVISIONED
.- global
Secondary GlobalIndexes Table Global Secondary Index[] Global secondary indexes to be created on the global table. You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.
Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.
- replicas
Global
Table Replica Specification[] Specifies the list of replicas for your global table. The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in
Replicas
with the region us-east-1. You cannot remove the replica in the stack region.Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an
UpdateStack
operation containing only that change.If you add or delete a replica 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 replica, you might need to manually delete the replica.
You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.
- sse
Specification GlobalTable Sse Specification - Specifies the settings to enable server-side encryption. These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the
ReplicaSpecification.ReplicaSSESpecification
property. - stream
Arn 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
. TheStreamArn
returned is that of the replica in the region the stack is deployed to.You must specify the
StreamSpecification
property to use this attribute.- stream
Specification GlobalTable Stream Specification - Specifies the streams settings on your global table. You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.
- table
Id string - Unique identifier for the table, such as
a123b456-01ab-23cd-123a-111222aaabbb
. TheTableId
returned is that of the replica in the region the stack is deployed to. - time
To GlobalLive Specification Table Time To Live Specification - Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
- warm
Throughput GlobalTable Warm Throughput - Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the
UpdateTable
operation to meet the throughput requirements of an upcoming peak event. - write
On GlobalDemand Throughput Settings Table Write On Demand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - write
Provisioned GlobalThroughput Settings Table Write Provisioned Throughput Settings - Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if
BillingMode
is set toPROVISIONED
.
- arn str
- The Amazon Resource Name (ARN) of the DynamoDB table, such as
arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable
. The ARN returned is that of the replica in the region the stack is deployed to. - attribute_
definitions Sequence[GlobalTable Attribute Definition] - A list of attributes that describe the key schema for the global table and indexes.
- billing_
mode str Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:
PAY_PER_REQUEST
PROVISIONED
All replicas in your global table will have the same billing mode. If you use
PROVISIONED
billing mode, you must provide an auto scaling configuration via theWriteProvisionedThroughputSettings
property. The default value of this property isPROVISIONED
.- global_
secondary_ Sequence[Globalindexes Table Global Secondary Index] Global secondary indexes to be created on the global table. You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.
Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.
- replicas
Sequence[Global
Table Replica Specification] Specifies the list of replicas for your global table. The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in
Replicas
with the region us-east-1. You cannot remove the replica in the stack region.Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an
UpdateStack
operation containing only that change.If you add or delete a replica 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 replica, you might need to manually delete the replica.
You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.
- sse_
specification GlobalTable Sse Specification - Specifies the settings to enable server-side encryption. These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the
ReplicaSpecification.ReplicaSSESpecification
property. - 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
. TheStreamArn
returned is that of the replica in the region the stack is deployed to.You must specify the
StreamSpecification
property to use this attribute.- stream_
specification GlobalTable Stream Specification - Specifies the streams settings on your global table. You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.
- table_
id str - Unique identifier for the table, such as
a123b456-01ab-23cd-123a-111222aaabbb
. TheTableId
returned is that of the replica in the region the stack is deployed to. - time_
to_ Globallive_ specification Table Time To Live Specification - Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
- warm_
throughput GlobalTable Warm Throughput - Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the
UpdateTable
operation to meet the throughput requirements of an upcoming peak event. - write_
on_ Globaldemand_ throughput_ settings Table Write On Demand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - write_
provisioned_ Globalthroughput_ settings Table Write Provisioned Throughput Settings - Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if
BillingMode
is set toPROVISIONED
.
- arn String
- The Amazon Resource Name (ARN) of the DynamoDB table, such as
arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable
. The ARN returned is that of the replica in the region the stack is deployed to. - attribute
Definitions List<Property Map> - A list of attributes that describe the key schema for the global table and indexes.
- billing
Mode String Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:
PAY_PER_REQUEST
PROVISIONED
All replicas in your global table will have the same billing mode. If you use
PROVISIONED
billing mode, you must provide an auto scaling configuration via theWriteProvisionedThroughputSettings
property. The default value of this property isPROVISIONED
.- global
Secondary List<Property Map>Indexes Global secondary indexes to be created on the global table. You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.
Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.
- replicas List<Property Map>
Specifies the list of replicas for your global table. The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in
Replicas
with the region us-east-1. You cannot remove the replica in the stack region.Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an
UpdateStack
operation containing only that change.If you add or delete a replica 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 replica, you might need to manually delete the replica.
You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.
- sse
Specification Property Map - Specifies the settings to enable server-side encryption. These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the
ReplicaSpecification.ReplicaSSESpecification
property. - stream
Arn 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
. TheStreamArn
returned is that of the replica in the region the stack is deployed to.You must specify the
StreamSpecification
property to use this attribute.- stream
Specification Property Map - Specifies the streams settings on your global table. You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.
- table
Id String - Unique identifier for the table, such as
a123b456-01ab-23cd-123a-111222aaabbb
. TheTableId
returned is that of the replica in the region the stack is deployed to. - time
To Property MapLive Specification - Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
- warm
Throughput Property Map - Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the
UpdateTable
operation to meet the throughput requirements of an upcoming peak event. - write
On Property MapDemand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - write
Provisioned Property MapThroughput Settings - Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if
BillingMode
is set toPROVISIONED
.
Supporting Types
GlobalTableAttributeDefinition
- Attribute
Name string - A name for the attribute.
- Attribute
Type string - The data type for the attribute, where:
S
- the attribute is of type StringN
- the attribute is of type NumberB
- the attribute is of type Binary
- Attribute
Name string - A name for the attribute.
- Attribute
Type string - The data type for the attribute, where:
S
- the attribute is of type StringN
- the attribute is of type NumberB
- the attribute is of type Binary
- attribute
Name String - A name for the attribute.
- attribute
Type String - The data type for the attribute, where:
S
- the attribute is of type StringN
- the attribute is of type NumberB
- the attribute is of type Binary
- attribute
Name string - A name for the attribute.
- attribute
Type string - The data type for the attribute, where:
S
- the attribute is of type StringN
- the attribute is of type NumberB
- 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 StringN
- the attribute is of type NumberB
- the attribute is of type Binary
- attribute
Name String - A name for the attribute.
- attribute
Type String - The data type for the attribute, where:
S
- the attribute is of type StringN
- the attribute is of type NumberB
- the attribute is of type Binary
GlobalTableCapacityAutoScalingSettings
- Max
Capacity int - The maximum provisioned capacity units for the global table.
- Min
Capacity int - The minimum provisioned capacity units for the global table.
- Target
Tracking Pulumi.Scaling Policy Configuration Aws Native. Dynamo Db. Inputs. Global Table Target Tracking Scaling Policy Configuration - Defines a target tracking scaling policy.
- Seed
Capacity int When switching billing mode from
PAY_PER_REQUEST
toPROVISIONED
, DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index. These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.If you want to switch a table's billing mode from
PAY_PER_REQUEST
toPROVISIONED
, you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either theSeedCapacity
orReadCapacityUnits
properties. For example, if your global secondary indexmyGSI
has aSeedCapacity
of 10 in us-east-1 and a fixedReadCapacityUnits
of 20 in eu-west-1, CloudFormation will initially set the read capacity formyGSI
to 20. Note that if you disableScaleIn
formyGSI
in us-east-1, its read capacity units might not be set back to 10.You must also specify a value for
SeedCapacity
when you plan to switch a table's billing mode fromPROVISIONED
toPAY_PER_REQUEST
, because CloudFormation might need to roll back the operation (reverting the billing mode toPROVISIONED
) and this cannot succeed without specifying a value forSeedCapacity
.
- Max
Capacity int - The maximum provisioned capacity units for the global table.
- Min
Capacity int - The minimum provisioned capacity units for the global table.
- Target
Tracking GlobalScaling Policy Configuration Table Target Tracking Scaling Policy Configuration - Defines a target tracking scaling policy.
- Seed
Capacity int When switching billing mode from
PAY_PER_REQUEST
toPROVISIONED
, DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index. These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.If you want to switch a table's billing mode from
PAY_PER_REQUEST
toPROVISIONED
, you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either theSeedCapacity
orReadCapacityUnits
properties. For example, if your global secondary indexmyGSI
has aSeedCapacity
of 10 in us-east-1 and a fixedReadCapacityUnits
of 20 in eu-west-1, CloudFormation will initially set the read capacity formyGSI
to 20. Note that if you disableScaleIn
formyGSI
in us-east-1, its read capacity units might not be set back to 10.You must also specify a value for
SeedCapacity
when you plan to switch a table's billing mode fromPROVISIONED
toPAY_PER_REQUEST
, because CloudFormation might need to roll back the operation (reverting the billing mode toPROVISIONED
) and this cannot succeed without specifying a value forSeedCapacity
.
- max
Capacity Integer - The maximum provisioned capacity units for the global table.
- min
Capacity Integer - The minimum provisioned capacity units for the global table.
- target
Tracking GlobalScaling Policy Configuration Table Target Tracking Scaling Policy Configuration - Defines a target tracking scaling policy.
- seed
Capacity Integer When switching billing mode from
PAY_PER_REQUEST
toPROVISIONED
, DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index. These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.If you want to switch a table's billing mode from
PAY_PER_REQUEST
toPROVISIONED
, you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either theSeedCapacity
orReadCapacityUnits
properties. For example, if your global secondary indexmyGSI
has aSeedCapacity
of 10 in us-east-1 and a fixedReadCapacityUnits
of 20 in eu-west-1, CloudFormation will initially set the read capacity formyGSI
to 20. Note that if you disableScaleIn
formyGSI
in us-east-1, its read capacity units might not be set back to 10.You must also specify a value for
SeedCapacity
when you plan to switch a table's billing mode fromPROVISIONED
toPAY_PER_REQUEST
, because CloudFormation might need to roll back the operation (reverting the billing mode toPROVISIONED
) and this cannot succeed without specifying a value forSeedCapacity
.
- max
Capacity number - The maximum provisioned capacity units for the global table.
- min
Capacity number - The minimum provisioned capacity units for the global table.
- target
Tracking GlobalScaling Policy Configuration Table Target Tracking Scaling Policy Configuration - Defines a target tracking scaling policy.
- seed
Capacity number When switching billing mode from
PAY_PER_REQUEST
toPROVISIONED
, DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index. These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.If you want to switch a table's billing mode from
PAY_PER_REQUEST
toPROVISIONED
, you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either theSeedCapacity
orReadCapacityUnits
properties. For example, if your global secondary indexmyGSI
has aSeedCapacity
of 10 in us-east-1 and a fixedReadCapacityUnits
of 20 in eu-west-1, CloudFormation will initially set the read capacity formyGSI
to 20. Note that if you disableScaleIn
formyGSI
in us-east-1, its read capacity units might not be set back to 10.You must also specify a value for
SeedCapacity
when you plan to switch a table's billing mode fromPROVISIONED
toPAY_PER_REQUEST
, because CloudFormation might need to roll back the operation (reverting the billing mode toPROVISIONED
) and this cannot succeed without specifying a value forSeedCapacity
.
- max_
capacity int - The maximum provisioned capacity units for the global table.
- min_
capacity int - The minimum provisioned capacity units for the global table.
- target_
tracking_ Globalscaling_ policy_ configuration Table Target Tracking Scaling Policy Configuration - Defines a target tracking scaling policy.
- seed_
capacity int When switching billing mode from
PAY_PER_REQUEST
toPROVISIONED
, DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index. These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.If you want to switch a table's billing mode from
PAY_PER_REQUEST
toPROVISIONED
, you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either theSeedCapacity
orReadCapacityUnits
properties. For example, if your global secondary indexmyGSI
has aSeedCapacity
of 10 in us-east-1 and a fixedReadCapacityUnits
of 20 in eu-west-1, CloudFormation will initially set the read capacity formyGSI
to 20. Note that if you disableScaleIn
formyGSI
in us-east-1, its read capacity units might not be set back to 10.You must also specify a value for
SeedCapacity
when you plan to switch a table's billing mode fromPROVISIONED
toPAY_PER_REQUEST
, because CloudFormation might need to roll back the operation (reverting the billing mode toPROVISIONED
) and this cannot succeed without specifying a value forSeedCapacity
.
- max
Capacity Number - The maximum provisioned capacity units for the global table.
- min
Capacity Number - The minimum provisioned capacity units for the global table.
- target
Tracking Property MapScaling Policy Configuration - Defines a target tracking scaling policy.
- seed
Capacity Number When switching billing mode from
PAY_PER_REQUEST
toPROVISIONED
, DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index. These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.If you want to switch a table's billing mode from
PAY_PER_REQUEST
toPROVISIONED
, you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either theSeedCapacity
orReadCapacityUnits
properties. For example, if your global secondary indexmyGSI
has aSeedCapacity
of 10 in us-east-1 and a fixedReadCapacityUnits
of 20 in eu-west-1, CloudFormation will initially set the read capacity formyGSI
to 20. Note that if you disableScaleIn
formyGSI
in us-east-1, its read capacity units might not be set back to 10.You must also specify a value for
SeedCapacity
when you plan to switch a table's billing mode fromPROVISIONED
toPAY_PER_REQUEST
, because CloudFormation might need to roll back the operation (reverting the billing mode toPROVISIONED
) and this cannot succeed without specifying a value forSeedCapacity
.
GlobalTableContributorInsightsSpecification
- 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).
GlobalTableGlobalSecondaryIndex
- Index
Name string - The name of the global secondary index. The name must be unique among all other indexes on this table.
- Key
Schema List<Pulumi.Aws Native. Dynamo Db. Inputs. Global Table Key Schema> The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- 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.
Aws Native. Dynamo Db. Inputs. Global Table Projection - 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.
- Warm
Throughput Pulumi.Aws Native. Dynamo Db. Inputs. Global Table Warm Throughput - Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify
ReadUnitsPerSecond
,WriteUnitsPerSecond
, or both. - Write
On Pulumi.Demand Throughput Settings Aws Native. Dynamo Db. Inputs. Global Table Write On Demand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - Write
Provisioned Pulumi.Throughput Settings Aws Native. Dynamo Db. Inputs. Global Table Write Provisioned Throughput Settings - Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's
BillingMode
isPROVISIONED
. All replicas will have the same write capacity settings for this global secondary index.
- Index
Name string - The name of the global secondary index. The name must be unique among all other indexes on this table.
- Key
Schema []GlobalTable Key Schema The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- 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
Global
Table Projection - 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.
- Warm
Throughput GlobalTable Warm Throughput - Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify
ReadUnitsPerSecond
,WriteUnitsPerSecond
, or both. - Write
On GlobalDemand Throughput Settings Table Write On Demand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - Write
Provisioned GlobalThroughput Settings Table Write Provisioned Throughput Settings - Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's
BillingMode
isPROVISIONED
. All replicas will have the same write capacity settings for this global secondary index.
- index
Name String - The name of the global secondary index. The name must be unique among all other indexes on this table.
- key
Schema List<GlobalTable Key Schema> The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- 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
Global
Table Projection - 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.
- warm
Throughput GlobalTable Warm Throughput - Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify
ReadUnitsPerSecond
,WriteUnitsPerSecond
, or both. - write
On GlobalDemand Throughput Settings Table Write On Demand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - write
Provisioned GlobalThroughput Settings Table Write Provisioned Throughput Settings - Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's
BillingMode
isPROVISIONED
. All replicas will have the same write capacity settings for this global secondary index.
- index
Name string - The name of the global secondary index. The name must be unique among all other indexes on this table.
- key
Schema GlobalTable Key Schema[] The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- 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
Global
Table Projection - 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.
- warm
Throughput GlobalTable Warm Throughput - Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify
ReadUnitsPerSecond
,WriteUnitsPerSecond
, or both. - write
On GlobalDemand Throughput Settings Table Write On Demand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - write
Provisioned GlobalThroughput Settings Table Write Provisioned Throughput Settings - Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's
BillingMode
isPROVISIONED
. All replicas will have the same write capacity settings for this global secondary index.
- 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[GlobalTable Key Schema] The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- 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
Global
Table Projection - 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.
- warm_
throughput GlobalTable Warm Throughput - Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify
ReadUnitsPerSecond
,WriteUnitsPerSecond
, or both. - write_
on_ Globaldemand_ throughput_ settings Table Write On Demand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - write_
provisioned_ Globalthroughput_ settings Table Write Provisioned Throughput Settings - Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's
BillingMode
isPROVISIONED
. All replicas will have the same write capacity settings for this global secondary index.
- index
Name String - The name of the global secondary index. The name must be unique among all other indexes on this table.
- key
Schema 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 keyRANGE
- 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.
- warm
Throughput Property Map - Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify
ReadUnitsPerSecond
,WriteUnitsPerSecond
, or both. - write
On Property MapDemand Throughput Settings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - write
Provisioned Property MapThroughput Settings - Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's
BillingMode
isPROVISIONED
. All replicas will have the same write capacity settings for this global secondary index.
GlobalTableKeySchema
- Attribute
Name string - The name of a key attribute.
- Key
Type string The role that this key attribute will assume:
HASH
- partition keyRANGE
- 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 string - The name of a key attribute.
- Key
Type string The role that this key attribute will assume:
HASH
- partition keyRANGE
- 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 String - The name of a key attribute.
- key
Type String The role that this key attribute will assume:
HASH
- partition keyRANGE
- 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 string - The name of a key attribute.
- key
Type string The role that this key attribute will assume:
HASH
- partition keyRANGE
- 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 keyRANGE
- 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 String - The name of a key attribute.
- key
Type String The role that this key attribute will assume:
HASH
- partition keyRANGE
- 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.
GlobalTableKinesisStreamSpecification
- Stream
Arn string - The ARN for a specific Kinesis data stream.
- Approximate
Creation Pulumi.Date Time Precision Aws Native. Dynamo Db. Global Table Kinesis Stream Specification Approximate Creation Date Time Precision - The precision for the time and date that the stream was created.
- Stream
Arn string - The ARN for a specific Kinesis data stream.
- Approximate
Creation GlobalDate Time Precision Table Kinesis Stream Specification Approximate Creation Date Time Precision - The precision for the time and date that the stream was created.
- stream
Arn String - The ARN for a specific Kinesis data stream.
- approximate
Creation GlobalDate Time Precision Table Kinesis Stream Specification Approximate Creation Date Time Precision - The precision for the time and date that the stream was created.
- stream
Arn string - The ARN for a specific Kinesis data stream.
- approximate
Creation GlobalDate Time Precision Table Kinesis Stream Specification Approximate Creation Date Time Precision - The precision for the time and date that the stream was created.
- stream_
arn str - The ARN for a specific Kinesis data stream.
- approximate_
creation_ Globaldate_ time_ precision Table Kinesis Stream Specification Approximate Creation Date Time Precision - The precision for the time and date that the stream was created.
- stream
Arn String - The ARN for a specific Kinesis data stream.
- approximate
Creation "MICROSECOND" | "MILLISECOND"Date Time Precision - The precision for the time and date that the stream was created.
GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision
GlobalTablePointInTimeRecoverySpecification
- Point
In boolTime Recovery Enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- Point
In boolTime Recovery Enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- point
In BooleanTime Recovery Enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- point
In booleanTime Recovery Enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- point_
in_ booltime_ recovery_ enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- point
In BooleanTime Recovery Enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
GlobalTableProjection
- Non
Key List<string>Attributes 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 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 inKEYS_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 []stringAttributes 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 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 inKEYS_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 List<String>Attributes 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 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 inKEYS_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 string[]Attributes 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 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 inKEYS_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_ Sequence[str]attributes 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 inKEYS_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 List<String>Attributes 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 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 inKEYS_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.
GlobalTableReadOnDemandThroughputSettings
- Max
Read intRequest Units - Maximum number of read request units for the specified replica of a global table.
- Max
Read intRequest Units - Maximum number of read request units for the specified replica of a global table.
- max
Read IntegerRequest Units - Maximum number of read request units for the specified replica of a global table.
- max
Read numberRequest Units - Maximum number of read request units for the specified replica of a global table.
- max_
read_ intrequest_ units - Maximum number of read request units for the specified replica of a global table.
- max
Read NumberRequest Units - Maximum number of read request units for the specified replica of a global table.
GlobalTableReadProvisionedThroughputSettings
- Read
Capacity Pulumi.Auto Scaling Settings Aws Native. Dynamo Db. Inputs. Global Table Capacity Auto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- Read
Capacity intUnits - Specifies a fixed read capacity for the replica table or global secondary index.
- Read
Capacity GlobalAuto Scaling Settings Table Capacity Auto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- Read
Capacity intUnits - Specifies a fixed read capacity for the replica table or global secondary index.
- read
Capacity GlobalAuto Scaling Settings Table Capacity Auto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- read
Capacity IntegerUnits - Specifies a fixed read capacity for the replica table or global secondary index.
- read
Capacity GlobalAuto Scaling Settings Table Capacity Auto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- read
Capacity numberUnits - Specifies a fixed read capacity for the replica table or global secondary index.
- read_
capacity_ Globalauto_ scaling_ settings Table Capacity Auto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- read_
capacity_ intunits - Specifies a fixed read capacity for the replica table or global secondary index.
- read
Capacity Property MapAuto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- read
Capacity NumberUnits - Specifies a fixed read capacity for the replica table or global secondary index.
GlobalTableReplicaGlobalSecondaryIndexSpecification
- Index
Name string - The name of the global secondary index. The name must be unique among all other indexes on this table.
- Contributor
Insights Pulumi.Specification Aws Native. Dynamo Db. Inputs. Global Table Contributor Insights Specification - Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
- Read
On Pulumi.Demand Throughput Settings Aws Native. Dynamo Db. Inputs. Global Table Read On Demand Throughput Settings - Sets the read request settings for a replica global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - Read
Provisioned Pulumi.Throughput Settings Aws Native. Dynamo Db. Inputs. Global Table Read Provisioned Throughput Settings - Allows you to specify the read capacity settings for a replica global secondary index when the
BillingMode
is set toPROVISIONED
.
- Index
Name string - The name of the global secondary index. The name must be unique among all other indexes on this table.
- Contributor
Insights GlobalSpecification Table Contributor Insights Specification - Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
- Read
On GlobalDemand Throughput Settings Table Read On Demand Throughput Settings - Sets the read request settings for a replica global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - Read
Provisioned GlobalThroughput Settings Table Read Provisioned Throughput Settings - Allows you to specify the read capacity settings for a replica global secondary index when the
BillingMode
is set toPROVISIONED
.
- index
Name String - The name of the global secondary index. The name must be unique among all other indexes on this table.
- contributor
Insights GlobalSpecification Table Contributor Insights Specification - Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
- read
On GlobalDemand Throughput Settings Table Read On Demand Throughput Settings - Sets the read request settings for a replica global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - read
Provisioned GlobalThroughput Settings Table Read Provisioned Throughput Settings - Allows you to specify the read capacity settings for a replica global secondary index when the
BillingMode
is set toPROVISIONED
.
- index
Name string - The name of the global secondary index. The name must be unique among all other indexes on this table.
- contributor
Insights GlobalSpecification Table Contributor Insights Specification - Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
- read
On GlobalDemand Throughput Settings Table Read On Demand Throughput Settings - Sets the read request settings for a replica global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - read
Provisioned GlobalThroughput Settings Table Read Provisioned Throughput Settings - Allows you to specify the read capacity settings for a replica global secondary index when the
BillingMode
is set toPROVISIONED
.
- index_
name str - The name of the global secondary index. The name must be unique among all other indexes on this table.
- contributor_
insights_ Globalspecification Table Contributor Insights Specification - Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
- read_
on_ Globaldemand_ throughput_ settings Table Read On Demand Throughput Settings - Sets the read request settings for a replica global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - read_
provisioned_ Globalthroughput_ settings Table Read Provisioned Throughput Settings - Allows you to specify the read capacity settings for a replica global secondary index when the
BillingMode
is set toPROVISIONED
.
- index
Name String - The name of the global secondary index. The name must be unique among all other indexes on this table.
- contributor
Insights Property MapSpecification - Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
- read
On Property MapDemand Throughput Settings - Sets the read request settings for a replica global secondary index. You can only specify this setting if your resource uses the
PAY_PER_REQUEST
BillingMode
. - read
Provisioned Property MapThroughput Settings - Allows you to specify the read capacity settings for a replica global secondary index when the
BillingMode
is set toPROVISIONED
.
GlobalTableReplicaSpecification
- Region string
- The region in which this replica exists.
- Contributor
Insights Pulumi.Specification Aws Native. Dynamo Db. Inputs. Global Table Contributor Insights Specification - The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.
- Deletion
Protection boolEnabled - Determines if a replica 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 Amazon DynamoDB Developer Guide .
- Global
Secondary List<Pulumi.Indexes Aws Native. Dynamo Db. Inputs. Global Table Replica Global Secondary Index Specification> - Defines additional settings for the global secondary indexes of this replica.
- Kinesis
Stream Pulumi.Specification Aws Native. Dynamo Db. Inputs. Global Table Kinesis Stream Specification - Defines the Kinesis Data Streams configuration for the specified replica.
- Point
In Pulumi.Time Recovery Specification Aws Native. Dynamo Db. Inputs. Global Table Point In Time Recovery Specification - The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.
- Read
On Pulumi.Demand Throughput Settings Aws Native. Dynamo Db. Inputs. Global Table Read On Demand Throughput Settings - Sets read request settings for the replica table.
- Read
Provisioned Pulumi.Throughput Settings Aws Native. Dynamo Db. Inputs. Global Table Read Provisioned Throughput Settings - Defines read capacity settings for the replica table.
- Replica
Stream Pulumi.Specification Aws Native. Dynamo Db. Inputs. Global Table Replica Stream Specification - Represents the DynamoDB Streams configuration for a global table replica.
- Resource
Policy Pulumi.Aws Native. Dynamo Db. Inputs. Global Table Resource Policy A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- Sse
Specification Pulumi.Aws Native. Dynamo Db. Inputs. Global Table Replica Sse Specification - Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.
- Table
Class string - The table class of the specified table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - List<Pulumi.
Aws Native. Dynamo Db. Inputs. Global Table Tag> An array of key-value pairs to apply to this replica.
For more information, see Tag .
- Region string
- The region in which this replica exists.
- Contributor
Insights GlobalSpecification Table Contributor Insights Specification - The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.
- Deletion
Protection boolEnabled - Determines if a replica 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 Amazon DynamoDB Developer Guide .
- Global
Secondary []GlobalIndexes Table Replica Global Secondary Index Specification - Defines additional settings for the global secondary indexes of this replica.
- Kinesis
Stream GlobalSpecification Table Kinesis Stream Specification - Defines the Kinesis Data Streams configuration for the specified replica.
- Point
In GlobalTime Recovery Specification Table Point In Time Recovery Specification - The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.
- Read
On GlobalDemand Throughput Settings Table Read On Demand Throughput Settings - Sets read request settings for the replica table.
- Read
Provisioned GlobalThroughput Settings Table Read Provisioned Throughput Settings - Defines read capacity settings for the replica table.
- Replica
Stream GlobalSpecification Table Replica Stream Specification - Represents the DynamoDB Streams configuration for a global table replica.
- Resource
Policy GlobalTable Resource Policy A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- Sse
Specification GlobalTable Replica Sse Specification - Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.
- Table
Class string - The table class of the specified table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - []Global
Table Tag An array of key-value pairs to apply to this replica.
For more information, see Tag .
- region String
- The region in which this replica exists.
- contributor
Insights GlobalSpecification Table Contributor Insights Specification - The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.
- deletion
Protection BooleanEnabled - Determines if a replica 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 Amazon DynamoDB Developer Guide .
- global
Secondary List<GlobalIndexes Table Replica Global Secondary Index Specification> - Defines additional settings for the global secondary indexes of this replica.
- kinesis
Stream GlobalSpecification Table Kinesis Stream Specification - Defines the Kinesis Data Streams configuration for the specified replica.
- point
In GlobalTime Recovery Specification Table Point In Time Recovery Specification - The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.
- read
On GlobalDemand Throughput Settings Table Read On Demand Throughput Settings - Sets read request settings for the replica table.
- read
Provisioned GlobalThroughput Settings Table Read Provisioned Throughput Settings - Defines read capacity settings for the replica table.
- replica
Stream GlobalSpecification Table Replica Stream Specification - Represents the DynamoDB Streams configuration for a global table replica.
- resource
Policy GlobalTable Resource Policy A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- sse
Specification GlobalTable Replica Sse Specification - Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.
- table
Class String - The table class of the specified table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - List<Global
Table Tag> An array of key-value pairs to apply to this replica.
For more information, see Tag .
- region string
- The region in which this replica exists.
- contributor
Insights GlobalSpecification Table Contributor Insights Specification - The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.
- deletion
Protection booleanEnabled - Determines if a replica 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 Amazon DynamoDB Developer Guide .
- global
Secondary GlobalIndexes Table Replica Global Secondary Index Specification[] - Defines additional settings for the global secondary indexes of this replica.
- kinesis
Stream GlobalSpecification Table Kinesis Stream Specification - Defines the Kinesis Data Streams configuration for the specified replica.
- point
In GlobalTime Recovery Specification Table Point In Time Recovery Specification - The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.
- read
On GlobalDemand Throughput Settings Table Read On Demand Throughput Settings - Sets read request settings for the replica table.
- read
Provisioned GlobalThroughput Settings Table Read Provisioned Throughput Settings - Defines read capacity settings for the replica table.
- replica
Stream GlobalSpecification Table Replica Stream Specification - Represents the DynamoDB Streams configuration for a global table replica.
- resource
Policy GlobalTable Resource Policy A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- sse
Specification GlobalTable Replica Sse Specification - Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.
- table
Class string - The table class of the specified table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - Global
Table Tag[] An array of key-value pairs to apply to this replica.
For more information, see Tag .
- region str
- The region in which this replica exists.
- contributor_
insights_ Globalspecification Table Contributor Insights Specification - The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.
- deletion_
protection_ boolenabled - Determines if a replica 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 Amazon DynamoDB Developer Guide .
- global_
secondary_ Sequence[Globalindexes Table Replica Global Secondary Index Specification] - Defines additional settings for the global secondary indexes of this replica.
- kinesis_
stream_ Globalspecification Table Kinesis Stream Specification - Defines the Kinesis Data Streams configuration for the specified replica.
- point_
in_ Globaltime_ recovery_ specification Table Point In Time Recovery Specification - The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.
- read_
on_ Globaldemand_ throughput_ settings Table Read On Demand Throughput Settings - Sets read request settings for the replica table.
- read_
provisioned_ Globalthroughput_ settings Table Read Provisioned Throughput Settings - Defines read capacity settings for the replica table.
- replica_
stream_ Globalspecification Table Replica Stream Specification - Represents the DynamoDB Streams configuration for a global table replica.
- resource_
policy GlobalTable Resource Policy A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- sse_
specification GlobalTable Replica Sse Specification - Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.
- table_
class str - The table class of the specified table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - Sequence[Global
Table Tag] An array of key-value pairs to apply to this replica.
For more information, see Tag .
- region String
- The region in which this replica exists.
- contributor
Insights Property MapSpecification - The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.
- deletion
Protection BooleanEnabled - Determines if a replica 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 Amazon DynamoDB Developer Guide .
- global
Secondary List<Property Map>Indexes - Defines additional settings for the global secondary indexes of this replica.
- kinesis
Stream Property MapSpecification - Defines the Kinesis Data Streams configuration for the specified replica.
- point
In Property MapTime Recovery Specification - The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.
- read
On Property MapDemand Throughput Settings - Sets read request settings for the replica table.
- read
Provisioned Property MapThroughput Settings - Defines read capacity settings for the replica table.
- replica
Stream Property MapSpecification - Represents the DynamoDB Streams configuration for a global table replica.
- resource
Policy Property Map A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- sse
Specification Property Map - Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.
- table
Class String - The table class of the specified table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - List<Property Map>
An array of key-value pairs to apply to this replica.
For more information, see Tag .
GlobalTableReplicaSseSpecification
- Kms
Master stringKey Id - The AWS KMS key that should be used for the AWS 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
.
- Kms
Master stringKey Id - The AWS KMS key that should be used for the AWS 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
.
- kms
Master StringKey Id - The AWS KMS key that should be used for the AWS 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
.
- kms
Master stringKey Id - The AWS KMS key that should be used for the AWS 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
.
- kms_
master_ strkey_ id - The AWS KMS key that should be used for the AWS 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
.
- kms
Master StringKey Id - The AWS KMS key that should be used for the AWS 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
.
GlobalTableReplicaStreamSpecification
- Resource
Policy Pulumi.Aws Native. Dynamo Db. Inputs. Global Table Resource Policy A resource-based policy document that contains the permissions for the specified stream of a DynamoDB global table replica. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
You can update the
ResourcePolicy
property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.
- Resource
Policy GlobalTable Resource Policy A resource-based policy document that contains the permissions for the specified stream of a DynamoDB global table replica. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
You can update the
ResourcePolicy
property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.
- resource
Policy GlobalTable Resource Policy A resource-based policy document that contains the permissions for the specified stream of a DynamoDB global table replica. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
You can update the
ResourcePolicy
property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.
- resource
Policy GlobalTable Resource Policy A resource-based policy document that contains the permissions for the specified stream of a DynamoDB global table replica. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
You can update the
ResourcePolicy
property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.
- resource_
policy GlobalTable Resource Policy A resource-based policy document that contains the permissions for the specified stream of a DynamoDB global table replica. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
You can update the
ResourcePolicy
property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.
- resource
Policy Property Map A resource-based policy document that contains the permissions for the specified stream of a DynamoDB global table replica. 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 CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
You can update the
ResourcePolicy
property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.
GlobalTableResourcePolicy
- Policy
Document object - A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- Policy
Document interface{} - A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- policy
Document Object - A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- policy
Document any - A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- policy_
document Any - A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
- policy
Document Any - A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .
GlobalTableSseSpecification
- Sse
Enabled bool - Indicates whether server-side encryption is performed 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 ( AWS KMS charges apply). If disabled (false) or not specified,server-side encryption is set to an AWS owned key. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the
ReplicaSpecification.SSESpecification
object. You cannot mix AWS managed and customer managed KMS keys. - Sse
Type string - Server-side encryption type. The only supported value is:
KMS
- Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).
- Sse
Enabled bool - Indicates whether server-side encryption is performed 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 ( AWS KMS charges apply). If disabled (false) or not specified,server-side encryption is set to an AWS owned key. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the
ReplicaSpecification.SSESpecification
object. You cannot mix AWS managed and customer managed KMS keys. - Sse
Type string - Server-side encryption type. The only supported value is:
KMS
- Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).
- sse
Enabled Boolean - Indicates whether server-side encryption is performed 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 ( AWS KMS charges apply). If disabled (false) or not specified,server-side encryption is set to an AWS owned key. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the
ReplicaSpecification.SSESpecification
object. You cannot mix AWS managed and customer managed KMS keys. - sse
Type String - Server-side encryption type. The only supported value is:
KMS
- Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).
- sse
Enabled boolean - Indicates whether server-side encryption is performed 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 ( AWS KMS charges apply). If disabled (false) or not specified,server-side encryption is set to an AWS owned key. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the
ReplicaSpecification.SSESpecification
object. You cannot mix AWS managed and customer managed KMS keys. - sse
Type string - Server-side encryption type. The only supported value is:
KMS
- Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).
- sse_
enabled bool - Indicates whether server-side encryption is performed 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 ( AWS KMS charges apply). If disabled (false) or not specified,server-side encryption is set to an AWS owned key. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the
ReplicaSpecification.SSESpecification
object. You cannot mix AWS managed and customer managed KMS keys. - sse_
type str - Server-side encryption type. The only supported value is:
KMS
- Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).
- sse
Enabled Boolean - Indicates whether server-side encryption is performed 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 ( AWS KMS charges apply). If disabled (false) or not specified,server-side encryption is set to an AWS owned key. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the
ReplicaSpecification.SSESpecification
object. You cannot mix AWS managed and customer managed KMS keys. - sse
Type String - Server-side encryption type. The only supported value is:
KMS
- Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).
GlobalTableStreamSpecification
- Stream
View stringType - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
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.
- Stream
View stringType - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
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.
- stream
View StringType - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
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.
- stream
View stringType - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
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.
- stream_
view_ strtype - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
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.
- stream
View StringType - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
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.
GlobalTableTag
- Key string
- The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
- Value string
- The value of the tag. Tag values are case-sensitive and can be null.
- Key string
- The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
- Value string
- The value of the tag. Tag values are case-sensitive and can be null.
- key String
- The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
- value String
- The value of the tag. Tag values are case-sensitive and can be null.
- key string
- The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
- value string
- The value of the tag. Tag values are case-sensitive and can be null.
- key str
- The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
- value str
- The value of the tag. Tag values are case-sensitive and can be null.
- key String
- The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
- value String
- The value of the tag. Tag values are case-sensitive and can be null.
GlobalTableTargetTrackingScalingPolicyConfiguration
- Target
Value double - Defines a target value for the scaling policy.
- Disable
Scale boolIn - Indicates whether scale in by the target tracking scaling policy is disabled. The default value is
false
. - Scale
In intCooldown - The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
- Scale
Out intCooldown - The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
- Target
Value float64 - Defines a target value for the scaling policy.
- Disable
Scale boolIn - Indicates whether scale in by the target tracking scaling policy is disabled. The default value is
false
. - Scale
In intCooldown - The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
- Scale
Out intCooldown - The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
- target
Value Double - Defines a target value for the scaling policy.
- disable
Scale BooleanIn - Indicates whether scale in by the target tracking scaling policy is disabled. The default value is
false
. - scale
In IntegerCooldown - The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
- scale
Out IntegerCooldown - The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
- target
Value number - Defines a target value for the scaling policy.
- disable
Scale booleanIn - Indicates whether scale in by the target tracking scaling policy is disabled. The default value is
false
. - scale
In numberCooldown - The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
- scale
Out numberCooldown - The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
- target_
value float - Defines a target value for the scaling policy.
- disable_
scale_ boolin - Indicates whether scale in by the target tracking scaling policy is disabled. The default value is
false
. - scale_
in_ intcooldown - The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
- scale_
out_ intcooldown - The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
- target
Value Number - Defines a target value for the scaling policy.
- disable
Scale BooleanIn - Indicates whether scale in by the target tracking scaling policy is disabled. The default value is
false
. - scale
In NumberCooldown - The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
- scale
Out NumberCooldown - The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
GlobalTableTimeToLiveSpecification
- Enabled bool
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- Attribute
Name string The name of the attribute used to store the expiration time for items in the table.
Currently, you cannot directly change the attribute name used to evaluate time to live. In order to do so, you must first disable time to live, and then re-enable it with the new attribute name. It can take up to one hour for changes to time to live to take effect. If you attempt to modify time to live within that time window, your stack operation might be delayed.
- Enabled bool
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- Attribute
Name string The name of the attribute used to store the expiration time for items in the table.
Currently, you cannot directly change the attribute name used to evaluate time to live. In order to do so, you must first disable time to live, and then re-enable it with the new attribute name. It can take up to one hour for changes to time to live to take effect. If you attempt to modify time to live within that time window, your stack operation might be delayed.
- enabled Boolean
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- attribute
Name String The name of the attribute used to store the expiration time for items in the table.
Currently, you cannot directly change the attribute name used to evaluate time to live. In order to do so, you must first disable time to live, and then re-enable it with the new attribute name. It can take up to one hour for changes to time to live to take effect. If you attempt to modify time to live within that time window, your stack operation might be delayed.
- enabled boolean
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- attribute
Name string The name of the attribute used to store the expiration time for items in the table.
Currently, you cannot directly change the attribute name used to evaluate time to live. In order to do so, you must first disable time to live, and then re-enable it with the new attribute name. It can take up to one hour for changes to time to live to take effect. If you attempt to modify time to live within that time window, your stack operation might be delayed.
- enabled bool
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- attribute_
name str The name of the attribute used to store the expiration time for items in the table.
Currently, you cannot directly change the attribute name used to evaluate time to live. In order to do so, you must first disable time to live, and then re-enable it with the new attribute name. It can take up to one hour for changes to time to live to take effect. If you attempt to modify time to live within that time window, your stack operation might be delayed.
- enabled Boolean
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- attribute
Name String The name of the attribute used to store the expiration time for items in the table.
Currently, you cannot directly change the attribute name used to evaluate time to live. In order to do so, you must first disable time to live, and then re-enable it with the new attribute name. It can take up to one hour for changes to time to live to take effect. If you attempt to modify time to live within that time window, your stack operation might be delayed.
GlobalTableWarmThroughput
- Read
Units intPer Second - Represents the number of read operations your base table can instantaneously support.
- Write
Units intPer Second - Represents the number of write operations your base table can instantaneously support.
- Read
Units intPer Second - Represents the number of read operations your base table can instantaneously support.
- Write
Units intPer Second - Represents the number of write operations your base table can instantaneously support.
- read
Units IntegerPer Second - Represents the number of read operations your base table can instantaneously support.
- write
Units IntegerPer Second - Represents the number of write operations your base table can instantaneously support.
- read
Units numberPer Second - Represents the number of read operations your base table can instantaneously support.
- write
Units numberPer Second - Represents the number of write operations your base table can instantaneously support.
- read_
units_ intper_ second - Represents the number of read operations your base table can instantaneously support.
- write_
units_ intper_ second - Represents the number of write operations your base table can instantaneously support.
- read
Units NumberPer Second - Represents the number of read operations your base table can instantaneously support.
- write
Units NumberPer Second - Represents the number of write operations your base table can instantaneously support.
GlobalTableWriteOnDemandThroughputSettings
- Max
Write intRequest Units - Maximum number of write request settings for the specified replica of a global table.
- Max
Write intRequest Units - Maximum number of write request settings for the specified replica of a global table.
- max
Write IntegerRequest Units - Maximum number of write request settings for the specified replica of a global table.
- max
Write numberRequest Units - Maximum number of write request settings for the specified replica of a global table.
- max_
write_ intrequest_ units - Maximum number of write request settings for the specified replica of a global table.
- max
Write NumberRequest Units - Maximum number of write request settings for the specified replica of a global table.
GlobalTableWriteProvisionedThroughputSettings
- Write
Capacity Pulumi.Auto Scaling Settings Aws Native. Dynamo Db. Inputs. Global Table Capacity Auto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- Write
Capacity GlobalAuto Scaling Settings Table Capacity Auto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- write
Capacity GlobalAuto Scaling Settings Table Capacity Auto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- write
Capacity GlobalAuto Scaling Settings Table Capacity Auto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- write_
capacity_ Globalauto_ scaling_ settings Table Capacity Auto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
- write
Capacity Property MapAuto Scaling Settings - Specifies auto scaling settings for the replica table or global secondary index.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.