CfnTable (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.cassandra.CfnTable

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.949Z")
 @Stability(value=Stable)
public class CfnTable
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cassandra::Table`.

The AWS::Cassandra::Table resource allows you to create a new table in Amazon Keyspaces (for Apache Cassandra). For more information, see Create a keyspace and a table in the Amazon Keyspaces Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cassandra.*;
 CfnTable cfnTable = CfnTable.Builder.create(this, "MyCfnTable")
         .keyspaceName("keyspaceName")
         .partitionKeyColumns(List.of(ColumnProperty.builder()
                 .columnName("columnName")
                 .columnType("columnType")
                 .build()))
         // the properties below are optional
         .billingMode(BillingModeProperty.builder()
                 .mode("mode")
                 // the properties below are optional
                 .provisionedThroughput(ProvisionedThroughputProperty.builder()
                         .readCapacityUnits(123)
                         .writeCapacityUnits(123)
                         .build())
                 .build())
         .clusteringKeyColumns(List.of(ClusteringKeyColumnProperty.builder()
                 .column(ColumnProperty.builder()
                         .columnName("columnName")
                         .columnType("columnType")
                         .build())
                 // the properties below are optional
                 .orderBy("orderBy")
                 .build()))
         .defaultTimeToLive(123)
         .encryptionSpecification(EncryptionSpecificationProperty.builder()
                 .encryptionType("encryptionType")
                 // the properties below are optional
                 .kmsKeyIdentifier("kmsKeyIdentifier")
                 .build())
         .pointInTimeRecoveryEnabled(false)
         .regularColumns(List.of(ColumnProperty.builder()
                 .columnName("columnName")
                 .columnType("columnType")
                 .build()))
         .tableName("tableName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnTable.BillingModeProperty` Determines the billing mode for the table - On-demand or provisioned.
`static class`	`CfnTable.Builder` A fluent builder for `CfnTable`.
`static interface`	`CfnTable.ClusteringKeyColumnProperty` Defines an individual column within the clustering key.
`static interface`	`CfnTable.ColumnProperty` The name and data type of an individual column in a table.
`static interface`	`CfnTable.EncryptionSpecificationProperty` Specifies the encryption at rest option selected for the table.
`static interface`	`CfnTable.ProvisionedThroughputProperty` The provisioned throughput for the table, which consists of `ReadCapacityUnits` and `WriteCapacityUnits` .

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnTable(software.constructs.Construct scope, String id, CfnTableProps props)` Create a new `AWS::Cassandra::Table`.
`protected`	`CfnTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnTable(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getBillingMode()` The billing mode for the table, which determines how you'll be charged for reads and writes:.
`protected Map<String,Object>`	`getCfnProperties()`
`Object`	`getClusteringKeyColumns()` One or more columns that determine how the table data is sorted.
`Number`	`getDefaultTimeToLive()` The default Time To Live (TTL) value for all rows in a table in seconds.
`Object`	`getEncryptionSpecification()` The encryption at rest options for the table.
`String`	`getKeyspaceName()` The name of the keyspace in which to create the table.
`Object`	`getPartitionKeyColumns()` One or more columns that uniquely identify every row in the table.
`Object`	`getPointInTimeRecoveryEnabled()` Specifies if point-in-time recovery is enabled or disabled for the table.
`Object`	`getRegularColumns()` One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.
`String`	`getTableName()` The name of the table to be created.
`TagManager`	`getTags()` A list of key-value pair tags to be attached to the resource.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setBillingMode(CfnTable.BillingModeProperty value)` The billing mode for the table, which determines how you'll be charged for reads and writes:.
`void`	`setBillingMode(IResolvable value)` The billing mode for the table, which determines how you'll be charged for reads and writes:.
`void`	`setClusteringKeyColumns(IResolvable value)` One or more columns that determine how the table data is sorted.
`void`	`setClusteringKeyColumns(List<Object> value)` One or more columns that determine how the table data is sorted.
`void`	`setDefaultTimeToLive(Number value)` The default Time To Live (TTL) value for all rows in a table in seconds.
`void`	`setEncryptionSpecification(CfnTable.EncryptionSpecificationProperty value)` The encryption at rest options for the table.
`void`	`setEncryptionSpecification(IResolvable value)` The encryption at rest options for the table.
`void`	`setKeyspaceName(String value)` The name of the keyspace in which to create the table.
`void`	`setPartitionKeyColumns(IResolvable value)` One or more columns that uniquely identify every row in the table.
`void`	`setPartitionKeyColumns(List<Object> value)` One or more columns that uniquely identify every row in the table.
`void`	`setPointInTimeRecoveryEnabled(Boolean value)` Specifies if point-in-time recovery is enabled or disabled for the table.
`void`	`setPointInTimeRecoveryEnabled(IResolvable value)` Specifies if point-in-time recovery is enabled or disabled for the table.
`void`	`setRegularColumns(IResolvable value)` One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.
`void`	`setRegularColumns(List<Object> value)` One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.
`void`	`setTableName(String value)` The name of the table to be created.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnTable
```
protected CfnTable(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnTable
```
protected CfnTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnTable
```
@Stability(value=Stable)
public CfnTable(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnTableProps props)
```
    Create a new `AWS::Cassandra::Table`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    A list of key-value pair tags to be attached to the resource.
  - getKeyspaceName
```
@Stability(value=Stable)
 @NotNull
public String getKeyspaceName()
```
    The name of the keyspace in which to create the table.
    The keyspace must already exist.
  - setKeyspaceName
```
@Stability(value=Stable)
public void setKeyspaceName(@NotNull
                                                     String value)
```
    The name of the keyspace in which to create the table.
    The keyspace must already exist.
  - getPartitionKeyColumns
```
@Stability(value=Stable)
 @NotNull
public Object getPartitionKeyColumns()
```
    One or more columns that uniquely identify every row in the table.
    Every table must have a partition key.
  - setPartitionKeyColumns
```
@Stability(value=Stable)
public void setPartitionKeyColumns(@NotNull
                                                            IResolvable value)
```
    One or more columns that uniquely identify every row in the table.
    Every table must have a partition key.
  - setPartitionKeyColumns
```
@Stability(value=Stable)
public void setPartitionKeyColumns(@NotNull
                                                            List<Object> value)
```
    One or more columns that uniquely identify every row in the table.
    Every table must have a partition key.
  - getBillingMode
```
@Stability(value=Stable)
 @Nullable
public Object getBillingMode()
```
    The billing mode for the table, which determines how you'll be charged for reads and writes:.
    - On-demand mode (default) - You pay based on the actual reads and writes your application performs.
    - Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.
    If you don't specify a value for this property, then the table will use on-demand mode.
  - setBillingMode
```
@Stability(value=Stable)
public void setBillingMode(@Nullable
                                                    CfnTable.BillingModeProperty value)
```
    The billing mode for the table, which determines how you'll be charged for reads and writes:.
    - On-demand mode (default) - You pay based on the actual reads and writes your application performs.
    - Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.
    If you don't specify a value for this property, then the table will use on-demand mode.
  - setBillingMode
```
@Stability(value=Stable)
public void setBillingMode(@Nullable
                                                    IResolvable value)
```
    The billing mode for the table, which determines how you'll be charged for reads and writes:.
    - On-demand mode (default) - You pay based on the actual reads and writes your application performs.
    - Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.
    If you don't specify a value for this property, then the table will use on-demand mode.
  - getClusteringKeyColumns
```
@Stability(value=Stable)
 @Nullable
public Object getClusteringKeyColumns()
```
    One or more columns that determine how the table data is sorted.
  - setClusteringKeyColumns
```
@Stability(value=Stable)
public void setClusteringKeyColumns(@Nullable
                                                             IResolvable value)
```
    One or more columns that determine how the table data is sorted.
  - setClusteringKeyColumns
```
@Stability(value=Stable)
public void setClusteringKeyColumns(@Nullable
                                                             List<Object> value)
```
    One or more columns that determine how the table data is sorted.
  - getDefaultTimeToLive
```
@Stability(value=Stable)
 @Nullable
public Number getDefaultTimeToLive()
```
    The default Time To Live (TTL) value for all rows in a table in seconds.
    The maximum configurable value is 630,720,000 seconds, which is the equivalent of 20 years. By default, the TTL value for a table is 0, which means data does not expire.
    For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide .
  - setDefaultTimeToLive
```
@Stability(value=Stable)
public void setDefaultTimeToLive(@Nullable
                                                          Number value)
```
    The default Time To Live (TTL) value for all rows in a table in seconds.
    The maximum configurable value is 630,720,000 seconds, which is the equivalent of 20 years. By default, the TTL value for a table is 0, which means data does not expire.
    For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide .
  - getEncryptionSpecification
```
@Stability(value=Stable)
 @Nullable
public Object getEncryptionSpecification()
```
    The encryption at rest options for the table.
    - AWS owned key (default) - The key is owned by Amazon Keyspaces.
    - Customer managed key - The key is stored in your account and is created, owned, and managed by you.
    If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.
    
    For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .
  - setEncryptionSpecification
```
@Stability(value=Stable)
public void setEncryptionSpecification(@Nullable
                                                                CfnTable.EncryptionSpecificationProperty value)
```
    The encryption at rest options for the table.
    - AWS owned key (default) - The key is owned by Amazon Keyspaces.
    - Customer managed key - The key is stored in your account and is created, owned, and managed by you.
    If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.
    
    For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .
  - setEncryptionSpecification
```
@Stability(value=Stable)
public void setEncryptionSpecification(@Nullable
                                                                IResolvable value)
```
    The encryption at rest options for the table.
    - AWS owned key (default) - The key is owned by Amazon Keyspaces.
    - Customer managed key - The key is stored in your account and is created, owned, and managed by you.
    If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.
    
    For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .
  - getPointInTimeRecoveryEnabled
```
@Stability(value=Stable)
 @Nullable
public Object getPointInTimeRecoveryEnabled()
```
    Specifies if point-in-time recovery is enabled or disabled for the table.
    The options are PointInTimeRecoveryEnabled=true and PointInTimeRecoveryEnabled=false . If not specified, the default is PointInTimeRecoveryEnabled=false .
  - setPointInTimeRecoveryEnabled
```
@Stability(value=Stable)
public void setPointInTimeRecoveryEnabled(@Nullable
                                                                   Boolean value)
```
    Specifies if point-in-time recovery is enabled or disabled for the table.
    The options are PointInTimeRecoveryEnabled=true and PointInTimeRecoveryEnabled=false . If not specified, the default is PointInTimeRecoveryEnabled=false .
  - setPointInTimeRecoveryEnabled
```
@Stability(value=Stable)
public void setPointInTimeRecoveryEnabled(@Nullable
                                                                   IResolvable value)
```
    Specifies if point-in-time recovery is enabled or disabled for the table.
    The options are PointInTimeRecoveryEnabled=true and PointInTimeRecoveryEnabled=false . If not specified, the default is PointInTimeRecoveryEnabled=false .
  - getRegularColumns
```
@Stability(value=Stable)
 @Nullable
public Object getRegularColumns()
```
    One or more columns that are not part of the primary key - that is, columns that are *not* defined as partition key columns or clustering key columns.
    You can add regular columns to existing tables by adding them to the template.
  - setRegularColumns
```
@Stability(value=Stable)
public void setRegularColumns(@Nullable
                                                       IResolvable value)
```
    One or more columns that are not part of the primary key - that is, columns that are *not* defined as partition key columns or clustering key columns.
    You can add regular columns to existing tables by adding them to the template.
  - setRegularColumns
```
@Stability(value=Stable)
public void setRegularColumns(@Nullable
                                                       List<Object> value)
```
    One or more columns that are not part of the primary key - that is, columns that are *not* defined as partition key columns or clustering key columns.
    You can add regular columns to existing tables by adding them to the template.
  - getTableName
```
@Stability(value=Stable)
 @Nullable
public String getTableName()
```
    The name of the table to be created.
    The table name is case sensitive. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the table name. For more information, see Name type .
    
    If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    
    Length constraints: Minimum length of 3. Maximum length of 255.
    Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$
  - setTableName
```
@Stability(value=Stable)
public void setTableName(@Nullable
                                                  String value)
```
    The name of the table to be created.
    The table name is case sensitive. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the table name. For more information, see Name type .
    
    If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    
    Length constraints: Minimum length of 3. Maximum length of 255.
    Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$

Class CfnTable

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnTable

CfnTable

CfnTable

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getKeyspaceName

setKeyspaceName

getPartitionKeyColumns

setPartitionKeyColumns

setPartitionKeyColumns

getBillingMode

setBillingMode

setBillingMode

getClusteringKeyColumns

setClusteringKeyColumns

setClusteringKeyColumns

getDefaultTimeToLive

setDefaultTimeToLive

getEncryptionSpecification

setEncryptionSpecification

setEncryptionSpecification

getPointInTimeRecoveryEnabled

setPointInTimeRecoveryEnabled

setPointInTimeRecoveryEnabled

getRegularColumns

setRegularColumns

setRegularColumns

getTableName

setTableName