AWS v7.7.0, Sep 5 25

AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi

aws.timestreaminfluxdb.DbCluster

Explore with Pulumi AI

AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.timestreaminfluxdb.DbCluster("example", {
    allocatedStorage: 20,
    bucket: "example-bucket-name",
    dbInstanceType: "db.influx.medium",
    failoverMode: "AUTOMATIC",
    username: "admin",
    password: "example-password",
    port: 8086,
    organization: "organization",
    vpcSubnetIds: [
        example1.id,
        example2.id,
    ],
    vpcSecurityGroupIds: [exampleAwsSecurityGroup.id],
    name: "example-db-cluster",
});

import pulumi
import pulumi_aws as aws

example = aws.timestreaminfluxdb.DbCluster("example",
    allocated_storage=20,
    bucket="example-bucket-name",
    db_instance_type="db.influx.medium",
    failover_mode="AUTOMATIC",
    username="admin",
    password="example-password",
    port=8086,
    organization="organization",
    vpc_subnet_ids=[
        example1["id"],
        example2["id"],
    ],
    vpc_security_group_ids=[example_aws_security_group["id"]],
    name="example-db-cluster")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/timestreaminfluxdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := timestreaminfluxdb.NewDbCluster(ctx, "example", &timestreaminfluxdb.DbClusterArgs{
			AllocatedStorage: pulumi.Int(20),
			Bucket:           pulumi.String("example-bucket-name"),
			DbInstanceType:   pulumi.String("db.influx.medium"),
			FailoverMode:     pulumi.String("AUTOMATIC"),
			Username:         pulumi.String("admin"),
			Password:         pulumi.String("example-password"),
			Port:             pulumi.Int(8086),
			Organization:     pulumi.String("organization"),
			VpcSubnetIds: pulumi.StringArray{
				example1.Id,
				example2.Id,
			},
			VpcSecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			Name: pulumi.String("example-db-cluster"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.TimestreamInfluxDB.DbCluster("example", new()
    {
        AllocatedStorage = 20,
        Bucket = "example-bucket-name",
        DbInstanceType = "db.influx.medium",
        FailoverMode = "AUTOMATIC",
        Username = "admin",
        Password = "example-password",
        Port = 8086,
        Organization = "organization",
        VpcSubnetIds = new[]
        {
            example1.Id,
            example2.Id,
        },
        VpcSecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        Name = "example-db-cluster",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.timestreaminfluxdb.DbCluster;
import com.pulumi.aws.timestreaminfluxdb.DbClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DbCluster("example", DbClusterArgs.builder()
            .allocatedStorage(20)
            .bucket("example-bucket-name")
            .dbInstanceType("db.influx.medium")
            .failoverMode("AUTOMATIC")
            .username("admin")
            .password("example-password")
            .port(8086)
            .organization("organization")
            .vpcSubnetIds(            
                example1.id(),
                example2.id())
            .vpcSecurityGroupIds(exampleAwsSecurityGroup.id())
            .name("example-db-cluster")
            .build());

    }
}

resources:
  example:
    type: aws:timestreaminfluxdb:DbCluster
    properties:
      allocatedStorage: 20
      bucket: example-bucket-name
      dbInstanceType: db.influx.medium
      failoverMode: AUTOMATIC
      username: admin
      password: example-password
      port: 8086
      organization: organization
      vpcSubnetIds:
        - ${example1.id}
        - ${example2.id}
      vpcSecurityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      name: example-db-cluster

Usage with Prerequisite Resources

All Timestream for InfluxDB clusters require a VPC, at least two subnets, and a security group. The following example shows how these prerequisite resources can be created and used with aws.timestreaminfluxdb.DbCluster.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2.Vpc("example", {cidrBlock: "10.0.0.0/16"});
const example1 = new aws.ec2.Subnet("example_1", {
    vpcId: example.id,
    cidrBlock: "10.0.1.0/24",
});
const example2 = new aws.ec2.Subnet("example_2", {
    vpcId: example.id,
    cidrBlock: "10.0.2.0/24",
});
const exampleSecurityGroup = new aws.ec2.SecurityGroup("example", {
    name: "example",
    vpcId: example.id,
});
const exampleDbCluster = new aws.timestreaminfluxdb.DbCluster("example", {
    allocatedStorage: 20,
    bucket: "example-bucket-name",
    dbInstanceType: "db.influx.medium",
    username: "admin",
    password: "example-password",
    organization: "organization",
    vpcSubnetIds: [
        example1.id,
        example2.id,
    ],
    vpcSecurityGroupIds: [exampleSecurityGroup.id],
    name: "example-db-cluster",
});

import pulumi
import pulumi_aws as aws

example = aws.ec2.Vpc("example", cidr_block="10.0.0.0/16")
example1 = aws.ec2.Subnet("example_1",
    vpc_id=example.id,
    cidr_block="10.0.1.0/24")
example2 = aws.ec2.Subnet("example_2",
    vpc_id=example.id,
    cidr_block="10.0.2.0/24")
example_security_group = aws.ec2.SecurityGroup("example",
    name="example",
    vpc_id=example.id)
example_db_cluster = aws.timestreaminfluxdb.DbCluster("example",
    allocated_storage=20,
    bucket="example-bucket-name",
    db_instance_type="db.influx.medium",
    username="admin",
    password="example-password",
    organization="organization",
    vpc_subnet_ids=[
        example1.id,
        example2.id,
    ],
    vpc_security_group_ids=[example_security_group.id],
    name="example-db-cluster")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/timestreaminfluxdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ec2.NewVpc(ctx, "example", &ec2.VpcArgs{
			CidrBlock: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		example1, err := ec2.NewSubnet(ctx, "example_1", &ec2.SubnetArgs{
			VpcId:     example.ID(),
			CidrBlock: pulumi.String("10.0.1.0/24"),
		})
		if err != nil {
			return err
		}
		example2, err := ec2.NewSubnet(ctx, "example_2", &ec2.SubnetArgs{
			VpcId:     example.ID(),
			CidrBlock: pulumi.String("10.0.2.0/24"),
		})
		if err != nil {
			return err
		}
		exampleSecurityGroup, err := ec2.NewSecurityGroup(ctx, "example", &ec2.SecurityGroupArgs{
			Name:  pulumi.String("example"),
			VpcId: example.ID(),
		})
		if err != nil {
			return err
		}
		_, err = timestreaminfluxdb.NewDbCluster(ctx, "example", &timestreaminfluxdb.DbClusterArgs{
			AllocatedStorage: pulumi.Int(20),
			Bucket:           pulumi.String("example-bucket-name"),
			DbInstanceType:   pulumi.String("db.influx.medium"),
			Username:         pulumi.String("admin"),
			Password:         pulumi.String("example-password"),
			Organization:     pulumi.String("organization"),
			VpcSubnetIds: pulumi.StringArray{
				example1.ID(),
				example2.ID(),
			},
			VpcSecurityGroupIds: pulumi.StringArray{
				exampleSecurityGroup.ID(),
			},
			Name: pulumi.String("example-db-cluster"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ec2.Vpc("example", new()
    {
        CidrBlock = "10.0.0.0/16",
    });

    var example1 = new Aws.Ec2.Subnet("example_1", new()
    {
        VpcId = example.Id,
        CidrBlock = "10.0.1.0/24",
    });

    var example2 = new Aws.Ec2.Subnet("example_2", new()
    {
        VpcId = example.Id,
        CidrBlock = "10.0.2.0/24",
    });

    var exampleSecurityGroup = new Aws.Ec2.SecurityGroup("example", new()
    {
        Name = "example",
        VpcId = example.Id,
    });

    var exampleDbCluster = new Aws.TimestreamInfluxDB.DbCluster("example", new()
    {
        AllocatedStorage = 20,
        Bucket = "example-bucket-name",
        DbInstanceType = "db.influx.medium",
        Username = "admin",
        Password = "example-password",
        Organization = "organization",
        VpcSubnetIds = new[]
        {
            example1.Id,
            example2.Id,
        },
        VpcSecurityGroupIds = new[]
        {
            exampleSecurityGroup.Id,
        },
        Name = "example-db-cluster",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import com.pulumi.aws.ec2.Subnet;
import com.pulumi.aws.ec2.SubnetArgs;
import com.pulumi.aws.ec2.SecurityGroup;
import com.pulumi.aws.ec2.SecurityGroupArgs;
import com.pulumi.aws.timestreaminfluxdb.DbCluster;
import com.pulumi.aws.timestreaminfluxdb.DbClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Vpc("example", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .build());

        var example1 = new Subnet("example1", SubnetArgs.builder()
            .vpcId(example.id())
            .cidrBlock("10.0.1.0/24")
            .build());

        var example2 = new Subnet("example2", SubnetArgs.builder()
            .vpcId(example.id())
            .cidrBlock("10.0.2.0/24")
            .build());

        var exampleSecurityGroup = new SecurityGroup("exampleSecurityGroup", SecurityGroupArgs.builder()
            .name("example")
            .vpcId(example.id())
            .build());

        var exampleDbCluster = new DbCluster("exampleDbCluster", DbClusterArgs.builder()
            .allocatedStorage(20)
            .bucket("example-bucket-name")
            .dbInstanceType("db.influx.medium")
            .username("admin")
            .password("example-password")
            .organization("organization")
            .vpcSubnetIds(            
                example1.id(),
                example2.id())
            .vpcSecurityGroupIds(exampleSecurityGroup.id())
            .name("example-db-cluster")
            .build());

    }
}

resources:
  example:
    type: aws:ec2:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
  example1:
    type: aws:ec2:Subnet
    name: example_1
    properties:
      vpcId: ${example.id}
      cidrBlock: 10.0.1.0/24
  example2:
    type: aws:ec2:Subnet
    name: example_2
    properties:
      vpcId: ${example.id}
      cidrBlock: 10.0.2.0/24
  exampleSecurityGroup:
    type: aws:ec2:SecurityGroup
    name: example
    properties:
      name: example
      vpcId: ${example.id}
  exampleDbCluster:
    type: aws:timestreaminfluxdb:DbCluster
    name: example
    properties:
      allocatedStorage: 20
      bucket: example-bucket-name
      dbInstanceType: db.influx.medium
      username: admin
      password: example-password
      organization: organization
      vpcSubnetIds:
        - ${example1.id}
        - ${example2.id}
      vpcSecurityGroupIds:
        - ${exampleSecurityGroup.id}
      name: example-db-cluster

Usage with S3 Log Delivery Enabled

You can use an S3 bucket to store logs generated by your Timestream for InfluxDB cluster. The following example shows what resources and arguments are required to configure an S3 bucket for logging, including the IAM policy that needs to be set in order to allow Timestream for InfluxDB to place logs in your S3 bucket. The configuration of the required VPC, security group, and subnets have been left out of the example for brevity.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleBucket = new aws.s3.Bucket("example", {
    bucket: "example-s3-bucket",
    forceDestroy: true,
});
const example = aws.iam.getPolicyDocumentOutput({
    statements: [{
        actions: ["s3:PutObject"],
        principals: [{
            type: "Service",
            identifiers: ["timestream-influxdb.amazonaws.com"],
        }],
        resources: [pulumi.interpolate`${exampleBucket.arn}/*`],
    }],
});
const exampleBucketPolicy = new aws.s3.BucketPolicy("example", {
    bucket: exampleBucket.id,
    policy: example.apply(example => example.json),
});
const exampleDbCluster = new aws.timestreaminfluxdb.DbCluster("example", {
    allocatedStorage: 20,
    bucket: "example-bucket-name",
    dbInstanceType: "db.influx.medium",
    username: "admin",
    password: "example-password",
    organization: "organization",
    vpcSubnetIds: [
        example1.id,
        example2.id,
    ],
    vpcSecurityGroupIds: [exampleAwsSecurityGroup.id],
    name: "example-db-cluster",
    logDeliveryConfiguration: {
        s3Configuration: {
            bucketName: exampleBucket.bucket,
            enabled: true,
        },
    },
});

import pulumi
import pulumi_aws as aws

example_bucket = aws.s3.Bucket("example",
    bucket="example-s3-bucket",
    force_destroy=True)
example = aws.iam.get_policy_document_output(statements=[{
    "actions": ["s3:PutObject"],
    "principals": [{
        "type": "Service",
        "identifiers": ["timestream-influxdb.amazonaws.com"],
    }],
    "resources": [example_bucket.arn.apply(lambda arn: f"{arn}/*")],
}])
example_bucket_policy = aws.s3.BucketPolicy("example",
    bucket=example_bucket.id,
    policy=example.json)
example_db_cluster = aws.timestreaminfluxdb.DbCluster("example",
    allocated_storage=20,
    bucket="example-bucket-name",
    db_instance_type="db.influx.medium",
    username="admin",
    password="example-password",
    organization="organization",
    vpc_subnet_ids=[
        example1["id"],
        example2["id"],
    ],
    vpc_security_group_ids=[example_aws_security_group["id"]],
    name="example-db-cluster",
    log_delivery_configuration={
        "s3_configuration": {
            "bucket_name": example_bucket.bucket,
            "enabled": True,
        },
    })

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/timestreaminfluxdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleBucket, err := s3.NewBucket(ctx, "example", &s3.BucketArgs{
			Bucket:       pulumi.String("example-s3-bucket"),
			ForceDestroy: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		example := iam.GetPolicyDocumentOutput(ctx, iam.GetPolicyDocumentOutputArgs{
			Statements: iam.GetPolicyDocumentStatementArray{
				&iam.GetPolicyDocumentStatementArgs{
					Actions: pulumi.StringArray{
						pulumi.String("s3:PutObject"),
					},
					Principals: iam.GetPolicyDocumentStatementPrincipalArray{
						&iam.GetPolicyDocumentStatementPrincipalArgs{
							Type: pulumi.String("Service"),
							Identifiers: pulumi.StringArray{
								pulumi.String("timestream-influxdb.amazonaws.com"),
							},
						},
					},
					Resources: pulumi.StringArray{
						exampleBucket.Arn.ApplyT(func(arn string) (string, error) {
							return fmt.Sprintf("%v/*", arn), nil
						}).(pulumi.StringOutput),
					},
				},
			},
		}, nil)
		_, err = s3.NewBucketPolicy(ctx, "example", &s3.BucketPolicyArgs{
			Bucket: exampleBucket.ID(),
			Policy: pulumi.String(example.ApplyT(func(example iam.GetPolicyDocumentResult) (*string, error) {
				return &example.Json, nil
			}).(pulumi.StringPtrOutput)),
		})
		if err != nil {
			return err
		}
		_, err = timestreaminfluxdb.NewDbCluster(ctx, "example", &timestreaminfluxdb.DbClusterArgs{
			AllocatedStorage: pulumi.Int(20),
			Bucket:           pulumi.String("example-bucket-name"),
			DbInstanceType:   pulumi.String("db.influx.medium"),
			Username:         pulumi.String("admin"),
			Password:         pulumi.String("example-password"),
			Organization:     pulumi.String("organization"),
			VpcSubnetIds: pulumi.StringArray{
				example1.Id,
				example2.Id,
			},
			VpcSecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			Name: pulumi.String("example-db-cluster"),
			LogDeliveryConfiguration: &timestreaminfluxdb.DbClusterLogDeliveryConfigurationArgs{
				S3Configuration: &timestreaminfluxdb.DbClusterLogDeliveryConfigurationS3ConfigurationArgs{
					BucketName: exampleBucket.Bucket,
					Enabled:    pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleBucket = new Aws.S3.Bucket("example", new()
    {
        BucketName = "example-s3-bucket",
        ForceDestroy = true,
    });

    var example = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Actions = new[]
                {
                    "s3:PutObject",
                },
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "Service",
                        Identifiers = new[]
                        {
                            "timestream-influxdb.amazonaws.com",
                        },
                    },
                },
                Resources = new[]
                {
                    $"{exampleBucket.Arn}/*",
                },
            },
        },
    });

    var exampleBucketPolicy = new Aws.S3.BucketPolicy("example", new()
    {
        Bucket = exampleBucket.Id,
        Policy = example.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
    });

    var exampleDbCluster = new Aws.TimestreamInfluxDB.DbCluster("example", new()
    {
        AllocatedStorage = 20,
        Bucket = "example-bucket-name",
        DbInstanceType = "db.influx.medium",
        Username = "admin",
        Password = "example-password",
        Organization = "organization",
        VpcSubnetIds = new[]
        {
            example1.Id,
            example2.Id,
        },
        VpcSecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        Name = "example-db-cluster",
        LogDeliveryConfiguration = new Aws.TimestreamInfluxDB.Inputs.DbClusterLogDeliveryConfigurationArgs
        {
            S3Configuration = new Aws.TimestreamInfluxDB.Inputs.DbClusterLogDeliveryConfigurationS3ConfigurationArgs
            {
                BucketName = exampleBucket.BucketName,
                Enabled = true,
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.Bucket;
import com.pulumi.aws.s3.BucketArgs;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.s3.BucketPolicy;
import com.pulumi.aws.s3.BucketPolicyArgs;
import com.pulumi.aws.timestreaminfluxdb.DbCluster;
import com.pulumi.aws.timestreaminfluxdb.DbClusterArgs;
import com.pulumi.aws.timestreaminfluxdb.inputs.DbClusterLogDeliveryConfigurationArgs;
import com.pulumi.aws.timestreaminfluxdb.inputs.DbClusterLogDeliveryConfigurationS3ConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleBucket = new Bucket("exampleBucket", BucketArgs.builder()
            .bucket("example-s3-bucket")
            .forceDestroy(true)
            .build());

        final var example = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .actions("s3:PutObject")
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .type("Service")
                    .identifiers("timestream-influxdb.amazonaws.com")
                    .build())
                .resources(exampleBucket.arn().applyValue(_arn -> String.format("%s/*", _arn)))
                .build())
            .build());

        var exampleBucketPolicy = new BucketPolicy("exampleBucketPolicy", BucketPolicyArgs.builder()
            .bucket(exampleBucket.id())
            .policy(example.applyValue(_example -> _example.json()))
            .build());

        var exampleDbCluster = new DbCluster("exampleDbCluster", DbClusterArgs.builder()
            .allocatedStorage(20)
            .bucket("example-bucket-name")
            .dbInstanceType("db.influx.medium")
            .username("admin")
            .password("example-password")
            .organization("organization")
            .vpcSubnetIds(            
                example1.id(),
                example2.id())
            .vpcSecurityGroupIds(exampleAwsSecurityGroup.id())
            .name("example-db-cluster")
            .logDeliveryConfiguration(DbClusterLogDeliveryConfigurationArgs.builder()
                .s3Configuration(DbClusterLogDeliveryConfigurationS3ConfigurationArgs.builder()
                    .bucketName(exampleBucket.bucket())
                    .enabled(true)
                    .build())
                .build())
            .build());

    }
}

resources:
  exampleBucket:
    type: aws:s3:Bucket
    name: example
    properties:
      bucket: example-s3-bucket
      forceDestroy: true
  exampleBucketPolicy:
    type: aws:s3:BucketPolicy
    name: example
    properties:
      bucket: ${exampleBucket.id}
      policy: ${example.json}
  exampleDbCluster:
    type: aws:timestreaminfluxdb:DbCluster
    name: example
    properties:
      allocatedStorage: 20
      bucket: example-bucket-name
      dbInstanceType: db.influx.medium
      username: admin
      password: example-password
      organization: organization
      vpcSubnetIds:
        - ${example1.id}
        - ${example2.id}
      vpcSecurityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      name: example-db-cluster
      logDeliveryConfiguration:
        s3Configuration:
          bucketName: ${exampleBucket.bucket}
          enabled: true
variables:
  example:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - actions:
              - s3:PutObject
            principals:
              - type: Service
                identifiers:
                  - timestream-influxdb.amazonaws.com
            resources:
              - ${exampleBucket.arn}/*

Create DbCluster Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DbCluster(name: string, args: DbClusterArgs, opts?: CustomResourceOptions);

@overload
def DbCluster(resource_name: str,
              args: DbClusterArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def DbCluster(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              organization: Optional[str] = None,
              bucket: Optional[str] = None,
              db_instance_type: Optional[str] = None,
              vpc_subnet_ids: Optional[Sequence[str]] = None,
              vpc_security_group_ids: Optional[Sequence[str]] = None,
              allocated_storage: Optional[int] = None,
              username: Optional[str] = None,
              password: Optional[str] = None,
              deployment_type: Optional[str] = None,
              network_type: Optional[str] = None,
              name: Optional[str] = None,
              log_delivery_configuration: Optional[DbClusterLogDeliveryConfigurationArgs] = None,
              port: Optional[int] = None,
              publicly_accessible: Optional[bool] = None,
              region: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              timeouts: Optional[DbClusterTimeoutsArgs] = None,
              failover_mode: Optional[str] = None,
              db_storage_type: Optional[str] = None,
              db_parameter_group_identifier: Optional[str] = None)

func NewDbCluster(ctx *Context, name string, args DbClusterArgs, opts ...ResourceOption) (*DbCluster, error)

public DbCluster(string name, DbClusterArgs args, CustomResourceOptions? opts = null)

public DbCluster(String name, DbClusterArgs args)
public DbCluster(String name, DbClusterArgs args, CustomResourceOptions options)

type: aws:timestreaminfluxdb:DbCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args DbClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DbClusterArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DbClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DbClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DbClusterArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var dbClusterResource = new Aws.TimestreamInfluxDB.DbCluster("dbClusterResource", new()
{
    Organization = "string",
    Bucket = "string",
    DbInstanceType = "string",
    VpcSubnetIds = new[]
    {
        "string",
    },
    VpcSecurityGroupIds = new[]
    {
        "string",
    },
    AllocatedStorage = 0,
    Username = "string",
    Password = "string",
    DeploymentType = "string",
    NetworkType = "string",
    Name = "string",
    LogDeliveryConfiguration = new Aws.TimestreamInfluxDB.Inputs.DbClusterLogDeliveryConfigurationArgs
    {
        S3Configuration = new Aws.TimestreamInfluxDB.Inputs.DbClusterLogDeliveryConfigurationS3ConfigurationArgs
        {
            BucketName = "string",
            Enabled = false,
        },
    },
    Port = 0,
    PubliclyAccessible = false,
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.TimestreamInfluxDB.Inputs.DbClusterTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    FailoverMode = "string",
    DbStorageType = "string",
    DbParameterGroupIdentifier = "string",
});

example, err := timestreaminfluxdb.NewDbCluster(ctx, "dbClusterResource", &timestreaminfluxdb.DbClusterArgs{
	Organization:   pulumi.String("string"),
	Bucket:         pulumi.String("string"),
	DbInstanceType: pulumi.String("string"),
	VpcSubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	VpcSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllocatedStorage: pulumi.Int(0),
	Username:         pulumi.String("string"),
	Password:         pulumi.String("string"),
	DeploymentType:   pulumi.String("string"),
	NetworkType:      pulumi.String("string"),
	Name:             pulumi.String("string"),
	LogDeliveryConfiguration: &timestreaminfluxdb.DbClusterLogDeliveryConfigurationArgs{
		S3Configuration: &timestreaminfluxdb.DbClusterLogDeliveryConfigurationS3ConfigurationArgs{
			BucketName: pulumi.String("string"),
			Enabled:    pulumi.Bool(false),
		},
	},
	Port:               pulumi.Int(0),
	PubliclyAccessible: pulumi.Bool(false),
	Region:             pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &timestreaminfluxdb.DbClusterTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	FailoverMode:               pulumi.String("string"),
	DbStorageType:              pulumi.String("string"),
	DbParameterGroupIdentifier: pulumi.String("string"),
})

var dbClusterResource = new DbCluster("dbClusterResource", DbClusterArgs.builder()
    .organization("string")
    .bucket("string")
    .dbInstanceType("string")
    .vpcSubnetIds("string")
    .vpcSecurityGroupIds("string")
    .allocatedStorage(0)
    .username("string")
    .password("string")
    .deploymentType("string")
    .networkType("string")
    .name("string")
    .logDeliveryConfiguration(DbClusterLogDeliveryConfigurationArgs.builder()
        .s3Configuration(DbClusterLogDeliveryConfigurationS3ConfigurationArgs.builder()
            .bucketName("string")
            .enabled(false)
            .build())
        .build())
    .port(0)
    .publiclyAccessible(false)
    .region("string")
    .tags(Map.of("string", "string"))
    .timeouts(DbClusterTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .failoverMode("string")
    .dbStorageType("string")
    .dbParameterGroupIdentifier("string")
    .build());

db_cluster_resource = aws.timestreaminfluxdb.DbCluster("dbClusterResource",
    organization="string",
    bucket="string",
    db_instance_type="string",
    vpc_subnet_ids=["string"],
    vpc_security_group_ids=["string"],
    allocated_storage=0,
    username="string",
    password="string",
    deployment_type="string",
    network_type="string",
    name="string",
    log_delivery_configuration={
        "s3_configuration": {
            "bucket_name": "string",
            "enabled": False,
        },
    },
    port=0,
    publicly_accessible=False,
    region="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    failover_mode="string",
    db_storage_type="string",
    db_parameter_group_identifier="string")

const dbClusterResource = new aws.timestreaminfluxdb.DbCluster("dbClusterResource", {
    organization: "string",
    bucket: "string",
    dbInstanceType: "string",
    vpcSubnetIds: ["string"],
    vpcSecurityGroupIds: ["string"],
    allocatedStorage: 0,
    username: "string",
    password: "string",
    deploymentType: "string",
    networkType: "string",
    name: "string",
    logDeliveryConfiguration: {
        s3Configuration: {
            bucketName: "string",
            enabled: false,
        },
    },
    port: 0,
    publiclyAccessible: false,
    region: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    failoverMode: "string",
    dbStorageType: "string",
    dbParameterGroupIdentifier: "string",
});

type: aws:timestreaminfluxdb:DbCluster
properties:
    allocatedStorage: 0
    bucket: string
    dbInstanceType: string
    dbParameterGroupIdentifier: string
    dbStorageType: string
    deploymentType: string
    failoverMode: string
    logDeliveryConfiguration:
        s3Configuration:
            bucketName: string
            enabled: false
    name: string
    networkType: string
    organization: string
    password: string
    port: 0
    publiclyAccessible: false
    region: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string
    username: string
    vpcSecurityGroupIds:
        - string
    vpcSubnetIds:
        - string

DbCluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DbCluster resource accepts the following input properties:

AllocatedStorage int

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384. The argument db_storage_type places restrictions on this argument's minimum value. The following is a list of db_storage_type values and the corresponding minimum value for allocated_storage: "InfluxIOIncludedT1": 20, "InfluxIOIncludedT2" and "InfluxIOIncludedT3": 400`.

Bucket string

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. Along with organization, username, and password, this argument will be stored in the secret referred to by the influx_auth_parameters_secret_arn attribute.

DbInstanceType string

Timestream for InfluxDB DB instance type to run InfluxDB on. Valid options are: "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", and "db.influx.16xlarge". This argument is updatable.

Organization string

Name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Along with bucket, username, and password, this argument will be stored in the secret referred to by the influx_auth_parameters_secret_arn attribute.

Password string

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. Along with bucket, username, and organization, this argument will be stored in the secret referred to by the influx_auth_parameters_secret_arn attribute.

Username string

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. 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. Along with bucket, organization, and password, this argument will be stored in the secret referred to by the influx_auth_parameters_secret_arn attribute.

VpcSecurityGroupIds List<string>

List of VPC security group IDs to associate with the cluster.

VpcSubnetIds List<string>

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

DbParameterGroupIdentifier string

ID of the DB parameter group assigned to your cluster. This argument is updatable. If added to an existing Timestream for InfluxDB cluster or given a new value, will cause an in-place update to the cluster. However, if a cluster already has a value for db_parameter_group_identifier, removing db_parameter_group_identifier will cause the cluster to be destroyed and recreated.

DbStorageType string

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. Valid options are: "InfluxIOIncludedT1", "InfluxIOIncludedT2", and "InfluxIOIncludedT3". If you use "InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for allocated_storage` is 400.

DeploymentType string

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

FailoverMode string

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

LogDeliveryConfiguration DbClusterLogDeliveryConfiguration

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

Name string

Name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. Cluster names must be unique per customer and per region. The argument must start with a letter, cannot contain consecutive hyphens (-) and cannot end with a hyphen.

NetworkType string

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

Port int

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

PubliclyAccessible bool

Configures the DB cluster with a public IP to facilitate access. Other resources, such as a VPC, a subnet, an internet gateway, and a route table with routes, are also required to enabled public access, in addition to this argument. See "Usage with Public Internet Access Enabled" for an example configuration with all required resources for public internet access.

Region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Tags Dictionary<string, string>

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Timeouts DbClusterTimeouts

AllocatedStorage int

Bucket string

DbInstanceType string

Organization string

Password string

Username string

VpcSecurityGroupIds []string

List of VPC security group IDs to associate with the cluster.

VpcSubnetIds []string

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

DbParameterGroupIdentifier string

DbStorageType string

DeploymentType string

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

FailoverMode string

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

LogDeliveryConfiguration DbClusterLogDeliveryConfigurationArgs

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

Name string

NetworkType string

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

Port int

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

PubliclyAccessible bool

Region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Tags map[string]string

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Timeouts DbClusterTimeoutsArgs

allocatedStorage Integer

bucket String

dbInstanceType String

organization String

password String

username String

vpcSecurityGroupIds List<String>

List of VPC security group IDs to associate with the cluster.

vpcSubnetIds List<String>

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

dbParameterGroupIdentifier String

dbStorageType String

deploymentType String

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

failoverMode String

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

logDeliveryConfiguration DbClusterLogDeliveryConfiguration

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

name String

networkType String

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

port Integer

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

publiclyAccessible Boolean

region String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

tags Map<String,String>

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timeouts DbClusterTimeouts

allocatedStorage number

bucket string

dbInstanceType string

organization string

password string

username string

vpcSecurityGroupIds string[]

List of VPC security group IDs to associate with the cluster.

vpcSubnetIds string[]

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

dbParameterGroupIdentifier string

dbStorageType string

deploymentType string

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

failoverMode string

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

logDeliveryConfiguration DbClusterLogDeliveryConfiguration

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

name string

networkType string

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

port number

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

publiclyAccessible boolean

region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

tags {[key: string]: string}

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timeouts DbClusterTimeouts

allocated_storage int

bucket str

db_instance_type str

organization str

password str

username str

vpc_security_group_ids Sequence[str]

List of VPC security group IDs to associate with the cluster.

vpc_subnet_ids Sequence[str]

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

db_parameter_group_identifier str

db_storage_type str

deployment_type str

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

failover_mode str

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

log_delivery_configuration DbClusterLogDeliveryConfigurationArgs

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

name str

network_type str

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

port int

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

publicly_accessible bool

region str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

tags Mapping[str, str]

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timeouts DbClusterTimeoutsArgs

allocatedStorage Number

bucket String

dbInstanceType String

organization String

password String

username String

vpcSecurityGroupIds List<String>

List of VPC security group IDs to associate with the cluster.

vpcSubnetIds List<String>

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

dbParameterGroupIdentifier String

dbStorageType String

deploymentType String

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

failoverMode String

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

logDeliveryConfiguration Property Map

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

name String

networkType String

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

port Number

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

publiclyAccessible Boolean

region String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

tags Map<String>

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timeouts Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the DbCluster resource produces the following output properties:

Arn string: ARN of the Timestream for InfluxDB cluster.
Endpoint string: Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
Id string: The provider-assigned unique ID for this managed resource.
InfluxAuthParametersSecretArn string: ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
ReaderEndpoint string: The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
TagsAll Dictionary<string, string>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: ARN of the Timestream for InfluxDB cluster.
Endpoint string: Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
Id string: The provider-assigned unique ID for this managed resource.
InfluxAuthParametersSecretArn string: ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
ReaderEndpoint string: The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
TagsAll map[string]string: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: ARN of the Timestream for InfluxDB cluster.
endpoint String: Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
id String: The provider-assigned unique ID for this managed resource.
influxAuthParametersSecretArn String: ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
readerEndpoint String: The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
tagsAll Map<String,String>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: ARN of the Timestream for InfluxDB cluster.
endpoint string: Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
id string: The provider-assigned unique ID for this managed resource.
influxAuthParametersSecretArn string: ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
readerEndpoint string: The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
tagsAll {[key: string]: string}: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: ARN of the Timestream for InfluxDB cluster.
endpoint str: Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
id str: The provider-assigned unique ID for this managed resource.
influx_auth_parameters_secret_arn str: ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
reader_endpoint str: The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
tags_all Mapping[str, str]: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: ARN of the Timestream for InfluxDB cluster.
endpoint String: Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
id String: The provider-assigned unique ID for this managed resource.
influxAuthParametersSecretArn String: ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
readerEndpoint String: The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
tagsAll Map<String>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing DbCluster Resource

Get an existing DbCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DbClusterState, opts?: CustomResourceOptions): DbCluster

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocated_storage: Optional[int] = None,
        arn: Optional[str] = None,
        bucket: Optional[str] = None,
        db_instance_type: Optional[str] = None,
        db_parameter_group_identifier: Optional[str] = None,
        db_storage_type: Optional[str] = None,
        deployment_type: Optional[str] = None,
        endpoint: Optional[str] = None,
        failover_mode: Optional[str] = None,
        influx_auth_parameters_secret_arn: Optional[str] = None,
        log_delivery_configuration: Optional[DbClusterLogDeliveryConfigurationArgs] = None,
        name: Optional[str] = None,
        network_type: Optional[str] = None,
        organization: Optional[str] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        publicly_accessible: Optional[bool] = None,
        reader_endpoint: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[DbClusterTimeoutsArgs] = None,
        username: Optional[str] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None,
        vpc_subnet_ids: Optional[Sequence[str]] = None) -> DbCluster

func GetDbCluster(ctx *Context, name string, id IDInput, state *DbClusterState, opts ...ResourceOption) (*DbCluster, error)

public static DbCluster Get(string name, Input<string> id, DbClusterState? state, CustomResourceOptions? opts = null)

public static DbCluster get(String name, Output<String> id, DbClusterState state, CustomResourceOptions options)

resources:  _:    type: aws:timestreaminfluxdb:DbCluster    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllocatedStorage int

Arn string

ARN of the Timestream for InfluxDB cluster.

Bucket string

DbInstanceType string

DbParameterGroupIdentifier string

DbStorageType string

DeploymentType string

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

Endpoint string

Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

FailoverMode string

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

InfluxAuthParametersSecretArn string

ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

LogDeliveryConfiguration DbClusterLogDeliveryConfiguration

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

Name string

NetworkType string

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

Organization string

Password string

Port int

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

PubliclyAccessible bool

ReaderEndpoint string

The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

Region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Tags Dictionary<string, string>

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Timeouts DbClusterTimeouts

Username string

VpcSecurityGroupIds List<string>

List of VPC security group IDs to associate with the cluster.

VpcSubnetIds List<string>

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

AllocatedStorage int

Arn string

ARN of the Timestream for InfluxDB cluster.

Bucket string

DbInstanceType string

DbParameterGroupIdentifier string

DbStorageType string

DeploymentType string

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

Endpoint string

Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

FailoverMode string

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

InfluxAuthParametersSecretArn string

LogDeliveryConfiguration DbClusterLogDeliveryConfigurationArgs

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

Name string

NetworkType string

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

Organization string

Password string

Port int

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

PubliclyAccessible bool

ReaderEndpoint string

The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

Region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Tags map[string]string

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Timeouts DbClusterTimeoutsArgs

Username string

VpcSecurityGroupIds []string

List of VPC security group IDs to associate with the cluster.

VpcSubnetIds []string

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

allocatedStorage Integer

arn String

ARN of the Timestream for InfluxDB cluster.

bucket String

dbInstanceType String

dbParameterGroupIdentifier String

dbStorageType String

deploymentType String

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

endpoint String

Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

failoverMode String

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

influxAuthParametersSecretArn String

logDeliveryConfiguration DbClusterLogDeliveryConfiguration

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

name String

networkType String

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

organization String

password String

port Integer

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

publiclyAccessible Boolean

readerEndpoint String

The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

region String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

tags Map<String,String>

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timeouts DbClusterTimeouts

username String

vpcSecurityGroupIds List<String>

List of VPC security group IDs to associate with the cluster.

vpcSubnetIds List<String>

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

allocatedStorage number

arn string

ARN of the Timestream for InfluxDB cluster.

bucket string

dbInstanceType string

dbParameterGroupIdentifier string

dbStorageType string

deploymentType string

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

endpoint string

Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

failoverMode string

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

influxAuthParametersSecretArn string

logDeliveryConfiguration DbClusterLogDeliveryConfiguration

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

name string

networkType string

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

organization string

password string

port number

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

publiclyAccessible boolean

readerEndpoint string

The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

tags {[key: string]: string}

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timeouts DbClusterTimeouts

username string

vpcSecurityGroupIds string[]

List of VPC security group IDs to associate with the cluster.

vpcSubnetIds string[]

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

allocated_storage int

arn str

ARN of the Timestream for InfluxDB cluster.

bucket str

db_instance_type str

db_parameter_group_identifier str

db_storage_type str

deployment_type str

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

endpoint str

Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

failover_mode str

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

influx_auth_parameters_secret_arn str

log_delivery_configuration DbClusterLogDeliveryConfigurationArgs

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

name str

network_type str

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

organization str

password str

port int

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

publicly_accessible bool

reader_endpoint str

The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

region str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

tags Mapping[str, str]

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timeouts DbClusterTimeoutsArgs

username str

vpc_security_group_ids Sequence[str]

List of VPC security group IDs to associate with the cluster.

vpc_subnet_ids Sequence[str]

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

allocatedStorage Number

arn String

ARN of the Timestream for InfluxDB cluster.

bucket String

dbInstanceType String

dbParameterGroupIdentifier String

dbStorageType String

deploymentType String

Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS".

endpoint String

Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

failoverMode String

Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".

influxAuthParametersSecretArn String

logDeliveryConfiguration Property Map

Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

name String

networkType String

Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

organization String

password String

port Number

The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.

publiclyAccessible Boolean

readerEndpoint String

The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

region String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

tags Map<String>

Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timeouts Property Map

username String

vpcSecurityGroupIds List<String>

List of VPC security group IDs to associate with the cluster.

vpcSubnetIds List<String>

List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

The following arguments are optional:

Supporting Types

DbClusterLogDeliveryConfiguration, DbClusterLogDeliveryConfigurationArgs

S3Configuration DbClusterLogDeliveryConfigurationS3Configuration: Configuration for S3 bucket log delivery.

S3Configuration DbClusterLogDeliveryConfigurationS3Configuration: Configuration for S3 bucket log delivery.

s3Configuration DbClusterLogDeliveryConfigurationS3Configuration: Configuration for S3 bucket log delivery.

s3Configuration DbClusterLogDeliveryConfigurationS3Configuration: Configuration for S3 bucket log delivery.

s3_configuration DbClusterLogDeliveryConfigurationS3Configuration: Configuration for S3 bucket log delivery.

s3Configuration Property Map: Configuration for S3 bucket log delivery.

DbClusterLogDeliveryConfigurationS3Configuration, DbClusterLogDeliveryConfigurationS3ConfigurationArgs

BucketName string

Name of the S3 bucket to deliver logs to.

Enabled bool

Indicates whether log delivery to the S3 bucket is enabled.

Note: The following arguments do updates in-place: db_parameter_group_identifier, log_delivery_configuration, port, db_instance_type, failover_mode, and tags. Changes to any other argument after a cluster has been deployed will cause destruction and re-creation of the cluster. Additionally, when db_parameter_group_identifier is added to a cluster or modified, the cluster will be updated in-place but if db_parameter_group_identifier is removed from a cluster, the cluster will be destroyed and re-created.

BucketName string

Name of the S3 bucket to deliver logs to.

Enabled bool

Indicates whether log delivery to the S3 bucket is enabled.

bucketName String

Name of the S3 bucket to deliver logs to.

enabled Boolean

Indicates whether log delivery to the S3 bucket is enabled.

bucketName string

Name of the S3 bucket to deliver logs to.

enabled boolean

Indicates whether log delivery to the S3 bucket is enabled.

bucket_name str

Name of the S3 bucket to deliver logs to.

enabled bool

Indicates whether log delivery to the S3 bucket is enabled.

bucketName String

Name of the S3 bucket to deliver logs to.

enabled Boolean

Indicates whether log delivery to the S3 bucket is enabled.

DbClusterTimeouts, DbClusterTimeoutsArgs

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

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

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

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

create str: 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 str: 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 str: 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).

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

Import

Using pulumi import, import Timestream for InfluxDB cluster using its identifier. For example:

$ pulumi import aws:timestreaminfluxdb/dbCluster:DbCluster example 12345abcde

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi

pulumi/pulumi-aws

aws.timestreaminfluxdb.DbCluster

On this page

On this page

Example Usage

Basic Usage

Usage with Prerequisite Resources

Usage with S3 Log Delivery Enabled

Create DbCluster Resource

Constructor syntax

Parameters

Constructor example

DbCluster Resource Properties

Inputs

Outputs

Look up Existing DbCluster Resource

Supporting Types

DbClusterLogDeliveryConfiguration, DbClusterLogDeliveryConfigurationArgs

DbClusterLogDeliveryConfigurationS3Configuration, DbClusterLogDeliveryConfigurationS3ConfigurationArgs

DbClusterTimeouts, DbClusterTimeoutsArgs

Import

Package Details

On this page

On this page