AWS v6.60.0, Nov 19 24

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.timestreaminfluxdb.DbInstance

Explore with Pulumi AI

AWS v6.60.0 published on Tuesday, Nov 19, 2024 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.DbInstance("example", {
    allocatedStorage: 20,
    bucket: "example-bucket-name",
    dbInstanceType: "db.influx.medium",
    username: "admin",
    password: "example-password",
    organization: "organization",
    vpcSubnetIds: [exampleid],
    vpcSecurityGroupIds: [exampleAwsSecurityGroup.id],
    name: "example-db-instance",
});

import pulumi
import pulumi_aws as aws

example = aws.timestreaminfluxdb.DbInstance("example",
    allocated_storage=20,
    bucket="example-bucket-name",
    db_instance_type="db.influx.medium",
    username="admin",
    password="example-password",
    organization="organization",
    vpc_subnet_ids=[exampleid],
    vpc_security_group_ids=[example_aws_security_group["id"]],
    name="example-db-instance")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := timestreaminfluxdb.NewDbInstance(ctx, "example", &timestreaminfluxdb.DbInstanceArgs{
			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{
				exampleid,
			},
			VpcSecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			Name: pulumi.String("example-db-instance"),
		})
		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.DbInstance("example", new()
    {
        AllocatedStorage = 20,
        Bucket = "example-bucket-name",
        DbInstanceType = "db.influx.medium",
        Username = "admin",
        Password = "example-password",
        Organization = "organization",
        VpcSubnetIds = new[]
        {
            exampleid,
        },
        VpcSecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        Name = "example-db-instance",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.timestreaminfluxdb.DbInstance;
import com.pulumi.aws.timestreaminfluxdb.DbInstanceArgs;
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 DbInstance("example", DbInstanceArgs.builder()
            .allocatedStorage(20)
            .bucket("example-bucket-name")
            .dbInstanceType("db.influx.medium")
            .username("admin")
            .password("example-password")
            .organization("organization")
            .vpcSubnetIds(exampleid)
            .vpcSecurityGroupIds(exampleAwsSecurityGroup.id())
            .name("example-db-instance")
            .build());

    }
}

resources:
  example:
    type: aws:timestreaminfluxdb:DbInstance
    properties:
      allocatedStorage: 20
      bucket: example-bucket-name
      dbInstanceType: db.influx.medium
      username: admin
      password: example-password
      organization: organization
      vpcSubnetIds:
        - ${exampleid}
      vpcSecurityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      name: example-db-instance

Usage with Prerequisite Resources

All Timestream for InfluxDB instances require a VPC, subnet, and security group. The following example shows how these prerequisite resources can be created and used with aws.timestreaminfluxdb.DbInstance.

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 exampleSubnet = new aws.ec2.Subnet("example", {
    vpcId: example.id,
    cidrBlock: "10.0.1.0/24",
});
const exampleSecurityGroup = new aws.ec2.SecurityGroup("example", {
    name: "example",
    vpcId: example.id,
});
const exampleDbInstance = new aws.timestreaminfluxdb.DbInstance("example", {
    allocatedStorage: 20,
    bucket: "example-bucket-name",
    dbInstanceType: "db.influx.medium",
    username: "admin",
    password: "example-password",
    organization: "organization",
    vpcSubnetIds: [exampleSubnet.id],
    vpcSecurityGroupIds: [exampleSecurityGroup.id],
    name: "example-db-instance",
});

import pulumi
import pulumi_aws as aws

example = aws.ec2.Vpc("example", cidr_block="10.0.0.0/16")
example_subnet = aws.ec2.Subnet("example",
    vpc_id=example.id,
    cidr_block="10.0.1.0/24")
example_security_group = aws.ec2.SecurityGroup("example",
    name="example",
    vpc_id=example.id)
