Interface CfnGlobalTable.IReplicaSpecificationProperty
Defines settings specific to a single replica of a global table.
Namespace: Amazon.CDK.AWS.DynamoDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IReplicaSpecificationPropertySyntax (vb)
Public Interface IReplicaSpecificationPropertyRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DynamoDB;
var policyDocument;
var replicaSpecificationProperty = new ReplicaSpecificationProperty {
Region = "region",
// the properties below are optional
ContributorInsightsSpecification = new ContributorInsightsSpecificationProperty {
Enabled = false
},
DeletionProtectionEnabled = false,
GlobalSecondaryIndexes = new [] { new ReplicaGlobalSecondaryIndexSpecificationProperty {
IndexName = "indexName",
// the properties below are optional
ContributorInsightsSpecification = new ContributorInsightsSpecificationProperty {
Enabled = false
},
ReadOnDemandThroughputSettings = new ReadOnDemandThroughputSettingsProperty {
MaxReadRequestUnits = 123
},
ReadProvisionedThroughputSettings = new ReadProvisionedThroughputSettingsProperty {
ReadCapacityAutoScalingSettings = new CapacityAutoScalingSettingsProperty {
MaxCapacity = 123,
MinCapacity = 123,
TargetTrackingScalingPolicyConfiguration = new TargetTrackingScalingPolicyConfigurationProperty {
TargetValue = 123,
// the properties below are optional
DisableScaleIn = false,
ScaleInCooldown = 123,
ScaleOutCooldown = 123
},
// the properties below are optional
SeedCapacity = 123
},
ReadCapacityUnits = 123
}
} },
KinesisStreamSpecification = new KinesisStreamSpecificationProperty {
StreamArn = "streamArn",
// the properties below are optional
ApproximateCreationDateTimePrecision = "approximateCreationDateTimePrecision"
},
PointInTimeRecoverySpecification = new PointInTimeRecoverySpecificationProperty {
PointInTimeRecoveryEnabled = false,
RecoveryPeriodInDays = 123
},
ReadOnDemandThroughputSettings = new ReadOnDemandThroughputSettingsProperty {
MaxReadRequestUnits = 123
},
ReadProvisionedThroughputSettings = new ReadProvisionedThroughputSettingsProperty {
ReadCapacityAutoScalingSettings = new CapacityAutoScalingSettingsProperty {
MaxCapacity = 123,
MinCapacity = 123,
TargetTrackingScalingPolicyConfiguration = new TargetTrackingScalingPolicyConfigurationProperty {
TargetValue = 123,
// the properties below are optional
DisableScaleIn = false,
ScaleInCooldown = 123,
ScaleOutCooldown = 123
},
// the properties below are optional
SeedCapacity = 123
},
ReadCapacityUnits = 123
},
ReplicaStreamSpecification = new ReplicaStreamSpecificationProperty {
ResourcePolicy = new ResourcePolicyProperty {
PolicyDocument = policyDocument
}
},
ResourcePolicy = new ResourcePolicyProperty {
PolicyDocument = policyDocument
},
SseSpecification = new ReplicaSSESpecificationProperty {
KmsMasterKeyId = "kmsMasterKeyId"
},
TableClass = "tableClass",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};Synopsis
Properties
| Contributor |
The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. |
| Deletion |
Determines if a replica is protected from deletion. |
| Global |
Defines additional settings for the global secondary indexes of this replica. |
| Kinesis |
Defines the Kinesis Data Streams configuration for the specified replica. |
| Point |
The settings used to enable point in time recovery. |
| Read |
Sets read request settings for the replica table. |
| Read |
Defines read capacity settings for the replica table. |
| Region | The region in which this replica exists. |
| Replica |
Represents the DynamoDB Streams configuration for a global table replica. |
| Resource |
A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table. |
| Sse |
Allows you to specify a customer-managed key for the replica. |
| Table |
The table class of the specified table. |
| Tags | An array of key-value pairs to apply to this replica. |
Properties
ContributorInsightsSpecification
The settings used to enable or disable CloudWatch Contributor Insights for the specified replica.
virtual object ContributorInsightsSpecification { get; }Property Value
System.
Remarks
When not specified, defaults to contributor insights disabled for the replica.
DeletionProtectionEnabled
Determines if a replica is protected from deletion.
virtual object DeletionProtectionEnabled { get; }Property Value
System.
Remarks
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 .
GlobalSecondaryIndexes
Defines additional settings for the global secondary indexes of this replica.
virtual object GlobalSecondaryIndexes { get; }Property Value
System.
Remarks
KinesisStreamSpecification
Defines the Kinesis Data Streams configuration for the specified replica.
virtual object KinesisStreamSpecification { get; }Property Value
System.
Remarks
PointInTimeRecoverySpecification
The settings used to enable point in time recovery.
virtual object PointInTimeRecoverySpecification { get; }Property Value
System.
Remarks
When not specified, defaults to point in time recovery disabled for the replica.
ReadOnDemandThroughputSettings
Sets read request settings for the replica table.
virtual object ReadOnDemandThroughputSettings { get; }Property Value
System.
Remarks
ReadProvisionedThroughputSettings
Defines read capacity settings for the replica table.
virtual object ReadProvisionedThroughputSettings { get; }Property Value
System.
Remarks
Region
The region in which this replica exists.
string Region { get; }Property Value
System.
Remarks
ReplicaStreamSpecification
Represents the DynamoDB Streams configuration for a global table replica.
virtual object ReplicaStreamSpecification { get; }Property Value
System.
Remarks
ResourcePolicy
A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table.
virtual object ResourcePolicy { get; }Property Value
System.
Remarks
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 .
SseSpecification
Allows you to specify a customer-managed key for the replica.
virtual object SseSpecification { get; }Property Value
System.
Remarks
When using customer-managed keys for server-side encryption, this property must have a value in all replicas.
TableClass
The table class of the specified table.
virtual string TableClass { get; }Property Value
System.
Remarks
Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .
Tags
An array of key-value pairs to apply to this replica.
virtual ICfnTag[] Tags { get; }Property Value
ICfn