Package software.amazon.awscdk.services.timestream

Class CfnDatabase

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.CfnDatabase
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDatabaseRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:31.184Z") @Stability(Stable) public class CfnDatabase extends CfnResource implements IInspectable, IDatabaseRef, ITaggable
Creates a new Timestream database.

If the AWS key is not specified, the database will be encrypted with a Timestream managed AWS key located in your account. Refer to AWS managed AWS keys for more info. 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.*;
 CfnDatabase cfnDatabase = CfnDatabase.Builder.create(this, "MyCfnDatabase")
         .databaseName("databaseName")
         .kmsKeyId("kmsKeyId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDatabase

      protected CfnDatabase(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDatabase

      protected CfnDatabase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDatabase

      @Stability(Stable) public CfnDatabase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDatabaseProps props)
      Create a new AWS::Timestream::Database.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnDatabase

      @Stability(Stable) public CfnDatabase(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::Timestream::Database.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForDatabase

      @Stability(Stable) @NotNull public static String arnForDatabase(@NotNull IDatabaseRef resource)
      Parameters:
      resource - This parameter is required.

    • fromDatabaseArn

      @Stability(Stable) @NotNull public static IDatabaseRef fromDatabaseArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IDatabaseRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromDatabaseName

      @Stability(Stable) @NotNull public static IDatabaseRef fromDatabaseName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String databaseName)
      Creates a new IDatabaseRef from a databaseName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      databaseName - This parameter is required.

    • isCfnDatabase

      @Stability(Stable) @NotNull public static Boolean isCfnDatabase(@NotNull Object x)
      Checks whether the given object is a CfnDatabase.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The arn of the database.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDatabaseRef

      @Stability(Stable) @NotNull public DatabaseReference getDatabaseRef()
      A reference to a Database resource.
      Specified by:
      getDatabaseRef in interface IDatabaseRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDatabaseName

      @Stability(Stable) @Nullable public String getDatabaseName()
      The name of the Timestream database.

    • setDatabaseName

      @Stability(Stable) public void setDatabaseName(@Nullable String value)
      The name of the Timestream database.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The identifier of the AWS key used to encrypt the data stored in the database.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The identifier of the AWS key used to encrypt the data stored in the database.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags to add to the database.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags to add to the database.