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, 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.582Z")
 @Stability(value=Stable)
public class CfnDatabase
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Timestream::Database`.

Creates a new Timestream database. If the AWS KMS key is not specified, the database will be encrypted with a Timestream managed AWS KMS key located in your account. Refer to AWS managed AWS KMS 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDatabase.Builder A fluent builder for CfnDatabase.

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
	CfnDatabase(software.constructs.Construct scope, String id) Create a new `AWS::Timestream::Database`.
	CfnDatabase(software.constructs.Construct scope, String id, CfnDatabaseProps props) Create a new `AWS::Timestream::Database`.
protected	CfnDatabase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDatabase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The `arn` of the database.
protected Map<String,Object>	getCfnProperties()
String	getDatabaseName() The name of the Timestream database.
String	getKmsKeyId() The identifier of the AWS KMS key used to encrypt the data stored in the database.
TagManager	getTags() The tags to add to the database.
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.
void	setKmsKeyId(String value) The identifier of the AWS KMS key used to encrypt the data stored in the database.

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

CfnDatabase

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

CfnDatabase

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

CfnDatabase

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnDatabase

@Stability(value=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 - - scoped id of the resource. 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 database.

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 database.

getDatabaseName

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

The name of the Timestream database.

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

setDatabaseName

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

The name of the Timestream database.

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

getKmsKeyId

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

The identifier of the AWS KMS key used to encrypt the data stored in the database.

setKmsKeyId

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

The identifier of the AWS KMS key used to encrypt the data stored in the database.