Show / Hide Table of Contents

Namespace Amazon.CDK.AWS.DynamoDB

Classes

Attribute

Represents an attribute for describing the key schema for the table and indexes.

AutoscaledCapacityOptions

Options used to configure autoscaled capacity.

Billing

Represents how capacity is managed and how you are charged for read and write throughput for a DynamoDB table.

Capacity

Represents the amount of read and write operations supported by a DynamoDB table.

CfnGlobalTable

The AWS::DynamoDB::GlobalTable resource enables you to create and manage a Version 2019.11.21 global table. This resource cannot be used to create or manage a Version 2017.11.29 global table. For more information, see Global tables .

CfnGlobalTable.AttributeDefinitionProperty

Represents an attribute for describing the schema for the table and indexes.

CfnGlobalTable.CapacityAutoScalingSettingsProperty

Configures a scalable target and an autoscaling policy for a table or global secondary index's read or write capacity.

CfnGlobalTable.ContributorInsightsSpecificationProperty

Configures contributor insights settings for a replica or one of its indexes.

CfnGlobalTable.GlobalSecondaryIndexProperty

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

CfnGlobalTable.GlobalTableWitnessProperty

The witness Region for the MRSC global table.

CfnGlobalTable.KeySchemaProperty

Represents a single element of a key schema.

CfnGlobalTable.KinesisStreamSpecificationProperty

The Kinesis Data Streams configuration for the specified global table replica.

CfnGlobalTable.LocalSecondaryIndexProperty

Represents the properties of a local secondary index.

CfnGlobalTable.PointInTimeRecoverySpecificationProperty

Represents the settings used to enable point in time recovery.

CfnGlobalTable.ProjectionProperty

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

CfnGlobalTable.ReadOnDemandThroughputSettingsProperty

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

CfnGlobalTable.ReadProvisionedThroughputSettingsProperty

Allows you to specify the read capacity settings for a replica table or a replica global secondary index when the BillingMode is set to PROVISIONED .

CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty

Represents the properties of a global secondary index that can be set on a per-replica basis.

CfnGlobalTable.ReplicaSSESpecificationProperty

Allows you to specify a KMS key identifier to be used for server-side encryption.

CfnGlobalTable.ReplicaSpecificationProperty

Defines settings specific to a single replica of a global table.

CfnGlobalTable.ReplicaStreamSpecificationProperty

Represents the DynamoDB Streams configuration for a global table replica.

CfnGlobalTable.ResourcePolicyProperty

Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table, its indexes, and stream.

CfnGlobalTable.SSESpecificationProperty

Represents the settings used to enable server-side encryption.

CfnGlobalTable.StreamSpecificationProperty

Represents the DynamoDB Streams configuration for a table in DynamoDB .

CfnGlobalTable.TargetTrackingScalingPolicyConfigurationProperty

Defines a target tracking scaling policy.

CfnGlobalTable.TimeToLiveSpecificationProperty

Represents the settings used to enable or disable Time to Live (TTL) for the specified table.

CfnGlobalTable.WarmThroughputProperty

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.

CfnGlobalTable.WriteOnDemandThroughputSettingsProperty

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

CfnGlobalTable.WriteProvisionedThroughputSettingsProperty

Specifies an auto scaling policy for write capacity.

CfnGlobalTableProps

Properties for defining a CfnGlobalTable.

CfnTable

The AWS::DynamoDB::Table resource creates a DynamoDB table. For more information, see CreateTable in the Amazon DynamoDB API Reference .

CfnTable.AttributeDefinitionProperty

Represents an attribute for describing the schema for the table and indexes.

CfnTable.ContributorInsightsSpecificationProperty

Configures contributor insights settings for a table or one of its indexes.

CfnTable.CsvProperty

The options for imported source files in CSV format.

CfnTable.GlobalSecondaryIndexProperty

Represents the properties of a global secondary index.

CfnTable.ImportSourceSpecificationProperty

Specifies the properties of data being imported from the S3 bucket source to the table.

CfnTable.InputFormatOptionsProperty

The format options for the data that was imported into the target table.

CfnTable.KeySchemaProperty

Represents a single element of a key schema.

CfnTable.KinesisStreamSpecificationProperty

The Kinesis Data Streams configuration for the specified table.

CfnTable.LocalSecondaryIndexProperty

Represents the properties of a local secondary index.

CfnTable.OnDemandThroughputProperty

Sets the maximum number of read and write units for the specified on-demand table.

CfnTable.PointInTimeRecoverySpecificationProperty

The settings used to enable point in time recovery.

CfnTable.ProjectionProperty

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

CfnTable.ProvisionedThroughputProperty

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits .

CfnTable.ResourcePolicyProperty

Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table, its indexes, and stream.

CfnTable.S3BucketSourceProperty

The S3 bucket that is being imported from.

CfnTable.SSESpecificationProperty

Represents the settings used to enable server-side encryption.

