software.amazon.awscdk.services.timestream

Class CfnTable

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.timestream.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:42.589Z")
 @Stability(value=Stable)
public class CfnTable
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Timestream::Table`.

The CreateTable operation adds a new table to an existing database in your account. 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.

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.timestream.*;
 Object magneticStoreWriteProperties;
 Object retentionProperties;
 CfnTable cfnTable = CfnTable.Builder.create(this, "MyCfnTable")
         .databaseName("databaseName")
         // the properties below are optional
         .magneticStoreWriteProperties(magneticStoreWriteProperties)
         .retentionProperties(retentionProperties)
         .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 class	CfnTable.Builder A fluent builder for CfnTable.

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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The `arn` of the table.
String	getAttrName() The name of the table.
protected Map<String,Object>	getCfnProperties()
String	getDatabaseName() The name of the Timestream database that contains this table.
Object	getMagneticStoreWriteProperties() Contains properties to set on the table when enabling magnetic store writes.
Object	getRetentionProperties() The retention duration for the memory store and magnetic store.
String	getTableName() The name of the Timestream table.
TagManager	getTags() The tags to add to the table.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDatabaseName(String value) The name of the Timestream database that contains this table.
void	setMagneticStoreWriteProperties(Object value) Contains properties to set on the table when enabling magnetic store writes.
void	setRetentionProperties(Object value) The retention duration for the memory store and magnetic store.
void	setTableName(String value) The name of the Timestream table.

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::Timestream::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.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The `arn` of the table.

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

The name of the table.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to add to the table.

getDatabaseName

@Stability(value=Stable)
 @NotNull
public String getDatabaseName()

The name of the Timestream database that contains this table.

Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.

setDatabaseName

@Stability(value=Stable)
public void setDatabaseName(@NotNull
                                                     String value)

The name of the Timestream database that contains this table.

Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.

getMagneticStoreWriteProperties

@Stability(value=Stable)
 @NotNull
public Object getMagneticStoreWriteProperties()

Contains properties to set on the table when enabling magnetic store writes.

This object has the following attributes:

• EnableMagneticStoreWrites : A boolean flag to enable magnetic store writes.
• MagneticStoreRejectedDataLocation : The location to write error reports for records rejected, asynchronously, during magnetic store writes. Only S3Configuration objects are allowed. The S3Configuration object has the following attributes:
• BucketName : The name of the S3 bucket.
• EncryptionOption : The encryption option for the S3 location. Valid values are S3 server-side encryption with an S3 managed key ( SSE_S3 ) or AWS managed key ( SSE_KMS ).
• KmsKeyId : The AWS KMS key ID to use when encrypting with an AWS managed key.
• ObjectKeyPrefix : The prefix to use option for the objects stored in S3.

Both BucketName and EncryptionOption are required when S3Configuration is specified. If you specify SSE_KMS as your EncryptionOption then KmsKeyId is required .

EnableMagneticStoreWrites attribute is required when MagneticStoreWriteProperties is specified. MagneticStoreRejectedDataLocation attribute is required when EnableMagneticStoreWrites is set to true .

See the following examples:

JSON

 { "Type" : AWS::Timestream::Table", "Properties":{ "DatabaseName":"TestDatabase", "TableName":"TestTable", "MagneticStoreWriteProperties":{ "EnableMagneticStoreWrites":true, "MagneticStoreRejectedDataLocation":{ "S3Configuration":{ "BucketName":"testbucket", "EncryptionOption":"SSE_KMS", "KmsKeyId":"1234abcd-12ab-34cd-56ef-1234567890ab", "ObjectKeyPrefix":"prefix" } } } }
 }
 

YAML

 Type: AWS::Timestream::Table
 DependsOn: TestDatabase
 Properties: TableName: "TestTable" DatabaseName: "TestDatabase" MagneticStoreWriteProperties: EnableMagneticStoreWrites: true MagneticStoreRejectedDataLocation: S3Configuration: BucketName: "testbucket" EncryptionOption: "SSE_KMS" BucketName: "1234abcd-12ab-34cd-56ef-1234567890ab" EncryptionOption: "prefix"
 

setMagneticStoreWriteProperties

@Stability(value=Stable)
public void setMagneticStoreWriteProperties(@NotNull
                                                                     Object value)

Contains properties to set on the table when enabling magnetic store writes.

This object has the following attributes:

• EnableMagneticStoreWrites : A boolean flag to enable magnetic store writes.
• MagneticStoreRejectedDataLocation : The location to write error reports for records rejected, asynchronously, during magnetic store writes. Only S3Configuration objects are allowed. The S3Configuration object has the following attributes:
• BucketName : The name of the S3 bucket.
• EncryptionOption : The encryption option for the S3 location. Valid values are S3 server-side encryption with an S3 managed key ( SSE_S3 ) or AWS managed key ( SSE_KMS ).
• KmsKeyId : The AWS KMS key ID to use when encrypting with an AWS managed key.
• ObjectKeyPrefix : The prefix to use option for the objects stored in S3.

Both BucketName and EncryptionOption are required when S3Configuration is specified. If you specify SSE_KMS as your EncryptionOption then KmsKeyId is required .

EnableMagneticStoreWrites attribute is required when MagneticStoreWriteProperties is specified. MagneticStoreRejectedDataLocation attribute is required when EnableMagneticStoreWrites is set to true .

See the following examples:

JSON

 { "Type" : AWS::Timestream::Table", "Properties":{ "DatabaseName":"TestDatabase", "TableName":"TestTable", "MagneticStoreWriteProperties":{ "EnableMagneticStoreWrites":true, "MagneticStoreRejectedDataLocation":{ "S3Configuration":{ "BucketName":"testbucket", "EncryptionOption":"SSE_KMS", "KmsKeyId":"1234abcd-12ab-34cd-56ef-1234567890ab", "ObjectKeyPrefix":"prefix" } } } }
 }
 

YAML

 Type: AWS::Timestream::Table
 DependsOn: TestDatabase
 Properties: TableName: "TestTable" DatabaseName: "TestDatabase" MagneticStoreWriteProperties: EnableMagneticStoreWrites: true MagneticStoreRejectedDataLocation: S3Configuration: BucketName: "testbucket" EncryptionOption: "SSE_KMS" BucketName: "1234abcd-12ab-34cd-56ef-1234567890ab" EncryptionOption: "prefix"
 

getRetentionProperties

@Stability(value=Stable)
 @NotNull
public Object getRetentionProperties()

The retention duration for the memory store and magnetic store. This object has the following attributes:.

• MemoryStoreRetentionPeriodInHours : Retention duration for memory store, in hours.
• MagneticStoreRetentionPeriodInDays : Retention duration for magnetic store, in days.

Both attributes are of type string . Both attributes are required when RetentionProperties is specified.

See the following examples:

JSON

{ "Type" : AWS::Timestream::Table", "Properties" : { "DatabaseName" : "TestDatabase", "TableName" : "TestTable", "RetentionProperties" : { "MemoryStoreRetentionPeriodInHours": "24", "MagneticStoreRetentionPeriodInDays": "7" } } }

YAML

 Type: AWS::Timestream::Table
 DependsOn: TestDatabase
 Properties: TableName: "TestTable" DatabaseName: "TestDatabase" RetentionProperties: MemoryStoreRetentionPeriodInHours: "24" MagneticStoreRetentionPeriodInDays: "7"
 

setRetentionProperties

@Stability(value=Stable)
public void setRetentionProperties(@NotNull
                                                            Object value)

The retention duration for the memory store and magnetic store. This object has the following attributes:.

• MemoryStoreRetentionPeriodInHours : Retention duration for memory store, in hours.
• MagneticStoreRetentionPeriodInDays : Retention duration for magnetic store, in days.

Both attributes are of type string . Both attributes are required when RetentionProperties is specified.

See the following examples:

JSON

{ "Type" : AWS::Timestream::Table", "Properties" : { "DatabaseName" : "TestDatabase", "TableName" : "TestTable", "RetentionProperties" : { "MemoryStoreRetentionPeriodInHours": "24", "MagneticStoreRetentionPeriodInDays": "7" } } }

YAML

 Type: AWS::Timestream::Table
 DependsOn: TestDatabase
 Properties: TableName: "TestTable" DatabaseName: "TestDatabase" RetentionProperties: MemoryStoreRetentionPeriodInHours: "24" MagneticStoreRetentionPeriodInDays: "7"
 

getTableName

@Stability(value=Stable)
 @Nullable
public String getTableName()

The name of the Timestream table.

Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.

setTableName

@Stability(value=Stable)
public void setTableName(@Nullable
                                                  String value)

The name of the Timestream table.

Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.