Skip to content

Latest commit

 

History

History
2983 lines (1847 loc) · 144 KB

timestreaminfluxdbDbInstance.csharp.md

File metadata and controls

2983 lines (1847 loc) · 144 KB

timestreaminfluxdbDbInstance Submodule

Constructs

TimestreaminfluxdbDbInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance aws_timestreaminfluxdb_db_instance}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new TimestreaminfluxdbDbInstance(Construct Scope, string Id, TimestreaminfluxdbDbInstanceConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config TimestreaminfluxdbDbInstanceConfig No description.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutLogDeliveryConfiguration No description.
PutTimeouts No description.
ResetDbParameterGroupIdentifier No description.
ResetDbStorageType No description.
ResetDeploymentType No description.
ResetLogDeliveryConfiguration No description.
ResetPubliclyAccessible No description.
ResetTags No description.
ResetTimeouts No description.

ToString
private string ToString()

Returns a string representation of this construct.

AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

MoveFromId
private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


MoveTo
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


IndexOptional
  • Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


MoveToId
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


PutLogDeliveryConfiguration
private void PutLogDeliveryConfiguration(object Value)
ValueRequired
  • Type: object

PutTimeouts
private void PutTimeouts(TimestreaminfluxdbDbInstanceTimeouts Value)
ValueRequired

ResetDbParameterGroupIdentifier
private void ResetDbParameterGroupIdentifier()
ResetDbStorageType
private void ResetDbStorageType()
ResetDeploymentType
private void ResetDeploymentType()
ResetLogDeliveryConfiguration
private void ResetLogDeliveryConfiguration()
ResetPubliclyAccessible
private void ResetPubliclyAccessible()
ResetTags
private void ResetTags()
ResetTimeouts
private void ResetTimeouts()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a TimestreaminfluxdbDbInstance resource upon running "cdktf plan ".

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

TimestreaminfluxdbDbInstance.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

XRequired
  • Type: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Aws;

TimestreaminfluxdbDbInstance.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using HashiCorp.Cdktf.Providers.Aws;

TimestreaminfluxdbDbInstance.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

TimestreaminfluxdbDbInstance.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a TimestreaminfluxdbDbInstance resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


ImportToIdRequired
  • Type: string

The construct id used in the generated config for the TimestreaminfluxdbDbInstance to import.


ImportFromIdRequired
  • Type: string

The id of the existing TimestreaminfluxdbDbInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#import import section} in the documentation of this resource for the id to use


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the TimestreaminfluxdbDbInstance to import is found.


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Arn string No description.
AvailabilityZone string No description.
Endpoint string No description.
Id string No description.
InfluxAuthParametersSecretArn string No description.
LogDeliveryConfiguration TimestreaminfluxdbDbInstanceLogDeliveryConfigurationList No description.
SecondaryAvailabilityZone string No description.
TagsAll HashiCorp.Cdktf.StringMap No description.
Timeouts TimestreaminfluxdbDbInstanceTimeoutsOutputReference No description.
AllocatedStorageInput double No description.
BucketInput string No description.
DbInstanceTypeInput string No description.
DbParameterGroupIdentifierInput string No description.
DbStorageTypeInput string No description.
DeploymentTypeInput string No description.
LogDeliveryConfigurationInput object No description.
NameInput string No description.
OrganizationInput string No description.
PasswordInput string No description.
PubliclyAccessibleInput object No description.
TagsInput System.Collections.Generic.IDictionary<string, string> No description.
TimeoutsInput object No description.
UsernameInput string No description.
VpcSecurityGroupIdsInput string[] No description.
VpcSubnetIdsInput string[] No description.
AllocatedStorage double No description.
Bucket string No description.
DbInstanceType string No description.
DbParameterGroupIdentifier string No description.
DbStorageType string No description.
DeploymentType string No description.
Name string No description.
Organization string No description.
Password string No description.
PubliclyAccessible object No description.
Tags System.Collections.Generic.IDictionary<string, string> No description.
Username string No description.
VpcSecurityGroupIds string[] No description.
VpcSubnetIds string[] No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

TerraformMetaArgumentsRequired
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
public object Connection { get; }
  • Type: object

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; }
  • Type: object[]

ArnRequired
public string Arn { get; }
  • Type: string

AvailabilityZoneRequired
public string AvailabilityZone { get; }
  • Type: string