CfnTable.StreamSpecificationProperty

Represents the DynamoDB Streams configuration for a table in DynamoDB.

CfnTable.TimeToLiveSpecificationProperty

Represents the settings used to enable or disable Time to Live (TTL) for the specified table.

CfnTable.WarmThroughputProperty

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.

CfnTableProps

Properties for defining a CfnTable.

ContributorInsightsSpecification

Reference to ContributorInsightsSpecification.

CsvOptions

The options for imported source files in CSV format.

EnableScalingProps

Properties for enabling DynamoDB capacity scaling.

GlobalSecondaryIndexProps

Properties for a global secondary index.

GlobalSecondaryIndexPropsV2

Properties used to configure a global secondary index.

ImportSourceSpecification

Properties for importing data from the S3.

InputFormat

The format of the source data.

LocalSecondaryIndexProps

Properties for a local secondary index.

MaxThroughputProps

Properties used to configure maximum throughput for an on-demand table.

OperationsMetricOptions

Options for configuring metrics that considers multiple operations.

PointInTimeRecoverySpecification

Reference to PointInTimeRecovey Specification for continuous backups.

ReplicaGlobalSecondaryIndexOptions

Options used to configure global secondary indexes on a replica table.

ReplicaTableProps

Properties used to configure a replica table.

SchemaOptions

Represents the table schema attributes.

SecondaryIndexProps

Properties for a secondary index.

SystemErrorsForOperationsMetricOptions

Options for configuring a system errors metric that considers multiple operations.

Table

Provides a DynamoDB table.

TableAttributes

Reference to a dynamodb table.

TableAttributesV2

Attributes of a DynamoDB table.

TableBase
TableBaseV2

Base class for a DynamoDB table.

TableEncryptionV2

Represents server-side encryption for a DynamoDB table.

TableOptions

Properties of a DynamoDB Table.

TableOptionsV2

Options used to configure a DynamoDB table.

TableProps

Properties for a DynamoDB Table.

TablePropsV2

Properties used to configure a DynamoDB table.

TableV2

A DynamoDB Table.

ThroughputProps

Properties used to configure provisioned throughput for a DynamoDB table.

UtilizationScalingProps

Properties for enabling DynamoDB utilization tracking.

WarmThroughput

Reference to WarmThroughput for a DynamoDB table.

Interfaces

CfnGlobalTable.IAttributeDefinitionProperty

Represents an attribute for describing the schema for the table and indexes.

CfnGlobalTable.ICapacityAutoScalingSettingsProperty

Configures a scalable target and an autoscaling policy for a table or global secondary index's read or write capacity.

CfnGlobalTable.IContributorInsightsSpecificationProperty

Configures contributor insights settings for a replica or one of its indexes.

CfnGlobalTable.IGlobalSecondaryIndexProperty

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

CfnGlobalTable.IGlobalTableWitnessProperty

The witness Region for the MRSC global table.

CfnGlobalTable.IKeySchemaProperty

Represents a single element of a key schema.

CfnGlobalTable.IKinesisStreamSpecificationProperty

The Kinesis Data Streams configuration for the specified global table replica.

CfnGlobalTable.ILocalSecondaryIndexProperty

Represents the properties of a local secondary index.

CfnGlobalTable.IPointInTimeRecoverySpecificationProperty

Represents the settings used to enable point in time recovery.

CfnGlobalTable.IProjectionProperty

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

CfnGlobalTable.IReadOnDemandThroughputSettingsProperty

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

CfnGlobalTable.IReadProvisionedThroughputSettingsProperty

Allows you to specify the read capacity settings for a replica table or a replica global secondary index when the BillingMode is set to PROVISIONED .

CfnGlobalTable.IReplicaGlobalSecondaryIndexSpecificationProperty

Represents the properties of a global secondary index that can be set on a per-replica basis.

CfnGlobalTable.IReplicaSSESpecificationProperty

Allows you to specify a KMS key identifier to be used for server-side encryption.

CfnGlobalTable.IReplicaSpecificationProperty

Defines settings specific to a single replica of a global table.

CfnGlobalTable.IReplicaStreamSpecificationProperty

Represents the DynamoDB Streams configuration for a global table replica.

CfnGlobalTable.IResourcePolicyProperty

Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table, its indexes, and stream.

CfnGlobalTable.ISSESpecificationProperty

Represents the settings used to enable server-side encryption.

CfnGlobalTable.IStreamSpecificationProperty

Represents the DynamoDB Streams configuration for a table in DynamoDB .

CfnGlobalTable.ITargetTrackingScalingPolicyConfigurationProperty

Defines a target tracking scaling policy.

CfnGlobalTable.ITimeToLiveSpecificationProperty

Represents the settings used to enable or disable Time to Live (TTL) for the specified table.

CfnGlobalTable.IWarmThroughputProperty

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.

