CfnTablePropsMixin

class aws_cdk.mixins_preview.aws_cassandra.mixins.CfnTablePropsMixin(props, *, strategy=None)

Bases: Mixin

You can use the AWS::Cassandra::Table resource to create a new table in Amazon Keyspaces (for Apache Cassandra).

For more information, see Create a table in the Amazon Keyspaces Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html
CloudformationResource:: AWS::Cassandra::Table
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

cfn_table_props_mixin = cassandra_mixins.CfnTablePropsMixin(cassandra_mixins.CfnTableMixinProps(
    auto_scaling_specifications=cassandra_mixins.CfnTablePropsMixin.AutoScalingSpecificationProperty(
        read_capacity_auto_scaling=cassandra_mixins.CfnTablePropsMixin.AutoScalingSettingProperty(
            auto_scaling_disabled=False,
            maximum_units=123,
            minimum_units=123,
            scaling_policy=cassandra_mixins.CfnTablePropsMixin.ScalingPolicyProperty(
                target_tracking_scaling_policy_configuration=cassandra_mixins.CfnTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty(
                    disable_scale_in=False,
                    scale_in_cooldown=123,
                    scale_out_cooldown=123,
                    target_value=123
                )
            )
        ),
        write_capacity_auto_scaling=cassandra_mixins.CfnTablePropsMixin.AutoScalingSettingProperty(
            auto_scaling_disabled=False,
            maximum_units=123,
            minimum_units=123,
            scaling_policy=cassandra_mixins.CfnTablePropsMixin.ScalingPolicyProperty(
                target_tracking_scaling_policy_configuration=cassandra_mixins.CfnTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty(
                    disable_scale_in=False,
                    scale_in_cooldown=123,
                    scale_out_cooldown=123,
                    target_value=123
                )
            )
        )
    ),
    billing_mode=cassandra_mixins.CfnTablePropsMixin.BillingModeProperty(
        mode="mode",
        provisioned_throughput=cassandra_mixins.CfnTablePropsMixin.ProvisionedThroughputProperty(
            read_capacity_units=123,
            write_capacity_units=123
        )
    ),
    cdc_specification=cassandra_mixins.CfnTablePropsMixin.CdcSpecificationProperty(
        status="status",
        tags=[CfnTag(
            key="key",
            value="value"
        )],
        view_type="viewType"
    ),
    client_side_timestamps_enabled=False,
    clustering_key_columns=[cassandra_mixins.CfnTablePropsMixin.ClusteringKeyColumnProperty(
        column=cassandra_mixins.CfnTablePropsMixin.ColumnProperty(
            column_name="columnName",
            column_type="columnType"
        ),
        order_by="orderBy"
    )],
    default_time_to_live=123,
    encryption_specification=cassandra_mixins.CfnTablePropsMixin.EncryptionSpecificationProperty(
        encryption_type="encryptionType",
        kms_key_identifier="kmsKeyIdentifier"
    ),
    keyspace_name="keyspaceName",
    partition_key_columns=[cassandra_mixins.CfnTablePropsMixin.ColumnProperty(
        column_name="columnName",
        column_type="columnType"
    )],
    point_in_time_recovery_enabled=False,
    regular_columns=[cassandra_mixins.CfnTablePropsMixin.ColumnProperty(
        column_name="columnName",
        column_type="columnType"
    )],
    replica_specifications=[cassandra_mixins.CfnTablePropsMixin.ReplicaSpecificationProperty(
        read_capacity_auto_scaling=cassandra_mixins.CfnTablePropsMixin.AutoScalingSettingProperty(
            auto_scaling_disabled=False,
            maximum_units=123,
            minimum_units=123,
            scaling_policy=cassandra_mixins.CfnTablePropsMixin.ScalingPolicyProperty(
                target_tracking_scaling_policy_configuration=cassandra_mixins.CfnTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty(
                    disable_scale_in=False,
                    scale_in_cooldown=123,
                    scale_out_cooldown=123,
                    target_value=123
                )
            )
        ),
        read_capacity_units=123,
        region="region"
    )],
    table_name="tableName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    warm_throughput=cassandra_mixins.CfnTablePropsMixin.WarmThroughputProperty(
        read_units_per_second=123,
        write_units_per_second=123
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Cassandra::Table.

Parameters:

props (Union[CfnTableMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['autoScalingSpecifications', 'billingMode', 'cdcSpecification', 'clientSideTimestampsEnabled', 'clusteringKeyColumns', 'defaultTimeToLive', 'encryptionSpecification', 'keyspaceName', 'partitionKeyColumns', 'pointInTimeRecoveryEnabled', 'regularColumns', 'replicaSpecifications', 'tableName', 'tags', 'warmThroughput']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AutoScalingSettingProperty

class CfnTablePropsMixin.AutoScalingSettingProperty(*, auto_scaling_disabled=None, maximum_units=None, minimum_units=None, scaling_policy=None)

Bases: object

The optional auto scaling settings for a table with provisioned throughput capacity.

To turn on auto scaling for a table in throughputMode:PROVISIONED , you must specify the following parameters.

Configure the minimum and maximum capacity units. The auto scaling policy ensures that capacity never goes below the minimum or above the maximum range.

minimumUnits : The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
maximumUnits : The maximum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
scalingPolicy : Amazon Keyspaces supports the target tracking scaling policy. The auto scaling target is a percentage of the provisioned capacity of the table.

For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide .

Parameters:

auto_scaling_disabled (Union[bool, IResolvable, None]) – This optional parameter enables auto scaling for the table if set to false . Default: - false
maximum_units (Union[int, float, None]) – Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
minimum_units (Union[int, float, None]) – The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
scaling_policy (Union[IResolvable, ScalingPolicyProperty, Dict[str, Any], None]) – Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table’s ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

auto_scaling_setting_property = cassandra_mixins.CfnTablePropsMixin.AutoScalingSettingProperty(
    auto_scaling_disabled=False,
    maximum_units=123,
    minimum_units=123,
    scaling_policy=cassandra_mixins.CfnTablePropsMixin.ScalingPolicyProperty(
        target_tracking_scaling_policy_configuration=cassandra_mixins.CfnTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty(
            disable_scale_in=False,
            scale_in_cooldown=123,
            scale_out_cooldown=123,
            target_value=123
        )
    )
)

Attributes

auto_scaling_disabled

This optional parameter enables auto scaling for the table if set to false .

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-autoscalingdisabled

maximum_units

Manage costs by specifying the maximum amount of throughput to provision.

The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-maximumunits

minimum_units

The minimum level of throughput the table should always be ready to support.

The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-minimumunits

scaling_policy

Amazon Keyspaces supports the target tracking auto scaling policy.

With this policy, Amazon Keyspaces auto scaling ensures that the table’s ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-scalingpolicy

AutoScalingSpecificationProperty

class CfnTablePropsMixin.AutoScalingSpecificationProperty(*, read_capacity_auto_scaling=None, write_capacity_auto_scaling=None)

Bases: object

The optional auto scaling capacity settings for a table in provisioned capacity mode.

Parameters:

read_capacity_auto_scaling (Union[IResolvable, AutoScalingSettingProperty, Dict[str, Any], None]) – The auto scaling settings for the table’s read capacity.
write_capacity_auto_scaling (Union[IResolvable, AutoScalingSettingProperty, Dict[str, Any], None]) – The auto scaling settings for the table’s write capacity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingspecification.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

auto_scaling_specification_property = cassandra_mixins.CfnTablePropsMixin.AutoScalingSpecificationProperty(
    read_capacity_auto_scaling=cassandra_mixins.CfnTablePropsMixin.AutoScalingSettingProperty(
        auto_scaling_disabled=False,
        maximum_units=123,
        minimum_units=123,
        scaling_policy=cassandra_mixins.CfnTablePropsMixin.ScalingPolicyProperty(
            target_tracking_scaling_policy_configuration=cassandra_mixins.CfnTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty(
                disable_scale_in=False,
                scale_in_cooldown=123,
                scale_out_cooldown=123,
                target_value=123
            )
        )
    ),
    write_capacity_auto_scaling=cassandra_mixins.CfnTablePropsMixin.AutoScalingSettingProperty(
        auto_scaling_disabled=False,
        maximum_units=123,
        minimum_units=123,
        scaling_policy=cassandra_mixins.CfnTablePropsMixin.ScalingPolicyProperty(
            target_tracking_scaling_policy_configuration=cassandra_mixins.CfnTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty(
                disable_scale_in=False,
                scale_in_cooldown=123,
                scale_out_cooldown=123,
                target_value=123
            )
        )
    )
)

Attributes

read_capacity_auto_scaling

The auto scaling settings for the table’s read capacity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingspecification.html#cfn-cassandra-table-autoscalingspecification-readcapacityautoscaling

write_capacity_auto_scaling

The auto scaling settings for the table’s write capacity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingspecification.html#cfn-cassandra-table-autoscalingspecification-writecapacityautoscaling

BillingModeProperty

class CfnTablePropsMixin.BillingModeProperty(*, mode=None, provisioned_throughput=None)

Bases: object

Determines the billing mode for the table - on-demand or provisioned.

Parameters:

mode (Optional[str]) – The billing mode for the table:. - On-demand mode - ON_DEMAND - Provisioned mode - PROVISIONED .. epigraph:: If you choose PROVISIONED mode, then you also need to specify provisioned throughput (read and write capacity) for the table. Valid values: ON_DEMAND | PROVISIONED Default: - “ON_DEMAND”
provisioned_throughput (Union[IResolvable, ProvisionedThroughputProperty, Dict[str, Any], None]) – The provisioned read capacity and write capacity for the table. For more information, see Provisioned throughput capacity mode in the Amazon Keyspaces Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-billingmode.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

billing_mode_property = cassandra_mixins.CfnTablePropsMixin.BillingModeProperty(
    mode="mode",
    provisioned_throughput=cassandra_mixins.CfnTablePropsMixin.ProvisionedThroughputProperty(
        read_capacity_units=123,
        write_capacity_units=123
    )
)

Attributes

mode

.

On-demand mode - ON_DEMAND
Provisioned mode - PROVISIONED

If you choose PROVISIONED mode, then you also need to specify provisioned throughput (read and write capacity) for the table.

Valid values: ON_DEMAND | PROVISIONED

Default:

“ON_DEMAND”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-billingmode.html#cfn-cassandra-table-billingmode-mode

Type:

The billing mode for the table

provisioned_throughput

The provisioned read capacity and write capacity for the table.

For more information, see Provisioned throughput capacity mode in the Amazon Keyspaces Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-billingmode.html#cfn-cassandra-table-billingmode-provisionedthroughput

CdcSpecificationProperty

class CfnTablePropsMixin.CdcSpecificationProperty(*, status=None, tags=None, view_type=None)

Bases: object

The settings for the CDC stream of a table.

For more information about CDC streams, see Working with change data capture (CDC) streams in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

Parameters:

status (Optional[str]) – The status of the CDC stream. You can enable or disable a stream for a table.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags (key-value pairs) that you want to apply to the stream.
view_type (Optional[str]) – The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can’t make changes to this selection. The options are: - NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default. - NEW_IMAGE - the version of the row after the change. - OLD_IMAGE - the version of the row before the change. - KEYS_ONLY - the partition and clustering keys of the row that was changed. Default: - “NEW_AND_OLD_IMAGES”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-cdcspecification.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

cdc_specification_property = cassandra_mixins.CfnTablePropsMixin.CdcSpecificationProperty(
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    view_type="viewType"
)

Attributes

status

The status of the CDC stream.

You can enable or disable a stream for a table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-cdcspecification.html#cfn-cassandra-table-cdcspecification-status

tags

The tags (key-value pairs) that you want to apply to the stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-cdcspecification.html#cfn-cassandra-table-cdcspecification-tags

view_type

The view type specifies the changes Amazon Keyspaces records for each changed row in the stream.

After you create the stream, you can’t make changes to this selection.

The options are:

NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.
NEW_IMAGE - the version of the row after the change.
OLD_IMAGE - the version of the row before the change.
KEYS_ONLY - the partition and clustering keys of the row that was changed.

Default:

“NEW_AND_OLD_IMAGES”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-cdcspecification.html#cfn-cassandra-table-cdcspecification-viewtype

ClusteringKeyColumnProperty

class CfnTablePropsMixin.ClusteringKeyColumnProperty(*, column=None, order_by=None)

Bases: object

Defines an individual column within the clustering key.

Parameters:

column (Union[IResolvable, ColumnProperty, Dict[str, Any], None]) – The name and data type of this clustering key column.
order_by (Optional[str]) – The order in which this column’s data is stored:. - ASC (default) - The column’s data is stored in ascending order. - DESC - The column’s data is stored in descending order. Default: - “ASC”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-clusteringkeycolumn.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

clustering_key_column_property = cassandra_mixins.CfnTablePropsMixin.ClusteringKeyColumnProperty(
    column=cassandra_mixins.CfnTablePropsMixin.ColumnProperty(
        column_name="columnName",
        column_type="columnType"
    ),
    order_by="orderBy"
)

Attributes

column

The name and data type of this clustering key column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-clusteringkeycolumn.html#cfn-cassandra-table-clusteringkeycolumn-column

order_by

.

ASC (default) - The column’s data is stored in ascending order.
DESC - The column’s data is stored in descending order.

Default:

“ASC”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-clusteringkeycolumn.html#cfn-cassandra-table-clusteringkeycolumn-orderby

Type:

The order in which this column’s data is stored

ColumnProperty

class CfnTablePropsMixin.ColumnProperty(*, column_name=None, column_type=None)

Bases: object

The name and data type of an individual column in a table.

In addition to the data type, you can also use the following two keywords:

STATIC if the table has a clustering column. Static columns store values that are shared by all rows in the same partition.
FROZEN for collection data types. In frozen collections the values of the collection are serialized into a single immutable value, and Amazon Keyspaces treats them like a BLOB .

Parameters:

column_name (Optional[str]) – The name of the column. For more information, see Identifiers in the Amazon Keyspaces Developer Guide .
column_type (Optional[str]) – The data type of the column. For more information, see Data types in the Amazon Keyspaces Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-column.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

column_property = cassandra_mixins.CfnTablePropsMixin.ColumnProperty(
    column_name="columnName",
    column_type="columnType"
)

Attributes

column_name

The name of the column.

For more information, see Identifiers in the Amazon Keyspaces Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-column.html#cfn-cassandra-table-column-columnname

column_type

The data type of the column.

For more information, see Data types in the Amazon Keyspaces Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-column.html#cfn-cassandra-table-column-columntype

EncryptionSpecificationProperty

class CfnTablePropsMixin.EncryptionSpecificationProperty(*, encryption_type=None, kms_key_identifier=None)

Bases: object

Specifies the encryption at rest option selected for the table.

Parameters:

encryption_type (Optional[str]) – The encryption at rest options for the table. - AWS owned key (default) - AWS_OWNED_KMS_KEY - Customer managed key - CUSTOMER_MANAGED_KMS_KEY .. epigraph:: If you choose CUSTOMER_MANAGED_KMS_KEY , a kms_key_identifier in the format of a key ARN is required. Valid values: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY . Default: - “AWS_OWNED_KMS_KEY”
kms_key_identifier (Optional[str]) – Requires a kms_key_identifier in the format of a key ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-encryptionspecification.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

encryption_specification_property = cassandra_mixins.CfnTablePropsMixin.EncryptionSpecificationProperty(
    encryption_type="encryptionType",
    kms_key_identifier="kmsKeyIdentifier"
)

Attributes

encryption_type

The encryption at rest options for the table.

AWS owned key (default) - AWS_OWNED_KMS_KEY
Customer managed key - CUSTOMER_MANAGED_KMS_KEY

If you choose CUSTOMER_MANAGED_KMS_KEY , a kms_key_identifier in the format of a key ARN is required.

Valid values: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY .

Default:

“AWS_OWNED_KMS_KEY”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-encryptionspecification.html#cfn-cassandra-table-encryptionspecification-encryptiontype

kms_key_identifier

Requires a kms_key_identifier in the format of a key ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-encryptionspecification.html#cfn-cassandra-table-encryptionspecification-kmskeyidentifier

ProvisionedThroughputProperty

class CfnTablePropsMixin.ProvisionedThroughputProperty(*, read_capacity_units=None, write_capacity_units=None)

Bases: object

The provisioned throughput for the table, which consists of ReadCapacityUnits and WriteCapacityUnits .

Parameters:

read_capacity_units (Union[int, float, None]) – The amount of read capacity that’s provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
write_capacity_units (Union[int, float, None]) –
The amount of write capacity that’s provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-provisionedthroughput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

provisioned_throughput_property = cassandra_mixins.CfnTablePropsMixin.ProvisionedThroughputProperty(
    read_capacity_units=123,
    write_capacity_units=123
)

Attributes

read_capacity_units

The amount of read capacity that’s provisioned for the table.

For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-provisionedthroughput.html#cfn-cassandra-table-provisionedthroughput-readcapacityunits

write_capacity_units

The amount of write capacity that’s provisioned for the table.

For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-provisionedthroughput.html#cfn-cassandra-table-provisionedthroughput-writecapacityunits

ReplicaSpecificationProperty

class CfnTablePropsMixin.ReplicaSpecificationProperty(*, read_capacity_auto_scaling=None, read_capacity_units=None, region=None)

Bases: object

The AWS Region specific settings of a multi-Region table.

For a multi-Region table, you can configure the table’s read capacity differently per AWS Region. You can do this by configuring the following parameters.

region : The Region where these settings are applied. (Required)
readCapacityUnits : The provisioned read capacity units. (Optional)
readCapacityAutoScaling : The read capacity auto scaling settings for the table. (Optional)

Parameters:

read_capacity_auto_scaling (Union[IResolvable, AutoScalingSettingProperty, Dict[str, Any], None]) – The read capacity auto scaling settings for the multi-Region table in the specified AWS Region.
read_capacity_units (Union[int, float, None]) – The provisioned read capacity units for the multi-Region table in the specified AWS Region.
region (Optional[str]) – The AWS Region.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-replicaspecification.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

replica_specification_property = cassandra_mixins.CfnTablePropsMixin.ReplicaSpecificationProperty(
    read_capacity_auto_scaling=cassandra_mixins.CfnTablePropsMixin.AutoScalingSettingProperty(
        auto_scaling_disabled=False,
        maximum_units=123,
        minimum_units=123,
        scaling_policy=cassandra_mixins.CfnTablePropsMixin.ScalingPolicyProperty(
            target_tracking_scaling_policy_configuration=cassandra_mixins.CfnTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty(
                disable_scale_in=False,
                scale_in_cooldown=123,
                scale_out_cooldown=123,
                target_value=123
            )
        )
    ),
    read_capacity_units=123,
    region="region"
)

Attributes

read_capacity_auto_scaling

The read capacity auto scaling settings for the multi-Region table in the specified AWS Region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-replicaspecification.html#cfn-cassandra-table-replicaspecification-readcapacityautoscaling

read_capacity_units

The provisioned read capacity units for the multi-Region table in the specified AWS Region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-replicaspecification.html#cfn-cassandra-table-replicaspecification-readcapacityunits

region

The AWS Region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-replicaspecification.html#cfn-cassandra-table-replicaspecification-region

ScalingPolicyProperty

class CfnTablePropsMixin.ScalingPolicyProperty(*, target_tracking_scaling_policy_configuration=None)

Bases: object

Amazon Keyspaces supports the target tracking auto scaling policy.

With this policy, Amazon Keyspaces auto scaling ensures that the table’s ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

Parameters:: target_tracking_scaling_policy_configuration (Union[IResolvable, TargetTrackingScalingPolicyConfigurationProperty, Dict[str, Any], None]) – The auto scaling policy that scales a table based on the ratio of consumed to provisioned capacity.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-scalingpolicy.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

scaling_policy_property = cassandra_mixins.CfnTablePropsMixin.ScalingPolicyProperty(
    target_tracking_scaling_policy_configuration=cassandra_mixins.CfnTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty(
        disable_scale_in=False,
        scale_in_cooldown=123,
        scale_out_cooldown=123,
        target_value=123
    )
)

Attributes

target_tracking_scaling_policy_configuration

The auto scaling policy that scales a table based on the ratio of consumed to provisioned capacity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-scalingpolicy.html#cfn-cassandra-table-scalingpolicy-targettrackingscalingpolicyconfiguration

TargetTrackingScalingPolicyConfigurationProperty

class CfnTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty(*, disable_scale_in=None, scale_in_cooldown=None, scale_out_cooldown=None, target_value=None)

Bases: object

Amazon Keyspaces supports the target tracking auto scaling policy for a provisioned table.

This policy scales a table based on the ratio of consumed to provisioned capacity. The auto scaling target is a percentage of the provisioned capacity of the table.

targetTrackingScalingPolicyConfiguration : To define the target tracking policy, you must define the target value.
targetValue : The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90. (Required)
disableScaleIn : A boolean that specifies if scale-in is disabled or enabled for the table. This parameter is disabled by default. To turn on scale-in , set the boolean value to FALSE . This means that capacity for a table can be automatically scaled down on your behalf. (Optional)
scaleInCooldown : A cooldown period in seconds between scaling activities that lets the table stabilize before another scale in activity starts. If no value is provided, the default is 0. (Optional)
scaleOutCooldown : A cooldown period in seconds between scaling activities that lets the table stabilize before another scale out activity starts. If no value is provided, the default is 0. (Optional)

Parameters:

disable_scale_in (Union[bool, IResolvable, None]) – Specifies if scale-in is enabled. When auto scaling automatically decreases capacity for a table, the table scales in . When scaling policies are set, they can’t scale in the table lower than its minimum capacity.
scale_in_cooldown (Union[int, float, None]) – Specifies a scale-in cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. Default: - 0
scale_out_cooldown (Union[int, float, None]) – Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. Default: - 0
target_value (Union[int, float, None]) – Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. An integer between 20 and 90.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-targettrackingscalingpolicyconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

target_tracking_scaling_policy_configuration_property = cassandra_mixins.CfnTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty(
    disable_scale_in=False,
    scale_in_cooldown=123,
    scale_out_cooldown=123,
    target_value=123
)

Attributes

disable_scale_in

Specifies if scale-in is enabled.

When auto scaling automatically decreases capacity for a table, the table scales in . When scaling policies are set, they can’t scale in the table lower than its minimum capacity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-targettrackingscalingpolicyconfiguration.html#cfn-cassandra-table-targettrackingscalingpolicyconfiguration-disablescalein

scale_in_cooldown

Specifies a scale-in cool down period.

A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

Default:

0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-targettrackingscalingpolicyconfiguration.html#cfn-cassandra-table-targettrackingscalingpolicyconfiguration-scaleincooldown

scale_out_cooldown

Specifies a scale out cool down period.

A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

Default:

0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-targettrackingscalingpolicyconfiguration.html#cfn-cassandra-table-targettrackingscalingpolicyconfiguration-scaleoutcooldown

target_value

Specifies the target value for the target tracking auto scaling policy.

Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. An integer between 20 and 90.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-targettrackingscalingpolicyconfiguration.html#cfn-cassandra-table-targettrackingscalingpolicyconfiguration-targetvalue

WarmThroughputProperty

class CfnTablePropsMixin.WarmThroughputProperty(*, read_units_per_second=None, write_units_per_second=None)

Bases: object

Warm throughput configuration for the table.

Parameters:

read_units_per_second (Union[int, float, None])
write_units_per_second (Union[int, float, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-warmthroughput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins

warm_throughput_property = cassandra_mixins.CfnTablePropsMixin.WarmThroughputProperty(
    read_units_per_second=123,
    write_units_per_second=123
)

Attributes

read_units_per_second

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-warmthroughput.html#cfn-cassandra-table-warmthroughput-readunitspersecond

Type:: see

write_units_per_second

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-warmthroughput.html#cfn-cassandra-table-warmthroughput-writeunitspersecond

Type:: see