Class CfnInfluxDBInstanceMixinProps

Properties for CfnInfluxDBInstancePropsMixin.

Inheritance

object

CfnInfluxDBInstanceMixinProps

Implements

ICfnInfluxDBInstanceMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Timestream.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnInfluxDBInstanceMixinProps : ICfnInfluxDBInstanceMixinProps

Syntax (vb)

Public Class CfnInfluxDBInstanceMixinProps Implements ICfnInfluxDBInstanceMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.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.Mixins.Preview.AWS.Timestream.Mixins;

             var cfnInfluxDBInstanceMixinProps = new CfnInfluxDBInstanceMixinProps {
                 AllocatedStorage = 123,
                 Bucket = "bucket",
                 DbInstanceType = "dbInstanceType",
                 DbParameterGroupIdentifier = "dbParameterGroupIdentifier",
                 DbStorageType = "dbStorageType",
                 DeploymentType = "deploymentType",
                 LogDeliveryConfiguration = new LogDeliveryConfigurationProperty {
                     S3Configuration = new S3ConfigurationProperty {
                         BucketName = "bucketName",
                         Enabled = false
                     }
                 },
                 Name = "name",
                 NetworkType = "networkType",
                 Organization = "organization",
                 Password = "password",
                 Port = 123,
                 PubliclyAccessible = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Username = "username",
                 VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" },
                 VpcSubnetIds = new [] { "vpcSubnetIds" }
             };

Synopsis

Constructors

CfnInfluxDBInstanceMixinProps()

Properties for CfnInfluxDBInstancePropsMixin.

Properties

AllocatedStorage	The amount of storage to allocate for your DB storage type in GiB (gibibytes).
Bucket	The name of the initial InfluxDB bucket.
DbInstanceType	The Timestream for InfluxDB DB instance type to run on.
DbParameterGroupIdentifier	The name or id of the DB parameter group to assign to your DB instance.
DbStorageType	The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
DeploymentType	Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
LogDeliveryConfiguration	Configuration for sending InfluxDB engine logs to a specified S3 bucket.
Name	The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
NetworkType	Network type of the InfluxDB Instance.
Organization	The name of the initial organization for the initial admin user in InfluxDB.
Password	The password of the initial admin user created in InfluxDB.
Port	The port number on which InfluxDB accepts connections.
PubliclyAccessible	Configures the DB instance with a public IP to facilitate access.
Tags	A list of key-value pairs to associate with the DB instance.
Username	The username of the initial admin user created in InfluxDB.
VpcSecurityGroupIds	A list of VPC security group IDs to associate with the DB instance.
VpcSubnetIds	A list of VPC subnet IDs to associate with the DB instance.

Constructors

CfnInfluxDBInstanceMixinProps()

Properties for CfnInfluxDBInstancePropsMixin.

public CfnInfluxDBInstanceMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.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.Mixins.Preview.AWS.Timestream.Mixins;

             var cfnInfluxDBInstanceMixinProps = new CfnInfluxDBInstanceMixinProps {
                 AllocatedStorage = 123,
                 Bucket = "bucket",
                 DbInstanceType = "dbInstanceType",
                 DbParameterGroupIdentifier = "dbParameterGroupIdentifier",
                 DbStorageType = "dbStorageType",
                 DeploymentType = "deploymentType",
                 LogDeliveryConfiguration = new LogDeliveryConfigurationProperty {
                     S3Configuration = new S3ConfigurationProperty {
                         BucketName = "bucketName",
                         Enabled = false
                     }
                 },
                 Name = "name",
                 NetworkType = "networkType",
                 Organization = "organization",
                 Password = "password",
                 Port = 123,
                 PubliclyAccessible = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Username = "username",
                 VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" },
                 VpcSubnetIds = new [] { "vpcSubnetIds" }
             };

Properties

AllocatedStorage

The amount of storage to allocate for your DB storage type in GiB (gibibytes).

public double? AllocatedStorage { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-allocatedstorage

Bucket

The name of the initial InfluxDB bucket.

public string? Bucket { get; set; }

Property Value

string

Remarks

All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-bucket

DbInstanceType

The Timestream for InfluxDB DB instance type to run on.

public string? DbInstanceType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-dbinstancetype

DbParameterGroupIdentifier

The name or id of the DB parameter group to assign to your DB instance.

public string? DbParameterGroupIdentifier { get; set; }

Property Value

string

Remarks

DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-dbparametergroupidentifier

DbStorageType

The Timestream for InfluxDB DB storage type to read and write InfluxDB data.

public string? DbStorageType { get; set; }

Property Value

string

Remarks

You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-dbstoragetype

DeploymentType

Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

public string? DeploymentType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-deploymenttype

LogDeliveryConfiguration

Configuration for sending InfluxDB engine logs to a specified S3 bucket.

public object? LogDeliveryConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-logdeliveryconfiguration

Type union: either IResolvable or CfnInfluxDBInstancePropsMixin.ILogDeliveryConfigurationProperty

Name

The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

public string? Name { get; set; }

Property Value

string

Remarks

This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-name

NetworkType

Network type of the InfluxDB Instance.

public string? NetworkType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-networktype

Organization

The name of the initial organization for the initial admin user in InfluxDB.

public string? Organization { get; set; }

Property Value

string

Remarks

An InfluxDB organization is a workspace for a group of users.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-organization

Password

The password of the initial admin user created in InfluxDB.

public string? Password { get; set; }

Property Value

string

Remarks

This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon SecretManager in your account.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-password

Port

The port number on which InfluxDB accepts connections.

public double? Port { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-port

PubliclyAccessible

Configures the DB instance with a public IP to facilitate access.

public object? PubliclyAccessible { get; set; }

Property Value

object

Remarks

Default: - false

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-publiclyaccessible

Type union: either bool or IResolvable

Username

The username of the initial admin user created in InfluxDB.

public string? Username { get; set; }

Property Value

string

Remarks

Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-username

VpcSecurityGroupIds

A list of VPC security group IDs to associate with the DB instance.

public string[]? VpcSecurityGroupIds { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-vpcsecuritygroupids

VpcSubnetIds

A list of VPC subnet IDs to associate with the DB instance.

public string[]? VpcSubnetIds { get; set; }

Property Value

string[]

Remarks

Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-vpcsubnetids

Implements

ICfnInfluxDBInstanceMixinProps