AWS::Timestream::InfluxDBCluster

Timestream InfluxDBCluster

The AWS::Timestream::InfluxDBCluster resource creates an InfluxDB cluster.

Properties

18 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`AllocatedStorage`	`integer`	Create-only
`Bucket`	`string`	Create-onlyWrite-only
`DbInstanceType`	`string`
`DbParameterGroupIdentifier`	`string`
`DbStorageType`	`string`	Create-only
`DeploymentType`	`string`	Create-only
`FailoverMode`	`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 cluster.
`Endpoint`	`string`	The connection endpoint for the InfluxDB cluster.
`EngineType`	`string`	The engine type for the InfluxDB cluster.
`Id`	`string`	The service generated unique identifier for InfluxDB cluster.
`InfluxAuthParametersSecretArn`	`string`	The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB cluster.
`ReaderEndpoint`	`string`	The reader endpoint for the InfluxDB cluster.
`Status`	`string`	Status of the InfluxDB cluster.

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::InfluxDBCluster

Resources:
  MyResource:
    Type: AWS::Timestream::InfluxDBCluster
    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:CreateDbInstancetimestream-influxdb:GetDbClustertimestream-influxdb:GetDbParameterGrouptimestream-influxdb:ListDbClusterstimestream-influxdb:CreateDbClustertimestream-influxdb:TagResource

read

timestream-influxdb:GetDbClustertimestream-influxdb:ListTagsForResource

update

s3:ListBuckets3:GetBucketPolicytimestream-influxdb:UpdateDbInstancetimestream-influxdb:GetDbClustertimestream-influxdb:ListDbClusterstimestream-influxdb:UpdateDbClustertimestream-influxdb:TagResourcetimestream-influxdb:UntagResource

delete

timestream-influxdb:DeleteDbInstancetimestream-influxdb:GetDbClustertimestream-influxdb:ListDbClusterstimestream-influxdb:DeleteDbCluster

list

timestream-influxdb:ListDbClusters

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

Properties25

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.

NameUsernamePasswordOrganizationBucketVpcSubnetIdsVpcSecurityGroupIdsPubliclyAccessibleDbStorageTypeAllocatedStorageDeploymentTypeNetworkType

Related Resources

External Links

AWS Documentation