Class CfnTableProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.timestream.CfnTableProps.Jsii$Proxy
All Implemented Interfaces:
CfnTableProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnTableProps

@Stability(Stable) @Internal public static final class CfnTableProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnTableProps
An implementation for CfnTableProps
  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.timestream.CfnTableProps

    CfnTableProps.Builder, CfnTableProps.Jsii$Proxy
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Constructor that initializes the object based on literal property values passed by the CfnTableProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.
  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
     
    final boolean
     
    final String
    The name of the Timestream database that contains this table.
    final Object
    Contains properties to set on the table when enabling magnetic store writes.
    final Object
    The retention duration for the memory store and magnetic store.
    final String
    The name of the Timestream table.
    final List<CfnTag>
    The tags to add to the table.
    final int
     

    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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.
    • Jsii$Proxy

      protected Jsii$Proxy(CfnTableProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnTableProps.Builder.
  • Method Details

    • getDatabaseName

      public final String getDatabaseName()
      Description copied from interface: CfnTableProps
      The name of the Timestream database that contains this table.

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

      Specified by:
      getDatabaseName in interface CfnTableProps
    • getMagneticStoreWriteProperties

      public final Object getMagneticStoreWriteProperties()
      Description copied from interface: CfnTableProps
      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" KmsKeyId: "1234abcd-12ab-34cd-56ef-1234567890ab" ObjectKeyPrefix: "prefix"
       
      Specified by:
      getMagneticStoreWriteProperties in interface CfnTableProps
    • getRetentionProperties

      public final Object getRetentionProperties()
      Description copied from interface: CfnTableProps
      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"
       
      Specified by:
      getRetentionProperties in interface CfnTableProps
    • getTableName

      public final String getTableName()
      Description copied from interface: CfnTableProps
      The name of the Timestream table.

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

      Specified by:
      getTableName in interface CfnTableProps
    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnTableProps
      The tags to add to the table.
      Specified by:
      getTags in interface CfnTableProps
    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object