Class ReplicaTableProps
Properties used to configure a replica table.
Inheritance
Namespace: Amazon.CDK.AWS.DynamoDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ReplicaTableProps : Object, IReplicaTableProps, ITableOptionsV2
Syntax (vb)
Public Class ReplicaTableProps
Inherits Object
Implements IReplicaTableProps, ITableOptionsV2
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK;
var app = new App();
var stack = new Stack(app, "Stack", new StackProps { Env = new Environment { Region = "us-west-2" } });
var globalTable = new TableV2(stack, "GlobalTable", new TablePropsV2 {
PartitionKey = new Attribute { Name = "pk", Type = AttributeType.STRING },
Replicas = new [] { new ReplicaTableProps { Region = "us-east-1" } }
});
globalTable.AddReplica(new ReplicaTableProps { Region = "us-east-2", DeletionProtection = true });
Synopsis
Constructors
ReplicaTableProps() |
Properties
ContributorInsights | Whether CloudWatch contributor insights is enabled. |
DeletionProtection | Whether deletion protection is enabled. |
GlobalSecondaryIndexOptions | Options used to configure global secondary index properties. |
KinesisStream | Kinesis Data Stream to capture item level changes. |
PointInTimeRecovery | Whether point-in-time recovery is enabled. |
ReadCapacity | The read capacity. |
Region | The region that the replica table will be created in. |
TableClass | The table class. |
Tags | Tags to be applied to the table or replica table. |
Constructors
ReplicaTableProps()
public ReplicaTableProps()
Properties
ContributorInsights
Whether CloudWatch contributor insights is enabled.
public Nullable<bool> ContributorInsights { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
DeletionProtection
Whether deletion protection is enabled.
public Nullable<bool> DeletionProtection { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
GlobalSecondaryIndexOptions
Options used to configure global secondary index properties.
public IDictionary<string, IReplicaGlobalSecondaryIndexOptions> GlobalSecondaryIndexOptions { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, IReplicaGlobalSecondaryIndexOptions>
Remarks
Default: - inherited from the primary table
KinesisStream
Kinesis Data Stream to capture item level changes.
public IStream KinesisStream { get; set; }
Property Value
Remarks
Default: - no Kinesis Data Stream
PointInTimeRecovery
Whether point-in-time recovery is enabled.
public Nullable<bool> PointInTimeRecovery { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
ReadCapacity
The read capacity.
public Capacity ReadCapacity { get; set; }
Property Value
Remarks
Note: This can only be configured if the primary table billing is provisioned.
Default: - inherited from the primary table
Region
The region that the replica table will be created in.
public string Region { get; set; }
Property Value
System.String
TableClass
The table class.
public Nullable<TableClass> TableClass { get; set; }
Property Value
System.Nullable<TableClass>
Remarks
Default: TableClass.STANDARD
Tags
Tags to be applied to the table or replica table.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
Default: - no tags