example_db_instance = aws.timestreaminfluxdb.DbInstance("example",
    allocated_storage=20,
    bucket="example-bucket-name",
    db_instance_type="db.influx.medium",
    username="admin",
    password="example-password",
    organization="organization",
    vpc_subnet_ids=[example_subnet.id],
    vpc_security_group_ids=[example_security_group.id],
    name="example-db-instance")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi-aws/sdk/v6/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
		}
		exampleSubnet, err := ec2.NewSubnet(ctx, "example", &ec2.SubnetArgs{
			VpcId:     example.ID(),
			CidrBlock: pulumi.String("10.0.1.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.NewDbInstance(ctx, "example", &timestreaminfluxdb.DbInstanceArgs{
			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{
				exampleSubnet.ID(),
			},
			VpcSecurityGroupIds: pulumi.StringArray{
				exampleSecurityGroup.ID(),
			},
			Name: pulumi.String("example-db-instance"),
		})
		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 exampleSubnet = new Aws.Ec2.Subnet("example", new()
    {
        VpcId = example.Id,
        CidrBlock = "10.0.1.0/24",
    });

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

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

});

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.DbInstance;
import com.pulumi.aws.timestreaminfluxdb.DbInstanceArgs;
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 exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .vpcId(example.id())
            .cidrBlock("10.0.1.0/24")
            .build());

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

        var exampleDbInstance = new DbInstance("exampleDbInstance", DbInstanceArgs.builder()
            .allocatedStorage(20)
            .bucket("example-bucket-name")
            .dbInstanceType("db.influx.medium")
            .username("admin")
            .password("example-password")
            .organization("organization")
            .vpcSubnetIds(exampleSubnet.id())
            .vpcSecurityGroupIds(exampleSecurityGroup.id())
            .name("example-db-instance")
            .build());

    }
}

resources:
  example:
    type: aws:ec2:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
  exampleSubnet:
    type: aws:ec2:Subnet
    name: example
    properties:
      vpcId: ${example.id}
      cidrBlock: 10.0.1.0/24
  exampleSecurityGroup:
    type: aws:ec2:SecurityGroup
    name: example
    properties:
      name: example
      vpcId: ${example.id}
  exampleDbInstance:
    type: aws:timestreaminfluxdb:DbInstance
    name: example
    properties:
      allocatedStorage: 20
      bucket: example-bucket-name
      dbInstanceType: db.influx.medium
      username: admin
      password: example-password
      organization: organization
      vpcSubnetIds:
        - ${exampleSubnet.id}
      vpcSecurityGroupIds:
        - ${exampleSecurityGroup.id}
      name: example-db-instance

Usage with S3 Log Delivery Enabled

You can use an S3 bucket to store logs generated by your Timestream for InfluxDB instance. 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 subnet have been left out of the example for brevity.

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

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

import pulumi
import pulumi_aws as aws

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

package main

