GradientEdge CDK Utils
    Preparing search index...

    Interface TablePropsV2

    interface TablePropsV2 {
        billing?: Billing;
        contributorInsights?: boolean;
        contributorInsightsSpecification?: ContributorInsightsSpecification;
        deletionProtection?: boolean;
        dynamoStream?: StreamViewType;
        encryption?: TableEncryptionV2;
        globalSecondaryIndexes?: GlobalSecondaryIndexPropsV2[];
        globalTableSettingsReplicationMode?: GlobalTableSettingsReplicationMode;
        kinesisStream?: IStream;
        localSecondaryIndexes?: LocalSecondaryIndexProps[];
        multiRegionConsistency?: MultiRegionConsistency;
        partitionKey: Attribute;
        pointInTimeRecovery?: boolean;
        pointInTimeRecoverySpecification?: PointInTimeRecoverySpecification;
        removalPolicy?: RemovalPolicy;
        replicas?: ReplicaTableProps[];
        resourcePolicy?: PolicyDocument;
        sortKey?: Attribute;
        tableClass?: TableClass;
        tableName?: string;
        tags?: TagProps[];
        timeToLiveAttribute?: string;
        warmThroughput?: WarmThroughput;
        witnessRegion?: string;
    }

    Hierarchy

    • TablePropsV2
      • TablePropsV2
    Index

    Properties

    billing? contributorInsights? contributorInsightsSpecification? deletionProtection? dynamoStream? encryption? globalSecondaryIndexes? globalTableSettingsReplicationMode? kinesisStream? localSecondaryIndexes? multiRegionConsistency? partitionKey pointInTimeRecovery? pointInTimeRecoverySpecification? removalPolicy? replicas? resourcePolicy? sortKey? tableClass? tableName? tags? timeToLiveAttribute? warmThroughput? witnessRegion?

    Properties

    billing?: Billing

    The billing mode and capacity settings to apply to the table.

    Billing.onDemand()
    contributorInsights?: boolean

    Whether CloudWatch contributor insights is enabled.

    use contributorInsightsSpecification instead

    false
    contributorInsightsSpecification?: ContributorInsightsSpecification

    Whether CloudWatch contributor insights is enabled and what mode is selected

    - contributor insights is not enabled
    deletionProtection?: boolean

    Whether deletion protection is enabled.

    false
    dynamoStream?: StreamViewType

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

    - streams are disabled if replicas are not configured and this property is
    not specified. If this property is not specified when replicas are configured, then
    NEW_AND_OLD_IMAGES will be the StreamViewType for all replicas
    encryption?: TableEncryptionV2

    The server-side encryption.

    TableEncryptionV2.dynamoOwnedKey()
    globalSecondaryIndexes?: GlobalSecondaryIndexPropsV2[]

    Global secondary indexes.

    Note: You can provide a maximum of 20 global secondary indexes.

    - no global secondary indexes
    globalTableSettingsReplicationMode?: GlobalTableSettingsReplicationMode

    Controls whether table settings are synchronized across replicas.

    When set to ALL, synchronizable settings (billing mode, throughput, TTL, streams view type, GSIs) are automatically replicated across all replicas. When set to NONE, each replica manages its own settings independently (billing mode must be PAY_PER_REQUEST).

    Note: Some settings are always synchronized (key schema, LSIs) regardless of this setting, and some are never synchronized (table class, SSE, deletion protection, PITR, tags, resource policy).

    GlobalTableSettingsReplicationMode.NONE
    kinesisStream?: IStream

    Kinesis Data Stream to capture item level changes.

    - no Kinesis Data Stream
    localSecondaryIndexes?: LocalSecondaryIndexProps[]

    Local secondary indexes.

    Note: You can only provide a maximum of 5 local secondary indexes.

    - no local secondary indexes
    multiRegionConsistency?: MultiRegionConsistency

    Specifies the consistency mode for a new global table.

    MultiRegionConsistency.EVENTUAL
    partitionKey: Attribute

    Partition key attribute definition.

    pointInTimeRecovery?: boolean

    Whether point-in-time recovery is enabled.

    use pointInTimeRecoverySpecification instead

    false - point in time recovery is not enabled.
    pointInTimeRecoverySpecification?: PointInTimeRecoverySpecification

    Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.

    - point in time recovery is not enabled.
    removalPolicy?: RemovalPolicy

    The removal policy applied to the table.

    RemovalPolicy.RETAIN
    replicas?: ReplicaTableProps[]

    Replica tables to deploy with the primary table.

    Note: Adding replica tables allows you to use your table as a global table. You cannot specify a replica table in the region that the primary table will be deployed to. Replica tables will only be supported if the stack deployment region is defined.

    - no replica tables
    resourcePolicy?: PolicyDocument

    Resource policy to assign to DynamoDB Table.

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-resourcepolicy

    - No resource policy statements are added to the created table.
    sortKey?: Attribute

    Sort key attribute definition.

    - no sort key
    tableClass?: TableClass

    The table class.

    TableClass.STANDARD
    tableName?: string

    The name of the table.

    - generated by CloudFormation
    tags?: TagProps[]

    Tags to be applied to the primary table (default replica table).

    - no tags
    timeToLiveAttribute?: string

    The name of the TTL attribute.

    - TTL is disabled
    warmThroughput?: WarmThroughput

    The warm throughput configuration for the table.

    - no warm throughput is configured
    witnessRegion?: string

    The witness Region for the MRSC global table. A MRSC global table can be configured with either three replicas, or with two replicas and one witness.

    Note: Witness region cannot be specified for a Multi-Region Eventual Consistency (MREC) Global Table. Witness regions are only supported for Multi-Region Strong Consistency (MRSC) Global Tables.

    - no witness region

    Settings

    Member Visibility

    On This Page

    Properties