EndpointRequired
public string Endpoint { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

InfluxAuthParametersSecretArnRequired
public string InfluxAuthParametersSecretArn { get; }
  • Type: string

LogDeliveryConfigurationRequired
public TimestreaminfluxdbDbInstanceLogDeliveryConfigurationList LogDeliveryConfiguration { get; }

SecondaryAvailabilityZoneRequired
public string SecondaryAvailabilityZone { get; }
  • Type: string

TagsAllRequired
public StringMap TagsAll { get; }
  • Type: HashiCorp.Cdktf.StringMap

TimeoutsRequired
public TimestreaminfluxdbDbInstanceTimeoutsOutputReference Timeouts { get; }

AllocatedStorageInputOptional
public double AllocatedStorageInput { get; }
  • Type: double

BucketInputOptional
public string BucketInput { get; }
  • Type: string

DbInstanceTypeInputOptional
public string DbInstanceTypeInput { get; }
  • Type: string

DbParameterGroupIdentifierInputOptional
public string DbParameterGroupIdentifierInput { get; }
  • Type: string

DbStorageTypeInputOptional
public string DbStorageTypeInput { get; }
  • Type: string

DeploymentTypeInputOptional
public string DeploymentTypeInput { get; }
  • Type: string

LogDeliveryConfigurationInputOptional
public object LogDeliveryConfigurationInput { get; }
  • Type: object

NameInputOptional
public string NameInput { get; }
  • Type: string

OrganizationInputOptional
public string OrganizationInput { get; }
  • Type: string

PasswordInputOptional
public string PasswordInput { get; }
  • Type: string

PubliclyAccessibleInputOptional
public object PubliclyAccessibleInput { get; }
  • Type: object

TagsInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TimeoutsInputOptional
public object TimeoutsInput { get; }
  • Type: object

UsernameInputOptional
public string UsernameInput { get; }
  • Type: string

VpcSecurityGroupIdsInputOptional
public string[] VpcSecurityGroupIdsInput { get; }
  • Type: string[]

VpcSubnetIdsInputOptional
public string[] VpcSubnetIdsInput { get; }
  • Type: string[]

AllocatedStorageRequired
public double AllocatedStorage { get; }
  • Type: double

BucketRequired
public string Bucket { get; }
  • Type: string

DbInstanceTypeRequired
public string DbInstanceType { get; }
  • Type: string

DbParameterGroupIdentifierRequired
public string DbParameterGroupIdentifier { get; }
  • Type: string

DbStorageTypeRequired
public string DbStorageType { get; }
  • Type: string

DeploymentTypeRequired
public string DeploymentType { get; }
  • Type: string

NameRequired
public string Name { get; }
  • Type: string

OrganizationRequired
public string Organization { get; }
  • Type: string

PasswordRequired
public string Password { get; }
  • Type: string

PubliclyAccessibleRequired
public object PubliclyAccessible { get; }
  • Type: object

TagsRequired
public System.Collections.Generic.IDictionary<string, string> Tags { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

UsernameRequired
public string Username { get; }
  • Type: string

VpcSecurityGroupIdsRequired
public string[] VpcSecurityGroupIds { get; }
  • Type: string[]

VpcSubnetIdsRequired
public string[] VpcSubnetIds { get; }
  • Type: string[]

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

TimestreaminfluxdbDbInstanceConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new TimestreaminfluxdbDbInstanceConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    double AllocatedStorage,
    string Bucket,
    string DbInstanceType,
    string Name,
    string Organization,
    string Password,
    string Username,
    string[] VpcSecurityGroupIds,
    string[] VpcSubnetIds,
    string DbParameterGroupIdentifier = null,
    string DbStorageType = null,
    string DeploymentType = null,
    object LogDeliveryConfiguration = null,
    object PubliclyAccessible = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    TimestreaminfluxdbDbInstanceTimeouts Timeouts = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
AllocatedStorage double The amount of storage to allocate for your DB storage type in GiB (gibibytes).
Bucket string The name of the initial InfluxDB bucket.
DbInstanceType string The Timestream for InfluxDB DB instance type to run InfluxDB on.
Name string The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
Organization string The name of the initial organization for the initial admin user in InfluxDB.
Password string The password of the initial admin user created in InfluxDB.
Username string The username of the initial admin user created in InfluxDB.
VpcSecurityGroupIds string[] A list of VPC security group IDs to associate with the DB instance.
VpcSubnetIds string[] A list of VPC subnet IDs to associate with the DB instance.
DbParameterGroupIdentifier string The id of the DB parameter group assigned to your DB instance.
DbStorageType string The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
DeploymentType string Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
LogDeliveryConfiguration object log_delivery_configuration block.
PubliclyAccessible object Configures the DB instance with a public IP to facilitate access.
Tags System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#tags TimestreaminfluxdbDbInstance#tags}.
Timeouts TimestreaminfluxdbDbInstanceTimeouts timeouts block.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

AllocatedStorageRequired
public double AllocatedStorage { get; set; }
  • Type: double

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#allocated_storage TimestreaminfluxdbDbInstance#allocated_storage}


BucketRequired
public string Bucket { get; set; }
  • Type: string

The name of the initial InfluxDB bucket.

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#bucket TimestreaminfluxdbDbInstance#bucket}


DbInstanceTypeRequired
public string DbInstanceType { get; set; }
  • Type: string

The Timestream for InfluxDB DB instance type to run InfluxDB on.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#db_instance_type TimestreaminfluxdbDbInstance#db_instance_type}


NameRequired
public string Name { get; set; }
  • Type: string

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#name TimestreaminfluxdbDbInstance#name}


OrganizationRequired
public string Organization { get; set; }
  • Type: string

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#organization TimestreaminfluxdbDbInstance#organization}


PasswordRequired
public string Password { get; set; }
  • Type: string

The password of the initial admin user created in InfluxDB.

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 AWS SecretManager in your account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#password TimestreaminfluxdbDbInstance#password}


UsernameRequired
public string Username { get; set; }
  • Type: string

The username of the initial admin user created in InfluxDB.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#username TimestreaminfluxdbDbInstance#username}


VpcSecurityGroupIdsRequired
public string[] VpcSecurityGroupIds { get; set; }
  • Type: string[]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#vpc_security_group_ids TimestreaminfluxdbDbInstance#vpc_security_group_ids}


VpcSubnetIdsRequired
public string[] VpcSubnetIds { get; set; }
  • Type: string[]

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#vpc_subnet_ids TimestreaminfluxdbDbInstance#vpc_subnet_ids}


DbParameterGroupIdentifierOptional
public string DbParameterGroupIdentifier { get; set; }
  • Type: string

The id of the DB parameter group assigned to your DB instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#db_parameter_group_identifier TimestreaminfluxdbDbInstance#db_parameter_group_identifier}


DbStorageTypeOptional
public string DbStorageType { get; set; }
  • Type: string

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

You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements: Influx IO Included 3000 IOPS, Influx IO Included 12000 IOPS, Influx IO Included 16000 IOPS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#db_storage_type TimestreaminfluxdbDbInstance#db_storage_type}


DeploymentTypeOptional
public string DeploymentType { get; set; }
  • Type: string

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#deployment_type TimestreaminfluxdbDbInstance#deployment_type}


LogDeliveryConfigurationOptional
public object LogDeliveryConfiguration { get; set; }
  • Type: object

log_delivery_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#log_delivery_configuration TimestreaminfluxdbDbInstance#log_delivery_configuration}


PubliclyAccessibleOptional
public object PubliclyAccessible { get; set; }
  • Type: object

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#publicly_accessible TimestreaminfluxdbDbInstance#publicly_accessible}


TagsOptional
public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#tags TimestreaminfluxdbDbInstance#tags}.


TimeoutsOptional
public TimestreaminfluxdbDbInstanceTimeouts Timeouts { get; set; }

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#timeouts TimestreaminfluxdbDbInstance#timeouts}


TimestreaminfluxdbDbInstanceLogDeliveryConfiguration

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new TimestreaminfluxdbDbInstanceLogDeliveryConfiguration {
    object S3Configuration = null
};

Properties

Name Type Description
S3Configuration object s3_configuration block.

S3ConfigurationOptional
public object S3Configuration { get; set; }
  • Type: object

s3_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#s3_configuration TimestreaminfluxdbDbInstance#s3_configuration}


TimestreaminfluxdbDbInstanceLogDeliveryConfigurationS3Configuration

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new TimestreaminfluxdbDbInstanceLogDeliveryConfigurationS3Configuration {
    string BucketName,
    object Enabled
};

Properties

Name Type Description
BucketName string The name of the S3 bucket to deliver logs to.
Enabled object Indicates whether log delivery to the S3 bucket is enabled.

BucketNameRequired
public string BucketName { get; set; }
  • Type: string

The name of the S3 bucket to deliver logs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#bucket_name TimestreaminfluxdbDbInstance#bucket_name}


EnabledRequired
public object Enabled { get; set; }
  • Type: object

Indicates whether log delivery to the S3 bucket is enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#enabled TimestreaminfluxdbDbInstance#enabled}


TimestreaminfluxdbDbInstanceTimeouts

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new TimestreaminfluxdbDbInstanceTimeouts {
    string Create = null,
    string Delete = null,
    string Update = null
};

Properties

Name Type Description
Create string A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Delete string A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Update string A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

CreateOptional
public string Create { get; set; }
  • Type: string

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#create TimestreaminfluxdbDbInstance#create}


DeleteOptional
public string Delete { get; set; }
  • Type: string

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#delete TimestreaminfluxdbDbInstance#delete}


UpdateOptional
public string Update { get; set; }
  • Type: string

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/timestreaminfluxdb_db_instance#update TimestreaminfluxdbDbInstance#update}


Classes

TimestreaminfluxdbDbInstanceLogDeliveryConfigurationList

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new TimestreaminfluxdbDbInstanceLogDeliveryConfigurationList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


WrapsSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
AllWithMapKey Creating an iterator for this complex list.
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.

AllWithMapKey
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

MapKeyAttributeNameRequired
  • Type: string

ComputeFqn
private string ComputeFqn()
Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get
private TimestreaminfluxdbDbInstanceLogDeliveryConfigurationOutputReference Get(double Index)
IndexRequired
  • Type: double

the index of the item to return.


Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


FqnRequired
public string Fqn { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object

TimestreaminfluxdbDbInstanceLogDeliveryConfigurationOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new TimestreaminfluxdbDbInstanceLogDeliveryConfigurationOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.


ComplexObjectIsFromSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
PutS3Configuration No description.
ResetS3Configuration No description.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

PutS3Configuration
private void PutS3Configuration(object Value)
ValueRequired
  • Type: object

ResetS3Configuration
private void ResetS3Configuration()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
S3Configuration TimestreaminfluxdbDbInstanceLogDeliveryConfigurationS3ConfigurationList No description.
S3ConfigurationInput object No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


FqnRequired
public string Fqn { get; }
  • Type: string

S3ConfigurationRequired
public TimestreaminfluxdbDbInstanceLogDeliveryConfigurationS3ConfigurationList S3Configuration { get; }

S3ConfigurationInputOptional
public object S3ConfigurationInput { get; }
  • Type: object

InternalValueOptional
public object InternalValue { get; }
  • Type: object

TimestreaminfluxdbDbInstanceLogDeliveryConfigurationS3ConfigurationList

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new TimestreaminfluxdbDbInstanceLogDeliveryConfigurationS3ConfigurationList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


WrapsSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
AllWithMapKey Creating an iterator for this complex list.
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.

AllWithMapKey
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

MapKeyAttributeNameRequired
  • Type: string

ComputeFqn
private string ComputeFqn()
Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get
private TimestreaminfluxdbDbInstanceLogDeliveryConfigurationS3ConfigurationOutputReference Get(double Index)
IndexRequired
  • Type: double

the index of the item to return.


Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


FqnRequired
public string Fqn { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object

TimestreaminfluxdbDbInstanceLogDeliveryConfigurationS3ConfigurationOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new TimestreaminfluxdbDbInstanceLogDeliveryConfigurationS3ConfigurationOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.


ComplexObjectIsFromSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
BucketNameInput string No description.
EnabledInput object No description.
BucketName string No description.
Enabled object No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


FqnRequired
public string Fqn { get; }
  • Type: string

BucketNameInputOptional
public string BucketNameInput { get; }
  • Type: string

EnabledInputOptional
public object EnabledInput { get; }
  • Type: object

BucketNameRequired
public string BucketName { get; }
  • Type: string

EnabledRequired
public object Enabled { get; }
  • Type: object

InternalValueOptional
public object InternalValue { get; }
  • Type: object

TimestreaminfluxdbDbInstanceTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new TimestreaminfluxdbDbInstanceTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetCreate No description.
ResetDelete No description.
ResetUpdate No description.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate
private void ResetCreate()
ResetDelete
private void ResetDelete()
ResetUpdate
private void ResetUpdate()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
CreateInput string No description.
DeleteInput string No description.
UpdateInput string No description.
Create string No description.
Delete string No description.
Update string No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


FqnRequired
public string Fqn { get; }
  • Type: string

CreateInputOptional
public string CreateInput { get; }
  • Type: string

DeleteInputOptional
public string DeleteInput { get; }
  • Type: string

UpdateInputOptional
public string UpdateInput { get; }
  • Type: string

CreateRequired
public string Create { get; }
  • Type: string

DeleteRequired
public string Delete { get; }
  • Type: string

UpdateRequired
public string Update { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object