Class CfnDatabase
A CloudFormation AWS::Timestream::Database
.
Inherited Members
Namespace: Amazon.CDK.AWS.Timestream
Assembly: Amazon.CDK.AWS.Timestream.dll
Syntax (csharp)
public class CfnDatabase : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDatabase
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::Timestream::Database
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-database.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Timestream;
var cfnDatabase = new CfnDatabase(this, "MyCfnDatabase", new CfnDatabaseProps {
DatabaseName = "databaseName",
KmsKeyId = "kmsKeyId",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDatabase(Construct, String, ICfnDatabaseProps) | Create a new |
CfnDatabase(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDatabase(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DatabaseName | The name of the Timestream database. |
KmsKeyId | The identifier of the AWS KMS key used to encrypt the data stored in the database. |
Tags | The tags to add to the database. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDatabase(Construct, String, ICfnDatabaseProps)
Create a new AWS::Timestream::Database
.
public CfnDatabase(Construct scope, string id, ICfnDatabaseProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDatabaseProps
- resource properties.
CfnDatabase(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDatabase(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDatabase(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDatabase(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The arn
of the database.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DatabaseName
The name of the Timestream database.
public virtual string DatabaseName { get; set; }
Property Value
System.String
Remarks
Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.
KmsKeyId
The identifier of the AWS KMS key used to encrypt the data stored in the database.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Remarks
Tags
The tags to add to the database.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>