Class CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty

Allows you to specify a global secondary index for the global table.

Inheritance

object

CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty

Implements

CfnGlobalTablePropsMixin.IGlobalSecondaryIndexProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.DynamoDB

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty : CfnGlobalTablePropsMixin.IGlobalSecondaryIndexProperty

Syntax (vb)

Public Class CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty Implements CfnGlobalTablePropsMixin.IGlobalSecondaryIndexProperty

Remarks

The index will be defined on all replicas.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html

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.CfnPropertyMixins.AWS.DynamoDB;

             var globalSecondaryIndexProperty = new GlobalSecondaryIndexProperty {
                 IndexName = "indexName",
                 KeySchema = new [] { new KeySchemaProperty {
                     AttributeName = "attributeName",
                     KeyType = "keyType"
                 } },
                 Projection = new ProjectionProperty {
                     NonKeyAttributes = new [] { "nonKeyAttributes" },
                     ProjectionType = "projectionType"
                 },
                 ReadOnDemandThroughputSettings = new ReadOnDemandThroughputSettingsProperty {
                     MaxReadRequestUnits = 123
                 },
                 ReadProvisionedThroughputSettings = new GlobalReadProvisionedThroughputSettingsProperty {
                     ReadCapacityUnits = 123
                 },
                 WarmThroughput = new WarmThroughputProperty {
                     ReadUnitsPerSecond = 123,
                     WriteUnitsPerSecond = 123
                 },
                 WriteOnDemandThroughputSettings = new WriteOnDemandThroughputSettingsProperty {
                     MaxWriteRequestUnits = 123
                 },
                 WriteProvisionedThroughputSettings = new WriteProvisionedThroughputSettingsProperty {
                     WriteCapacityAutoScalingSettings = new CapacityAutoScalingSettingsProperty {
                         MaxCapacity = 123,
                         MinCapacity = 123,
                         SeedCapacity = 123,
                         TargetTrackingScalingPolicyConfiguration = new TargetTrackingScalingPolicyConfigurationProperty {
                             DisableScaleIn = false,
                             ScaleInCooldown = 123,
                             ScaleOutCooldown = 123,
                             TargetValue = 123
                         }
                     }
                 }
             };

Synopsis

Constructors

GlobalSecondaryIndexProperty()

Allows you to specify a global secondary index for the global table.

Properties

IndexName	The name of the global secondary index.
KeySchema	The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: - HASH - partition key - RANGE - sort key > The partition key of an item is also known as its hash attribute .
Projection	Represents attributes that are copied (projected) from the table into the global secondary index.
ReadOnDemandThroughputSettings	Allows you to specify a global secondary index for the global table.
ReadProvisionedThroughputSettings	Allows you to specify a global secondary index for the global table.
WarmThroughput	Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
WriteOnDemandThroughputSettings	Sets the write request settings for a global table or a global secondary index.
WriteProvisionedThroughputSettings	Defines write capacity settings for the global secondary index.

Constructors

GlobalSecondaryIndexProperty()

Allows you to specify a global secondary index for the global table.

public GlobalSecondaryIndexProperty()

Remarks

The index will be defined on all replicas.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html

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.CfnPropertyMixins.AWS.DynamoDB;

             var globalSecondaryIndexProperty = new GlobalSecondaryIndexProperty {
                 IndexName = "indexName",
                 KeySchema = new [] { new KeySchemaProperty {
                     AttributeName = "attributeName",
                     KeyType = "keyType"
                 } },
                 Projection = new ProjectionProperty {
                     NonKeyAttributes = new [] { "nonKeyAttributes" },
                     ProjectionType = "projectionType"
                 },
                 ReadOnDemandThroughputSettings = new ReadOnDemandThroughputSettingsProperty {
                     MaxReadRequestUnits = 123
                 },
                 ReadProvisionedThroughputSettings = new GlobalReadProvisionedThroughputSettingsProperty {
                     ReadCapacityUnits = 123
                 },
                 WarmThroughput = new WarmThroughputProperty {
                     ReadUnitsPerSecond = 123,
                     WriteUnitsPerSecond = 123
                 },
                 WriteOnDemandThroughputSettings = new WriteOnDemandThroughputSettingsProperty {
                     MaxWriteRequestUnits = 123
                 },
                 WriteProvisionedThroughputSettings = new WriteProvisionedThroughputSettingsProperty {
                     WriteCapacityAutoScalingSettings = new CapacityAutoScalingSettingsProperty {
                         MaxCapacity = 123,
                         MinCapacity = 123,
                         SeedCapacity = 123,
                         TargetTrackingScalingPolicyConfiguration = new TargetTrackingScalingPolicyConfigurationProperty {
                             DisableScaleIn = false,
                             ScaleInCooldown = 123,
                             ScaleOutCooldown = 123,
                             TargetValue = 123
                         }
                     }
                 }
             };

Properties

IndexName

The name of the global secondary index.

public string? IndexName { get; set; }

Property Value

string

Remarks

The name must be unique among all other indexes on this table.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-indexname

KeySchema

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: - HASH - partition key - RANGE - sort key > The partition key of an item is also known as its hash attribute .

public object? KeySchema { get; set; }

Property Value

object

Remarks

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 <em>range attribute</em> . 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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-keyschema

Type union: either IResolvable or (either IResolvable or CfnGlobalTablePropsMixin.IKeySchemaProperty)[]

Projection

Represents attributes that are copied (projected) from the table into the global secondary index.

public object? Projection { get; set; }

Property Value

object

Remarks

These are in addition to the primary key attributes and index key attributes, which are automatically projected.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-projection

Type union: either IResolvable or CfnGlobalTablePropsMixin.IProjectionProperty

ReadOnDemandThroughputSettings

Allows you to specify a global secondary index for the global table.

public object? ReadOnDemandThroughputSettings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-readondemandthroughputsettings

Type union: either IResolvable or CfnGlobalTablePropsMixin.IReadOnDemandThroughputSettingsProperty

ReadProvisionedThroughputSettings

Allows you to specify a global secondary index for the global table.

public object? ReadProvisionedThroughputSettings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-readprovisionedthroughputsettings

Type union: either IResolvable or CfnGlobalTablePropsMixin.IGlobalReadProvisionedThroughputSettingsProperty

WarmThroughput

Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.

public object? WarmThroughput { get; set; }

Property Value

object

Remarks

If you use this parameter, you must specify ReadUnitsPerSecond , WriteUnitsPerSecond , or both.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-warmthroughput

Type union: either IResolvable or CfnGlobalTablePropsMixin.IWarmThroughputProperty

WriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index.

public object? WriteOnDemandThroughputSettings { get; set; }

Property Value

object

Remarks

You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-writeondemandthroughputsettings

Type union: either IResolvable or CfnGlobalTablePropsMixin.IWriteOnDemandThroughputSettingsProperty

WriteProvisionedThroughputSettings

Defines write capacity settings for the global secondary index.

public object? WriteProvisionedThroughputSettings { get; set; }

Property Value

object

Remarks

You must specify a value for this property if the table's BillingMode is PROVISIONED . All replicas will have the same write capacity settings for this global secondary index.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-writeprovisionedthroughputsettings

Type union: either IResolvable or CfnGlobalTablePropsMixin.IWriteProvisionedThroughputSettingsProperty

Implements

CfnGlobalTablePropsMixin.IGlobalSecondaryIndexProperty