AWS::Timestream::InfluxDBInstance

Timestream InfluxDBInstance

The AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.

Properties

17 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`AllocatedStorage`	`integer`
`Bucket`	`string`	Create-onlyWrite-only
`DbInstanceType`	`string`
`DbParameterGroupIdentifier`	`string`
`DbStorageType`	`string`
`DeploymentType`	`string`
`LogDeliveryConfiguration`	`object`
`Name`	`string`	Create-only
`NetworkType`	`string`	Create-only
`Organization`	`string`	Create-onlyWrite-only
`Password`	`string`	Create-onlyWrite-only
`Port`	`integer`
`PubliclyAccessible`	`boolean`	Create-only
`Tags`	`Array<Tag>`
`Username`	`string`	Create-onlyWrite-only
`VpcSecurityGroupIds`	`Array<string>`	Create-only
`VpcSubnetIds`	`Array<string>`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
`AvailabilityZone`	`string`	The Availability Zone (AZ) where the InfluxDB instance is created.
`Endpoint`	`string`	The connection endpoint for the InfluxDB instance.
`Id`	`string`	The service generated unique identifier for InfluxDB instance.
`InfluxAuthParametersSecretArn`	`string`	The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
`SecondaryAvailabilityZone`	`string`	The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
`Status`	`string`	Status of the InfluxDB Instance.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Timestream::InfluxDBInstance

Resources:
  MyResource:
    Type: AWS::Timestream::InfluxDBInstance
    Properties:
      Tags:
        - Key: Environment
          Value: Production
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

s3:ListBuckets3:GetBucketPolicytimestream-influxdb:GetDbInstancetimestream-influxdb:ListDbInstancestimestream-influxdb:CreateDbInstancetimestream-influxdb:TagResourcetimestream-influxdb:ListTagsForResourceec2:DescribeSubnets

read

timestream-influxdb:GetDbInstancetimestream-influxdb:ListTagsForResource

update

s3:ListBuckets3:GetBucketPolicytimestream-influxdb:GetDbInstancetimestream-influxdb:ListDbInstancestimestream-influxdb:UpdateDbInstancetimestream-influxdb:TagResourcetimestream-influxdb:UntagResourcetimestream-influxdb:ListTagsForResource

delete

timestream-influxdb:GetDbInstancetimestream-influxdb:ListDbInstancestimestream-influxdb:DeleteDbInstance

list

timestream-influxdb:ListDbInstances

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceTimestream

Properties24

Required0

TaggingSupported

Primary IDId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

NameUsernamePasswordOrganizationBucketVpcSubnetIdsVpcSecurityGroupIdsPubliclyAccessibleNetworkType

Related Resources

External Links

AWS Documentation