Class CfnTable
A CloudFormation AWS::Cassandra::Table
.
Inherited Members
Namespace: Amazon.CDK.AWS.Cassandra
Assembly: Amazon.CDK.AWS.Cassandra.dll
Syntax (csharp)
public class CfnTable : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnTable
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 keyspace and a table in the Amazon Keyspaces Developer Guide .
CloudformationResource: AWS::Cassandra::Table
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.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.AWS.Cassandra;
var cfnTable = new CfnTable(this, "MyCfnTable", new CfnTableProps {
KeyspaceName = "keyspaceName",
PartitionKeyColumns = new [] { new ColumnProperty {
ColumnName = "columnName",
ColumnType = "columnType"
} },
// the properties below are optional
BillingMode = new BillingModeProperty {
Mode = "mode",
// the properties below are optional
ProvisionedThroughput = new ProvisionedThroughputProperty {
ReadCapacityUnits = 123,
WriteCapacityUnits = 123
}
},
ClientSideTimestampsEnabled = false,
ClusteringKeyColumns = new [] { new ClusteringKeyColumnProperty {
Column = new ColumnProperty {
ColumnName = "columnName",
ColumnType = "columnType"
},
// the properties below are optional
OrderBy = "orderBy"
} },
DefaultTimeToLive = 123,
EncryptionSpecification = new EncryptionSpecificationProperty {
EncryptionType = "encryptionType",
// the properties below are optional
KmsKeyIdentifier = "kmsKeyIdentifier"
},
PointInTimeRecoveryEnabled = false,
RegularColumns = new [] { new ColumnProperty {
ColumnName = "columnName",
ColumnType = "columnType"
} },
TableName = "tableName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnTable(Construct, String, ICfnTableProps) | Create a new |
CfnTable(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnTable(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
BillingMode | The billing mode for the table, which determines how you'll be charged for reads and writes:. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClientSideTimestampsEnabled | Enables client-side timestamps for the table. |
ClusteringKeyColumns | One or more columns that determine how the table data is sorted. |
DefaultTimeToLive | The default Time To Live (TTL) value for all rows in a table in seconds. |
EncryptionSpecification | The encryption at rest options for the table. |
KeyspaceName | The name of the keyspace to create the table in. |
PartitionKeyColumns | One or more columns that uniquely identify every row in the table. |
PointInTimeRecoveryEnabled | Specifies if point-in-time recovery is enabled or disabled for the table. |
RegularColumns | 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. |
TableName | The name of the table to be created. |
Tags | A list of key-value pair tags to be attached to the resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTable(Construct, String, ICfnTableProps)
Create a new AWS::Cassandra::Table
.
public CfnTable(Construct scope, string id, ICfnTableProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnTableProps
- resource properties.
CfnTable(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTable(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTable(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTable(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
BillingMode
The billing mode for the table, which determines how you'll be charged for reads and writes:.
public virtual object BillingMode { get; set; }
Property Value
System.Object
Remarks
If you don't specify a value for this property, then the table will use on-demand mode.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClientSideTimestampsEnabled
Enables client-side timestamps for the table.
public virtual object ClientSideTimestampsEnabled { get; set; }
Property Value
System.Object
Remarks
By default, the setting is disabled. You can enable client-side timestamps with the following option:
After client-side timestamps are enabled for a table, you can't disable this setting.
ClusteringKeyColumns
One or more columns that determine how the table data is sorted.
public virtual object ClusteringKeyColumns { get; set; }
Property Value
System.Object
Remarks
DefaultTimeToLive
The default Time To Live (TTL) value for all rows in a table in seconds.
public virtual Nullable<double> DefaultTimeToLive { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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 .
EncryptionSpecification
The encryption at rest options for the table.
public virtual object EncryptionSpecification { get; set; }
Property Value
System.Object
Remarks
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 .
KeyspaceName
The name of the keyspace to create the table in.
public virtual string KeyspaceName { get; set; }
Property Value
System.String
Remarks
The keyspace must already exist.
PartitionKeyColumns
One or more columns that uniquely identify every row in the table.
public virtual object PartitionKeyColumns { get; set; }
Property Value
System.Object
Remarks
Every table must have a partition key.
PointInTimeRecoveryEnabled
Specifies if point-in-time recovery is enabled or disabled for the table.
public virtual object PointInTimeRecoveryEnabled { get; set; }
Property Value
System.Object
Remarks
The options are PointInTimeRecoveryEnabled=true
and PointInTimeRecoveryEnabled=false
. If not specified, the default is PointInTimeRecoveryEnabled=false
.
RegularColumns
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.
public virtual object RegularColumns { get; set; }
Property Value
System.Object
Remarks
You can add regular columns to existing tables by adding them to the template.
TableName
The name of the table to be created.
public virtual string TableName { get; set; }
Property Value
System.String
Remarks
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 can't perform updates that require replacing this resource. You can perform updates that require no interruption 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}$
Tags
A list of key-value pair tags to be attached to the resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>