Class CfnTable
The CreateTable operation adds a new table to an existing database in your account.
Inherited Members
Namespace: Amazon.CDK.AWS.Timestream
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTable : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnTable
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
In an AWS account, table names must be at least unique within each Region if they are in the same database. You may have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply . See code sample for details.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html
CloudformationResource: AWS::Timestream::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.Timestream;
var magneticStoreWriteProperties;
var retentionProperties;
var cfnTable = new CfnTable(this, "MyCfnTable", new CfnTableProps {
DatabaseName = "databaseName",
// the properties below are optional
MagneticStoreWriteProperties = magneticStoreWriteProperties,
RetentionProperties = retentionProperties,
Schema = new SchemaProperty {
CompositePartitionKey = new [] { new PartitionKeyProperty {
Type = "type",
// the properties below are optional
EnforcementInRecord = "enforcementInRecord",
Name = "name"
} }
},
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
AttrArn | The |
AttrName | The name of the table. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DatabaseName | The name of the Timestream database that contains this table. |
MagneticStoreWriteProperties | Contains properties to set on the table when enabling magnetic store writes. |
RetentionProperties | The retention duration for the memory store and magnetic store. |
Schema | The schema of the table. |
TableName | The name of the Timestream table. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags to add to the table. |
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
AttrArn
The arn
of the table.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrName
The name of the table.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
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
DatabaseName
The name of the Timestream database that contains this table.
public virtual string DatabaseName { get; set; }
Property Value
System.String
MagneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes.
public virtual object MagneticStoreWriteProperties { get; set; }
Property Value
System.Object
RetentionProperties
The retention duration for the memory store and magnetic store.
public virtual object RetentionProperties { get; set; }
Property Value
System.Object
Remarks
This object has the following attributes:.
Schema
The schema of the table.
public virtual object Schema { get; set; }
Property Value
System.Object
TableName
The name of the Timestream table.
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
The tags to add to the table.
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>