Class CfnTable
You can use the AWS::Cassandra::Table
resource to create a new table in Amazon Keyspaces (for Apache Cassandra).
Inherited Members
Namespace: Amazon.CDK.AWS.Cassandra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTable : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnTable
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see Create a keyspace and 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
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
AutoScalingSpecifications = new AutoScalingSpecificationProperty {
ReadCapacityAutoScaling = new AutoScalingSettingProperty {
AutoScalingDisabled = false,
MaximumUnits = 123,
MinimumUnits = 123,
ScalingPolicy = new ScalingPolicyProperty {
TargetTrackingScalingPolicyConfiguration = new TargetTrackingScalingPolicyConfigurationProperty {
TargetValue = 123,
// the properties below are optional
DisableScaleIn = false,
ScaleInCooldown = 123,
ScaleOutCooldown = 123
}
}
},
WriteCapacityAutoScaling = new AutoScalingSettingProperty {
AutoScalingDisabled = false,
MaximumUnits = 123,
MinimumUnits = 123,
ScalingPolicy = new ScalingPolicyProperty {
TargetTrackingScalingPolicyConfiguration = new TargetTrackingScalingPolicyConfigurationProperty {
TargetValue = 123,
// the properties below are optional
DisableScaleIn = false,
ScaleInCooldown = 123,
ScaleOutCooldown = 123
}
}
}
},
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"
} },
ReplicaSpecifications = new [] { new ReplicaSpecificationProperty {
Region = "region",
// the properties below are optional
ReadCapacityAutoScaling = new AutoScalingSettingProperty {
AutoScalingDisabled = false,
MaximumUnits = 123,
MinimumUnits = 123,
ScalingPolicy = new ScalingPolicyProperty {
TargetTrackingScalingPolicyConfiguration = new TargetTrackingScalingPolicyConfigurationProperty {
TargetValue = 123,
// the properties below are optional
DisableScaleIn = false,
ScaleInCooldown = 123,
ScaleOutCooldown = 123
}
}
},
ReadCapacityUnits = 123
} },
TableName = "tableName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
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 |
CfnTable(Construct, String, ICfnTableProps) |
Properties
AutoScalingSpecifications | The optional auto scaling capacity settings for a table in provisioned capacity mode. |
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. |
ReplicaSpecifications | The AWS Region specific settings of a multi-Region table. |
TableName | The name of the table to be created. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnTable(Construct, String, ICfnTableProps)
public CfnTable(Construct scope, string id, ICfnTableProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnTableProps
Resource properties.
Properties
AutoScalingSpecifications
The optional auto scaling capacity settings for a table in provisioned capacity mode.
public virtual object AutoScalingSpecifications { get; set; }
Property Value
System.Object
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
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
ClusteringKeyColumns
One or more columns that determine how the table data is sorted.
public virtual object ClusteringKeyColumns { get; set; }
Property Value
System.Object
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>
EncryptionSpecification
The encryption at rest options for the table.
public virtual object EncryptionSpecification { get; set; }
Property Value
System.Object
KeyspaceName
The name of the keyspace to create the table in.
public virtual string KeyspaceName { get; set; }
Property Value
System.String
PartitionKeyColumns
One or more columns that uniquely identify every row in the table.
public virtual object PartitionKeyColumns { get; set; }
Property Value
System.Object
PointInTimeRecoveryEnabled
Specifies if point-in-time recovery is enabled or disabled for the table.
public virtual object PointInTimeRecoveryEnabled { get; set; }
Property Value
System.Object
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
ReplicaSpecifications
The AWS Region specific settings of a multi-Region table.
public virtual object ReplicaSpecifications { get; set; }
Property Value
System.Object
TableName
The name of the table to be created.
public virtual string TableName { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>