CfnGlobalTable.IWriteOnDemandThroughputSettingsProperty

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

CfnGlobalTable.IWriteProvisionedThroughputSettingsProperty

Specifies an auto scaling policy for write capacity.

CfnTable.IAttributeDefinitionProperty

Represents an attribute for describing the schema for the table and indexes.

CfnTable.IContributorInsightsSpecificationProperty

Configures contributor insights settings for a table or one of its indexes.

CfnTable.ICsvProperty

The options for imported source files in CSV format.

CfnTable.IGlobalSecondaryIndexProperty

Represents the properties of a global secondary index.

CfnTable.IImportSourceSpecificationProperty

Specifies the properties of data being imported from the S3 bucket source to the table.

CfnTable.IInputFormatOptionsProperty

The format options for the data that was imported into the target table.

CfnTable.IKeySchemaProperty

Represents a single element of a key schema.

CfnTable.IKinesisStreamSpecificationProperty

The Kinesis Data Streams configuration for the specified table.

CfnTable.ILocalSecondaryIndexProperty

Represents the properties of a local secondary index.

CfnTable.IOnDemandThroughputProperty

Sets the maximum number of read and write units for the specified on-demand table.

CfnTable.IPointInTimeRecoverySpecificationProperty

The settings used to enable point in time recovery.

CfnTable.IProjectionProperty

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

CfnTable.IProvisionedThroughputProperty

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits .

CfnTable.IResourcePolicyProperty

Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table, its indexes, and stream.

CfnTable.IS3BucketSourceProperty

The S3 bucket that is being imported from.

CfnTable.ISSESpecificationProperty

Represents the settings used to enable server-side encryption.

CfnTable.IStreamSpecificationProperty

Represents the DynamoDB Streams configuration for a table in DynamoDB.

CfnTable.ITimeToLiveSpecificationProperty

Represents the settings used to enable or disable Time to Live (TTL) for the specified table.

CfnTable.IWarmThroughputProperty

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.

IAttribute

Represents an attribute for describing the key schema for the table and indexes.

IAutoscaledCapacityOptions

Options used to configure autoscaled capacity.

ICfnGlobalTableProps

Properties for defining a CfnGlobalTable.

ICfnTableProps

Properties for defining a CfnTable.

IContributorInsightsSpecification

Reference to ContributorInsightsSpecification.

ICsvOptions

The options for imported source files in CSV format.

IEnableScalingProps

Properties for enabling DynamoDB capacity scaling.

IGlobalSecondaryIndexProps

Properties for a global secondary index.

IGlobalSecondaryIndexPropsV2

Properties used to configure a global secondary index.

IImportSourceSpecification

Properties for importing data from the S3.

ILocalSecondaryIndexProps

Properties for a local secondary index.

IMaxThroughputProps

Properties used to configure maximum throughput for an on-demand table.

IOperationsMetricOptions

Options for configuring metrics that considers multiple operations.

IPointInTimeRecoverySpecification

Reference to PointInTimeRecovey Specification for continuous backups.

IReplicaGlobalSecondaryIndexOptions

Options used to configure global secondary indexes on a replica table.

IReplicaTableProps

Properties used to configure a replica table.

IScalableTableAttribute

Interface for scalable attributes.

ISchemaOptions

Represents the table schema attributes.

ISecondaryIndexProps

Properties for a secondary index.

ISystemErrorsForOperationsMetricOptions

Options for configuring a system errors metric that considers multiple operations.

ITable

An interface that represents a DynamoDB Table - either created with the CDK, or an existing one.

ITableAttributes

Reference to a dynamodb table.

ITableAttributesV2

Attributes of a DynamoDB table.

ITableOptions

Properties of a DynamoDB Table.

ITableOptionsV2

Options used to configure a DynamoDB table.

ITableProps

Properties for a DynamoDB Table.

ITablePropsV2

Properties used to configure a DynamoDB table.

ITableV2

Represents an instance of a DynamoDB table.

IThroughputProps

Properties used to configure provisioned throughput for a DynamoDB table.

IUtilizationScalingProps

Properties for enabling DynamoDB utilization tracking.

IWarmThroughput

Reference to WarmThroughput for a DynamoDB table.

Enums

ApproximateCreationDateTimePrecision

The precision associated with the DynamoDB write timestamps that will be replicated to Kinesis.

AttributeType

Data types for attributes within a table.

BillingMode

DynamoDB's Read/Write capacity modes.

CapacityMode

Capacity modes.

ContributorInsightsMode

DynamoDB's Contributor Insights Mode.

InputCompressionType

Type of compression to use for imported data.

MultiRegionConsistency

Global table multi-region consistency mode.

Operation

Supported DynamoDB table operations.

ProjectionType

The set of attributes that are projected into the index.

StreamViewType

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

TableClass

DynamoDB's table class.

TableEncryption

What kind of server-side encryption to apply to this table.

Back to top Generated by DocFX