AWS::Timestream::InfluxDBBackup

Timestream InfluxDBBackup

Resource type definition for AWS::Timestream::InfluxDBBackup. An on-demand backup of an Amazon Timestream for InfluxDB DB instance or DB cluster.

Properties

4 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`DbResourceId`	`string`	RequiredCreate-only
`Name`	`string`	RequiredCreate-only
`RetentionDays`	`integer`	Create-onlyWrite-only
`Tags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`AllocatedStorage`	`integer`	The allocated storage of the resource at the time of backup, in GiB.
`Arn`	`string`	The Amazon Resource Name (ARN) of the backup.
`ClusterConfiguration`	`ClusterConfiguration`	-
`CreatedAt`	`string`	The time when the backup was created.
`DbInstanceType`	`string`	The DB instance type of the resource at the time of backup.
`DbParameterGroupId`	`string`	The identifier of the DB parameter group associated with the backup.
`DbStorageType`	`string`	The storage type of the resource at the time of backup.
`DeploymentType`	`string`	The deployment type of the resource that the backup was created from.
`EngineType`	`string`	The engine type of the resource that the backup was created from.
`ExpiresAfter`	`string`	The date after which the backup will be automatically deleted, as a calendar date in YYYY-MM-DD format.
`FailoverMode`	`string`	The failover mode of the resource at the time of backup.
`Id`	`string`	Service-generated unique identifier of the backup.
`InfluxAuthParametersSecretArn`	`string`	The ARN of the Secrets Manager secret containing the InfluxDB auth parameters.
`KmsKeyId`	`string`	The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup.
`LogDeliveryConfiguration`	`LogDeliveryConfiguration`	-
`MaintenanceSchedule`	`MaintenanceSchedule`	-
`NetworkType`	`string`	The network type of the resource at the time of backup.
`Port`	`integer`	The port number of the resource at the time of backup.
`PubliclyAccessible`	`boolean`	Indicates whether the resource was publicly accessible at the time of backup.
`Status`	`string`	The current status of the backup.
`Type`	`string`	The type of backup. Backups created through this resource type are always ON_DEMAND.
`VpcSecurityGroupIds`	`Array<string>`	The VPC security group IDs associated with the resource at the time of backup.
`VpcSubnetIds`	`Array<string>`	The VPC subnet IDs associated with the resource at the time of backup.

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

Resources:
  MyResource:
    Type: AWS::Timestream::InfluxDBBackup
    Properties:
      Name: "my-name"
      DbResourceId: "my-dbresourceid"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

timestream-influxdb:CreateDbBackuptimestream-influxdb:GetDbBackuptimestream-influxdb:TagResource

read

timestream-influxdb:GetDbBackuptimestream-influxdb:ListTagsForResource

update

timestream-influxdb:GetDbBackuptimestream-influxdb:ListTagsForResourcetimestream-influxdb:TagResourcetimestream-influxdb:UntagResource

delete

timestream-influxdb:DeleteDbBackuptimestream-influxdb:GetDbBackuptimestream-influxdb:ListTagsForResource

list

timestream-influxdb:ListDbBackups

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

Properties27

Required2

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

NameDbResourceIdRetentionDays

Related Resources

External Links

AWS Documentation