Package software.amazon.awscdk.cfnpropertymixins.services.timestream

Class CfnTablePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.timestream.CfnTablePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTablePropsMixin>

Enclosing class:

CfnTablePropsMixin

@Stability(Stable)
public static final class CfnTablePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTablePropsMixin>

A fluent builder for CfnTablePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnTablePropsMixin	build()
static CfnTablePropsMixin.Builder	create()
static CfnTablePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnTablePropsMixin.Builder	databaseName(String databaseName)	The name of the Timestream database that contains this table.
CfnTablePropsMixin.Builder	databaseName(IDatabaseRef databaseName)	The name of the Timestream database that contains this table.
CfnTablePropsMixin.Builder	magneticStoreWriteProperties(Object magneticStoreWriteProperties)	Contains properties to set on the table when enabling magnetic store writes.
CfnTablePropsMixin.Builder	retentionProperties(Object retentionProperties)	The retention duration for the memory store and magnetic store.
CfnTablePropsMixin.Builder	schema(CfnTablePropsMixin.SchemaProperty schema)	The schema of the table.
CfnTablePropsMixin.Builder	schema(IResolvable schema)	The schema of the table.
CfnTablePropsMixin.Builder	tableName(String tableName)	The name of the Timestream table.
CfnTablePropsMixin.Builder	tags(List<? extends CfnTag> tags)	The tags to add to the table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnTablePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnTablePropsMixin.Builder.

create

@Stability(Stable)
public static CfnTablePropsMixin.Builder create()

Returns:

a new instance of CfnTablePropsMixin.Builder.

databaseName

@Stability(Stable)
public CfnTablePropsMixin.Builder databaseName(String databaseName)

The name of the Timestream database that contains this table.

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

Parameters:

databaseName - The name of the Timestream database that contains this table. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-databasename

databaseName

@Stability(Stable)
public CfnTablePropsMixin.Builder databaseName(IDatabaseRef databaseName)

The name of the Timestream database that contains this table.

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

Parameters:

databaseName - The name of the Timestream database that contains this table. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-databasename

magneticStoreWriteProperties

@Stability(Stable)
public CfnTablePropsMixin.Builder magneticStoreWriteProperties(Object magneticStoreWriteProperties)

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":" amzn-s3-demo-bucket ", "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: " amzn-s3-demo-bucket " EncryptionOption: "SSE_KMS" KmsKeyId: "1234abcd-12ab-34cd-56ef-1234567890ab" ObjectKeyPrefix: "prefix"
 

Parameters:

magneticStoreWriteProperties - Contains properties to set on the table when enabling magnetic store writes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-magneticstorewriteproperties

retentionProperties

@Stability(Stable)
public CfnTablePropsMixin.Builder retentionProperties(Object retentionProperties)

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"
 

Parameters:

retentionProperties - The retention duration for the memory store and magnetic store. This object has the following attributes:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-retentionproperties

schema

@Stability(Stable)
public CfnTablePropsMixin.Builder schema(IResolvable schema)

The schema of the table.

Parameters:

schema - The schema of the table. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-schema

schema

@Stability(Stable)
public CfnTablePropsMixin.Builder schema(CfnTablePropsMixin.SchemaProperty schema)

The schema of the table.

Parameters:

schema - The schema of the table. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-schema

tableName

@Stability(Stable)
public CfnTablePropsMixin.Builder tableName(String tableName)

The name of the Timestream table.

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

Parameters:

tableName - The name of the Timestream table. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-tablename

tags

@Stability(Stable)
public CfnTablePropsMixin.Builder tags(List<? extends CfnTag> tags)

The tags to add to the table.

Parameters:

tags - The tags to add to the table. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-tags

build

@Stability(Stable)
public CfnTablePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTablePropsMixin>

Returns:

a newly built instance of CfnTablePropsMixin.