import (
	"fmt"

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleBucketV2, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
			Bucket: pulumi.String("example-s3-bucket"),
		})
		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{
						exampleBucketV2.Arn.ApplyT(func(arn string) (string, error) {
							return fmt.Sprintf("%v/*", arn), nil
						}).(pulumi.StringOutput),
					},
				},
			},
		}, nil)
		_, err = s3.NewBucketPolicy(ctx, "example", &s3.BucketPolicyArgs{
			Bucket: exampleBucketV2.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.NewDbInstance(ctx, "example", &timestreaminfluxdb.DbInstanceArgs{
			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{
				exampleAwsSubnet.Id,
			},
			VpcSecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			Name: pulumi.String("example-db-instance"),
			LogDeliveryConfiguration: &timestreaminfluxdb.DbInstanceLogDeliveryConfigurationArgs{
				S3Configuration: &timestreaminfluxdb.DbInstanceLogDeliveryConfigurationS3ConfigurationArgs{
					BucketName: exampleBucketV2.Name,
					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 exampleBucketV2 = new Aws.S3.BucketV2("example", new()
    {
        Bucket = "example-s3-bucket",
    });

    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[]
                {
                    $"{exampleBucketV2.Arn}/*",
                },
            },
        },
    });

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

    var exampleDbInstance = new Aws.TimestreamInfluxDB.DbInstance("example", new()
    {
        AllocatedStorage = 20,
        Bucket = "example-bucket-name",
        DbInstanceType = "db.influx.medium",
        Username = "admin",
        Password = "example-password",
        Organization = "organization",
        VpcSubnetIds = new[]
        {
            exampleAwsSubnet.Id,
        },
        VpcSecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        Name = "example-db-instance",
        LogDeliveryConfiguration = new Aws.TimestreamInfluxDB.Inputs.DbInstanceLogDeliveryConfigurationArgs
        {
            S3Configuration = new Aws.TimestreamInfluxDB.Inputs.DbInstanceLogDeliveryConfigurationS3ConfigurationArgs
            {
                BucketName = exampleBucketV2.Name,
                Enabled = true,
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketV2;
import com.pulumi.aws.s3.BucketV2Args;
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.DbInstance;
import com.pulumi.aws.timestreaminfluxdb.DbInstanceArgs;
import com.pulumi.aws.timestreaminfluxdb.inputs.DbInstanceLogDeliveryConfigurationArgs;
import com.pulumi.aws.timestreaminfluxdb.inputs.DbInstanceLogDeliveryConfigurationS3ConfigurationArgs;
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 exampleBucketV2 = new BucketV2("exampleBucketV2", BucketV2Args.builder()
            .bucket("example-s3-bucket")
            .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(exampleBucketV2.arn().applyValue(arn -> String.format("%s/*", arn)))
                .build())
            .build());

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

        var exampleDbInstance = new DbInstance("exampleDbInstance", DbInstanceArgs.builder()
            .allocatedStorage(20)
            .bucket("example-bucket-name")
            .dbInstanceType("db.influx.medium")
            .username("admin")
            .password("example-password")
            .organization("organization")
            .vpcSubnetIds(exampleAwsSubnet.id())
            .vpcSecurityGroupIds(exampleAwsSecurityGroup.id())
            .name("example-db-instance")
            .logDeliveryConfiguration(DbInstanceLogDeliveryConfigurationArgs.builder()
                .s3Configuration(DbInstanceLogDeliveryConfigurationS3ConfigurationArgs.builder()
                    .bucketName(exampleBucketV2.name())
                    .enabled(true)
                    .build())
                .build())
            .build());

    }
}

resources:
  exampleBucketV2:
    type: aws:s3:BucketV2
    name: example
    properties:
      bucket: example-s3-bucket
  exampleBucketPolicy:
    type: aws:s3:BucketPolicy
    name: example
    properties:
      bucket: ${exampleBucketV2.id}
      policy: ${example.json}
  exampleDbInstance:
    type: aws:timestreaminfluxdb:DbInstance
    name: example
    properties:
      allocatedStorage: 20
      bucket: example-bucket-name
      dbInstanceType: db.influx.medium
      username: admin
      password: example-password
      organization: organization
      vpcSubnetIds:
        - ${exampleAwsSubnet.id}
      vpcSecurityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      name: example-db-instance
      logDeliveryConfiguration:
        s3Configuration:
          bucketName: ${exampleBucketV2.name}
          enabled: true
variables:
  example:
    fn::invoke:
      Function: aws:iam:getPolicyDocument
      Arguments:
        statements:
          - actions:
              - s3:PutObject
            principals:
              - type: Service
                identifiers:
                  - timestream-influxdb.amazonaws.com
            resources:
              - ${exampleBucketV2.arn}/*

Usage with MultiAZ Deployment

To use multi-region availability, at least two subnets must be created in different availability zones and used with your Timestream for InfluxDB instance.

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

const example1 = new aws.ec2.Subnet("example_1", {
    vpcId: exampleAwsVpc.id,
    cidrBlock: "10.0.1.0/24",
    availabilityZone: "us-west-2a",
});
const example2 = new aws.ec2.Subnet("example_2", {
    vpcId: exampleAwsVpc.id,
    cidrBlock: "10.0.2.0/24",
    availabilityZone: "us-west-2b",
});
const example = new aws.timestreaminfluxdb.DbInstance("example", {
    allocatedStorage: 20,
    bucket: "example-bucket-name",
    dbInstanceType: "db.influx.medium",
    deploymentType: "WITH_MULTIAZ_STANDBY",
    username: "admin",
    password: "example-password",
    organization: "organization",
    vpcSubnetIds: [
        example1.id,
        example2.id,
    ],
    vpcSecurityGroupIds: [exampleAwsSecurityGroup.id],
    name: "example-db-instance",
});

import pulumi
import pulumi_aws as aws

example1 = aws.ec2.Subnet("example_1",
    vpc_id=example_aws_vpc["id"],
    cidr_block="10.0.1.0/24",
    availability_zone="us-west-2a")
example2 = aws.ec2.Subnet("example_2",
    vpc_id=example_aws_vpc["id"],
    cidr_block="10.0.2.0/24",
    availability_zone="us-west-2b")
example = aws.timestreaminfluxdb.DbInstance("example",
    allocated_storage=20,
    bucket="example-bucket-name",
    db_instance_type="db.influx.medium",
    deployment_type="WITH_MULTIAZ_STANDBY",
    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-instance")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example1, err := ec2.NewSubnet(ctx, "example_1", &ec2.SubnetArgs{
			VpcId:            pulumi.Any(exampleAwsVpc.Id),
			CidrBlock:        pulumi.String("10.0.1.0/24"),
			AvailabilityZone: pulumi.String("us-west-2a"),
		})
		if err != nil {
			return err
		}
		example2, err := ec2.NewSubnet(ctx, "example_2", &ec2.SubnetArgs{
			VpcId:            pulumi.Any(exampleAwsVpc.Id),
			CidrBlock:        pulumi.String("10.0.2.0/24"),
			AvailabilityZone: pulumi.String("us-west-2b"),
		})
		if err != nil {
			return err
		}
		_, err = timestreaminfluxdb.NewDbInstance(ctx, "example", &timestreaminfluxdb.DbInstanceArgs{
			AllocatedStorage: pulumi.Int(20),
			Bucket:           pulumi.String("example-bucket-name"),
			DbInstanceType:   pulumi.String("db.influx.medium"),
			DeploymentType:   pulumi.String("WITH_MULTIAZ_STANDBY"),
			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-instance"),
		})
		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 example1 = new Aws.Ec2.Subnet("example_1", new()
    {
        VpcId = exampleAwsVpc.Id,
        CidrBlock = "10.0.1.0/24",
        AvailabilityZone = "us-west-2a",
    });

    var example2 = new Aws.Ec2.Subnet("example_2", new()
    {
        VpcId = exampleAwsVpc.Id,
        CidrBlock = "10.0.2.0/24",
        AvailabilityZone = "us-west-2b",
    });

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

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Subnet;
import com.pulumi.aws.ec2.SubnetArgs;
import com.pulumi.aws.timestreaminfluxdb.DbInstance;
import com.pulumi.aws.timestreaminfluxdb.DbInstanceArgs;
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 example1 = new Subnet("example1", SubnetArgs.builder()
            .vpcId(exampleAwsVpc.id())
            .cidrBlock("10.0.1.0/24")
            .availabilityZone("us-west-2a")
            .build());

        var example2 = new Subnet("example2", SubnetArgs.builder()
            .vpcId(exampleAwsVpc.id())
            .cidrBlock("10.0.2.0/24")
            .availabilityZone("us-west-2b")
            .build());

        var example = new DbInstance("example", DbInstanceArgs.builder()
            .allocatedStorage(20)
            .bucket("example-bucket-name")
            .dbInstanceType("db.influx.medium")
            .deploymentType("WITH_MULTIAZ_STANDBY")
            .username("admin")
            .password("example-password")
            .organization("organization")
            .vpcSubnetIds(            
                example1.id(),
                example2.id())
            .vpcSecurityGroupIds(exampleAwsSecurityGroup.id())
            .name("example-db-instance")
            .build());

    }
}

resources:
  example1:
    type: aws:ec2:Subnet
    name: example_1
    properties:
      vpcId: ${exampleAwsVpc.id}
      cidrBlock: 10.0.1.0/24
      availabilityZone: us-west-2a
  example2:
    type: aws:ec2:Subnet
    name: example_2
    properties:
      vpcId: ${exampleAwsVpc.id}
      cidrBlock: 10.0.2.0/24
      availabilityZone: us-west-2b
  example:
    type: aws:timestreaminfluxdb:DbInstance
    properties:
      allocatedStorage: 20
      bucket: example-bucket-name
      dbInstanceType: db.influx.medium
      deploymentType: WITH_MULTIAZ_STANDBY
      username: admin
      password: example-password
      organization: organization
      vpcSubnetIds:
        - ${example1.id}
        - ${example2.id}
      vpcSecurityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      name: example-db-instance

Create DbInstance Resource

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

Constructor syntax

new DbInstance(name: string, args: DbInstanceArgs, opts?: CustomResourceOptions);

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

@overload
def DbInstance(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,
               allocated_storage: Optional[int] = None,
               vpc_security_group_ids: Optional[Sequence[str]] = None,
               username: Optional[str] = None,
               password: Optional[str] = None,
               db_storage_type: Optional[str] = None,
               name: Optional[str] = None,
               publicly_accessible: Optional[bool] = None,
               tags: Optional[Mapping[str, str]] = None,
               timeouts: Optional[DbInstanceTimeoutsArgs] = None,
               log_delivery_configuration: Optional[DbInstanceLogDeliveryConfigurationArgs] = None,
               deployment_type: Optional[str] = None,
               db_parameter_group_identifier: Optional[str] = None)

func NewDbInstance(ctx *Context, name string, args DbInstanceArgs, opts ...ResourceOption) (*DbInstance, error)

public DbInstance(string name, DbInstanceArgs args, CustomResourceOptions? opts = null)

public DbInstance(String name, DbInstanceArgs args)
public DbInstance(String name, DbInstanceArgs args, CustomResourceOptions options)

type: aws:timestreaminfluxdb:DbInstance
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 DbInstanceArgs: 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 DbInstanceArgs: 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 DbInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args DbInstanceArgs: 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 dbInstanceResource = new Aws.TimestreamInfluxDB.DbInstance("dbInstanceResource", new()
{
    Organization = "string",
    Bucket = "string",
    DbInstanceType = "string",
    VpcSubnetIds = new[]
    {
        "string",
    },
    AllocatedStorage = 0,
    VpcSecurityGroupIds = new[]
    {
        "string",
    },
    Username = "string",
    Password = "string",
    DbStorageType = "string",
    Name = "string",
    PubliclyAccessible = false,
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.TimestreamInfluxDB.Inputs.DbInstanceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    LogDeliveryConfiguration = new Aws.TimestreamInfluxDB.Inputs.DbInstanceLogDeliveryConfigurationArgs
    {
        S3Configuration = new Aws.TimestreamInfluxDB.Inputs.DbInstanceLogDeliveryConfigurationS3ConfigurationArgs
        {
            BucketName = "string",
            Enabled = false,
        },
    },
    DeploymentType = "string",
    DbParameterGroupIdentifier = "string",
});

example, err := timestreaminfluxdb.NewDbInstance(ctx, "dbInstanceResource", &timestreaminfluxdb.DbInstanceArgs{
	Organization:   pulumi.String("string"),
	Bucket:         pulumi.String("string"),
	DbInstanceType: pulumi.String("string"),
	VpcSubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllocatedStorage: pulumi.Int(0),
	VpcSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Username:           pulumi.String("string"),
	Password:           pulumi.String("string"),
	DbStorageType:      pulumi.String("string"),
	Name:               pulumi.String("string"),
	PubliclyAccessible: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &timestreaminfluxdb.DbInstanceTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	LogDeliveryConfiguration: &timestreaminfluxdb.DbInstanceLogDeliveryConfigurationArgs{
		S3Configuration: &timestreaminfluxdb.DbInstanceLogDeliveryConfigurationS3ConfigurationArgs{
			BucketName: pulumi.String("string"),
			Enabled:    pulumi.Bool(false),
		},
	},
	DeploymentType:             pulumi.String("string"),
	DbParameterGroupIdentifier: pulumi.String("string"),
})

var dbInstanceResource = new DbInstance("dbInstanceResource", DbInstanceArgs.builder()
    .organization("string")
    .bucket("string")
    .dbInstanceType("string")
    .vpcSubnetIds("string")
    .allocatedStorage(0)
    .vpcSecurityGroupIds("string")
    .username("string")
    .password("string")
    .dbStorageType("string")
    .name("string")
    .publiclyAccessible(false)
    .tags(Map.of("string", "string"))
    .timeouts(DbInstanceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .logDeliveryConfiguration(DbInstanceLogDeliveryConfigurationArgs.builder()
        .s3Configuration(DbInstanceLogDeliveryConfigurationS3ConfigurationArgs.builder()
            .bucketName("string")
            .enabled(false)
            .build())
        .build())
    .deploymentType("string")
    .dbParameterGroupIdentifier("string")
    .build());

db_instance_resource = aws.timestreaminfluxdb.DbInstance("dbInstanceResource",
    organization="string",
    bucket="string",
    db_instance_type="string",
    vpc_subnet_ids=["string"],
    allocated_storage=0,
    vpc_security_group_ids=["string"],
    username="string",
    password="string",
    db_storage_type="string",
    name="string",
    publicly_accessible=False,
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    log_delivery_configuration={
        "s3_configuration": {
            "bucket_name": "string",
            "enabled": False,
        },
    },
    deployment_type="string",
    db_parameter_group_identifier="string")

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

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

DbInstance 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 DbInstance resource accepts the following input properties:

AllocatedStorage int

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

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

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 DB instance.

VpcSubnetIds List<string>

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.

The following arguments are optional:

DbParameterGroupIdentifier string

ID of the DB parameter group assigned to your DB instance. If added to an existing Timestream for InfluxDB instance or given a new value, will cause an in-place update to the instance. However, if an instance already has a value for db_parameter_group_identifier, removing db_parameter_group_identifier will cause the instance 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 "InfluxIOIncludedT1". If you use "InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for allocated_storage` is 400.

DeploymentType string

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

LogDeliveryConfiguration DbInstanceLogDeliveryConfiguration

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

Name string

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. The argument must start with a letter, cannot contain consecutive hyphens (-) and cannot end with a hyphen.

PubliclyAccessible bool

Configures the DB instance 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.

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 DbInstanceTimeouts

AllocatedStorage int

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

Bucket string

DbInstanceType string

Organization string

Password string

Username string

VpcSecurityGroupIds []string

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

VpcSubnetIds []string

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.

The following arguments are optional:

DbParameterGroupIdentifier string

DbStorageType string

DeploymentType string

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

LogDeliveryConfiguration DbInstanceLogDeliveryConfigurationArgs

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

Name string

PubliclyAccessible bool

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 DbInstanceTimeoutsArgs

allocatedStorage Integer

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

bucket String

dbInstanceType String

organization String

password String

username String

vpcSecurityGroupIds List<String>

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

vpcSubnetIds List<String>

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.

The following arguments are optional:

dbParameterGroupIdentifier String

dbStorageType String

deploymentType String

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

logDeliveryConfiguration DbInstanceLogDeliveryConfiguration

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

name String

publiclyAccessible Boolean

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 DbInstanceTimeouts

allocatedStorage number

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

bucket string

dbInstanceType string

organization string

password string

username string

vpcSecurityGroupIds string[]

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

vpcSubnetIds string[]

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.

The following arguments are optional:

dbParameterGroupIdentifier string

dbStorageType string

deploymentType string

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

logDeliveryConfiguration DbInstanceLogDeliveryConfiguration

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

name string

publiclyAccessible boolean

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 DbInstanceTimeouts

allocated_storage int

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

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 DB instance.

vpc_subnet_ids Sequence[str]

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.

The following arguments are optional:

db_parameter_group_identifier str

db_storage_type str

deployment_type str

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

log_delivery_configuration DbInstanceLogDeliveryConfigurationArgs

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

name str

publicly_accessible bool

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 DbInstanceTimeoutsArgs

allocatedStorage Number

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

bucket String

dbInstanceType String

organization String

password String

username String

vpcSecurityGroupIds List<String>

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

vpcSubnetIds List<String>

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.

The following arguments are optional:

dbParameterGroupIdentifier String

dbStorageType String

deploymentType String

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

logDeliveryConfiguration Property Map

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

name String

publiclyAccessible Boolean

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 DbInstance resource produces the following output properties:

Arn string: ARN of the Timestream for InfluxDB Instance.
AvailabilityZone string: Availability Zone in which the DB instance resides.
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. This secret will be read by the aws.timestreaminfluxdb.DbInstance resource in order to support importing: deleting the secret or secret values can cause errors.
SecondaryAvailabilityZone string: Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
TagsAll Dictionary<string, string>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

Arn string: ARN of the Timestream for InfluxDB Instance.
AvailabilityZone string: Availability Zone in which the DB instance resides.
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. This secret will be read by the aws.timestreaminfluxdb.DbInstance resource in order to support importing: deleting the secret or secret values can cause errors.
SecondaryAvailabilityZone string: Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
TagsAll map[string]string: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn String: ARN of the Timestream for InfluxDB Instance.
availabilityZone String: Availability Zone in which the DB instance resides.
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. This secret will be read by the aws.timestreaminfluxdb.DbInstance resource in order to support importing: deleting the secret or secret values can cause errors.
secondaryAvailabilityZone String: Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
tagsAll Map<String,String>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn string: ARN of the Timestream for InfluxDB Instance.
availabilityZone string: Availability Zone in which the DB instance resides.
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. This secret will be read by the aws.timestreaminfluxdb.DbInstance resource in order to support importing: deleting the secret or secret values can cause errors.
secondaryAvailabilityZone string: Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
tagsAll {[key: string]: string}: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn str: ARN of the Timestream for InfluxDB Instance.
availability_zone str: Availability Zone in which the DB instance resides.
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. This secret will be read by the aws.timestreaminfluxdb.DbInstance resource in order to support importing: deleting the secret or secret values can cause errors.
secondary_availability_zone str: Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
tags_all Mapping[str, str]: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn String: ARN of the Timestream for InfluxDB Instance.
availabilityZone String: Availability Zone in which the DB instance resides.
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. This secret will be read by the aws.timestreaminfluxdb.DbInstance resource in order to support importing: deleting the secret or secret values can cause errors.
secondaryAvailabilityZone String: Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
tagsAll Map<String>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

Look up Existing DbInstance Resource

Get an existing DbInstance 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?: DbInstanceState, opts?: CustomResourceOptions): DbInstance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocated_storage: Optional[int] = None,
        arn: Optional[str] = None,
        availability_zone: 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,
        influx_auth_parameters_secret_arn: Optional[str] = None,
        log_delivery_configuration: Optional[DbInstanceLogDeliveryConfigurationArgs] = None,
        name: Optional[str] = None,
        organization: Optional[str] = None,
        password: Optional[str] = None,
        publicly_accessible: Optional[bool] = None,
        secondary_availability_zone: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[DbInstanceTimeoutsArgs] = None,
        username: Optional[str] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None,
        vpc_subnet_ids: Optional[Sequence[str]] = None) -> DbInstance

func GetDbInstance(ctx *Context, name string, id IDInput, state *DbInstanceState, opts ...ResourceOption) (*DbInstance, error)

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

public static DbInstance get(String name, Output<String> id, DbInstanceState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

Arn string

ARN of the Timestream for InfluxDB Instance.

AvailabilityZone string

Availability Zone in which the DB instance resides.

Bucket string

DbInstanceType string

DbParameterGroupIdentifier string

DbStorageType string

DeploymentType string

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

Endpoint string

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

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. This secret will be read by the aws.timestreaminfluxdb.DbInstance resource in order to support importing: deleting the secret or secret values can cause errors.

LogDeliveryConfiguration DbInstanceLogDeliveryConfiguration

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

Name string

Organization string

Password string

PubliclyAccessible bool

SecondaryAvailabilityZone string

Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

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.

Deprecated: Please use tags instead.

Timeouts DbInstanceTimeouts

Username string

VpcSecurityGroupIds List<string>

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

VpcSubnetIds List<string>

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.

The following arguments are optional:

AllocatedStorage int

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

Arn string

ARN of the Timestream for InfluxDB Instance.

AvailabilityZone string

Availability Zone in which the DB instance resides.

Bucket string

DbInstanceType string

DbParameterGroupIdentifier string

DbStorageType string

DeploymentType string

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

Endpoint string

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

InfluxAuthParametersSecretArn string

LogDeliveryConfiguration DbInstanceLogDeliveryConfigurationArgs

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

Name string

Organization string

Password string

PubliclyAccessible bool

SecondaryAvailabilityZone string

Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

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.

Deprecated: Please use tags instead.

Timeouts DbInstanceTimeoutsArgs

Username string

VpcSecurityGroupIds []string

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

VpcSubnetIds []string

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.

The following arguments are optional:

allocatedStorage Integer

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

arn String

ARN of the Timestream for InfluxDB Instance.

availabilityZone String

Availability Zone in which the DB instance resides.

bucket String

dbInstanceType String

dbParameterGroupIdentifier String

dbStorageType String

deploymentType String

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

endpoint String

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

influxAuthParametersSecretArn String

logDeliveryConfiguration DbInstanceLogDeliveryConfiguration

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

name String

organization String

password String

publiclyAccessible Boolean

secondaryAvailabilityZone String

Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

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.

Deprecated: Please use tags instead.

timeouts DbInstanceTimeouts

username String

vpcSecurityGroupIds List<String>

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

vpcSubnetIds List<String>

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.

The following arguments are optional:

allocatedStorage number

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

arn string

ARN of the Timestream for InfluxDB Instance.

availabilityZone string

Availability Zone in which the DB instance resides.

bucket string

dbInstanceType string

dbParameterGroupIdentifier string

dbStorageType string

deploymentType string

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

endpoint string

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

influxAuthParametersSecretArn string

logDeliveryConfiguration DbInstanceLogDeliveryConfiguration

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

name string

organization string

password string

publiclyAccessible boolean

secondaryAvailabilityZone string

Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

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.

Deprecated: Please use tags instead.

timeouts DbInstanceTimeouts

username string

vpcSecurityGroupIds string[]

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

vpcSubnetIds string[]

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.

The following arguments are optional:

allocated_storage int

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

arn str

ARN of the Timestream for InfluxDB Instance.

availability_zone str

Availability Zone in which the DB instance resides.

bucket str

db_instance_type str

db_parameter_group_identifier str

db_storage_type str

deployment_type str

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

endpoint str

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

influx_auth_parameters_secret_arn str

log_delivery_configuration DbInstanceLogDeliveryConfigurationArgs

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

name str

organization str

password str

publicly_accessible bool

secondary_availability_zone str

Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

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.

Deprecated: Please use tags instead.

timeouts DbInstanceTimeoutsArgs

username str

vpc_security_group_ids Sequence[str]

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

vpc_subnet_ids Sequence[str]

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.

The following arguments are optional:

allocatedStorage Number

Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384.

arn String

ARN of the Timestream for InfluxDB Instance.

availabilityZone String

Availability Zone in which the DB instance resides.

bucket String

dbInstanceType String

dbParameterGroupIdentifier String

dbStorageType String

deploymentType String

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY".

endpoint String

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

influxAuthParametersSecretArn String

logDeliveryConfiguration Property Map

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

name String

organization String

password String

publiclyAccessible Boolean

secondaryAvailabilityZone String

Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

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.

Deprecated: Please use tags instead.

timeouts Property Map

username String

vpcSecurityGroupIds List<String>

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

vpcSubnetIds List<String>

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.

The following arguments are optional:

Supporting Types

DbInstanceLogDeliveryConfiguration, DbInstanceLogDeliveryConfigurationArgs

S3Configuration DbInstanceLogDeliveryConfigurationS3Configuration: Configuration for S3 bucket log delivery.

S3Configuration DbInstanceLogDeliveryConfigurationS3Configuration: Configuration for S3 bucket log delivery.

s3Configuration DbInstanceLogDeliveryConfigurationS3Configuration: Configuration for S3 bucket log delivery.

s3Configuration DbInstanceLogDeliveryConfigurationS3Configuration: Configuration for S3 bucket log delivery.

s3_configuration DbInstanceLogDeliveryConfigurationS3Configuration: Configuration for S3 bucket log delivery.

s3Configuration Property Map: Configuration for S3 bucket log delivery.

DbInstanceLogDeliveryConfigurationS3Configuration, DbInstanceLogDeliveryConfigurationS3ConfigurationArgs

BucketName string

Name of the S3 bucket to deliver logs to.

Enabled bool

Indicates whether log delivery to the S3 bucket is enabled.

Note: Only three arguments do updates in-place: db_parameter_group_identifier, log_delivery_configuration, and tags. Changes to any other argument after a DB instance has been deployed will cause destruction and re-creation of the DB instance. Additionally, when db_parameter_group_identifier is added to a DB instance or modified, the DB instance will be updated in-place but if db_parameter_group_identifier is removed from a DB instance, the DB instance 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.

DbInstanceTimeouts, DbInstanceTimeoutsArgs

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 Db Instance using its identifier. For example:

$ pulumi import aws:timestreaminfluxdb/dbInstance:DbInstance 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 v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

pulumi/pulumi-aws

aws.timestreaminfluxdb.DbInstance

On this page

On this page

Example Usage

Basic Usage

Usage with Prerequisite Resources

Usage with S3 Log Delivery Enabled

Usage with MultiAZ Deployment

Create DbInstance Resource

Constructor syntax

Parameters

Constructor example

DbInstance Resource Properties

Inputs

Outputs

Look up Existing DbInstance Resource

Supporting Types

DbInstanceLogDeliveryConfiguration, DbInstanceLogDeliveryConfigurationArgs

DbInstanceLogDeliveryConfigurationS3Configuration, DbInstanceLogDeliveryConfigurationS3ConfigurationArgs

DbInstanceTimeouts, DbInstanceTimeoutsArgs

Import

Package Details

On this page

On this page