Aws/timestream
@swamp/aws/timestreamv2026.10.25.1
01README
AWS TIMESTREAM infrastructure models
02Behaviors
@swamp/aws/timestream/databasev2026.10.23.1database.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DatabaseName? | string | The name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name. |
| KmsKeyId? | string | The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Timestream Database
fn get(identifier: string)
Get a Timestream Database
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream Database |
fn update()
Update a Timestream Database
fn delete(identifier: string)
Delete a Timestream Database
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream Database |
fn sync()
Sync Timestream Database state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Timestream Database resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Timestream Database resource state
@swamp/aws/timestream/influx-dbbackupv2026.10.23.1influx_dbbackup.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name of the backup. Must be unique within the account and region. |
| DbResourceId | string | The id of the DB instance or DB cluster to back up. |
| RetentionDays? | number | The number of days to retain the backup. Valid values are 1 to 3650. |
| ClusterConfiguration? | object | The cluster configuration of the resource at the time of backup. |
| LogDeliveryConfiguration? | object | The log delivery configuration of the resource at the time of backup. |
| MaintenanceSchedule? | object | The maintenance schedule of the resource at the time of backup. |
| Tags? | array | A list of key-value pairs to associate with the backup. |
fn create()
Create a Timestream InfluxDBBackup
fn get(identifier: string)
Get a Timestream InfluxDBBackup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream InfluxDBBackup |
fn update()
Update a Timestream InfluxDBBackup
fn delete(identifier: string)
Delete a Timestream InfluxDBBackup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream InfluxDBBackup |
fn sync()
Sync Timestream InfluxDBBackup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Timestream InfluxDBBackup resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Timestream InfluxDBBackup resource state
@swamp/aws/timestream/influx-dbclusterv2026.10.23.1influx_dbcluster.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Organization? | string | The organization for the InfluxDB cluster. |
| Port? | number | The port number on which InfluxDB accepts connections. |
| DbInstanceType? | enum | The compute instance of the InfluxDB cluster. |
| VpcSubnetIds? | array | A list of EC2 subnet IDs for this InfluxDB cluster. |
| DeploymentType? | enum | Deployment type of the InfluxDB cluster. |
| Name? | string | The unique name that is associated with the InfluxDB cluster. |
| VpcSecurityGroupIds? | array | A list of Amazon EC2 VPC security groups to associate with this InfluxDB cluster. |
| NetworkType? | enum | Network type of the InfluxDB cluster. |
| Tags? | array | An arbitrary set of tags (key-value pairs) for this DB cluster. |
| Password? | string | The password for the InfluxDB cluster. |
| DbParameterGroupIdentifier? | string | The name of an existing InfluxDB parameter group. |
| FailoverMode? | enum | Failover mode of the InfluxDB cluster. |
| AllocatedStorage? | number | The allocated storage for the InfluxDB cluster. |
| DbStorageType? | enum | The storage type of the InfluxDB cluster. |
| LogDeliveryConfiguration? | object | Configuration for sending logs to customer account from the InfluxDB cluster. |
| Username? | string | The username for the InfluxDB cluster. |
| Bucket? | string | The bucket for the InfluxDB cluster. |
| PubliclyAccessible? | boolean | Attach a public IP to the customer ENI. |
| MaintenanceSchedule? | object | The maintenance schedule for the InfluxDB cluster. |
fn create()
Create a Timestream InfluxDBCluster
fn get(identifier: string)
Get a Timestream InfluxDBCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream InfluxDBCluster |
fn update()
Update a Timestream InfluxDBCluster
fn delete(identifier: string)
Delete a Timestream InfluxDBCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream InfluxDBCluster |
fn sync()
Sync Timestream InfluxDBCluster state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Timestream InfluxDBCluster resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Timestream InfluxDBCluster resource state
@swamp/aws/timestream/influx-dbinstancev2026.10.23.1influx_dbinstance.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Organization? | string | The organization for the InfluxDB instance. |
| Port? | number | The port number on which InfluxDB accepts connections. |
| DbInstanceType? | enum | The compute instance of the InfluxDB instance. |
| VpcSubnetIds? | array | A list of EC2 subnet IDs for this InfluxDB instance. |
| DeploymentType? | enum | Deployment type of the InfluxDB Instance. |
| Name? | string | The unique name that is associated with the InfluxDB instance. |
| VpcSecurityGroupIds? | array | A list of Amazon EC2 VPC security groups to associate with this InfluxDB instance. |
| NetworkType? | enum | Network type of the InfluxDB Instance. |
| Tags? | array | An arbitrary set of tags (key-value pairs) for this DB instance. |
| Password? | string | The password for the InfluxDB instance. |
| DbParameterGroupIdentifier? | string | The name of an existing InfluxDB parameter group. |
| AllocatedStorage? | number | The allocated storage for the InfluxDB instance. |
| DbStorageType? | enum | The storage type of the InfluxDB instance. |
| LogDeliveryConfiguration? | object | Configuration for sending logs to customer account from the InfluxDB instance. |
| Username? | string | The username for the InfluxDB instance. |
| Bucket? | string | The bucket for the InfluxDB instance. |
| PubliclyAccessible? | boolean | Attach a public IP to the customer ENI. |
| MaintenanceSchedule? | object | The maintenance schedule for the InfluxDB instance. |
fn create()
Create a Timestream InfluxDBInstance
fn get(identifier: string)
Get a Timestream InfluxDBInstance
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream InfluxDBInstance |
fn update()
Update a Timestream InfluxDBInstance
fn delete(identifier: string)
Delete a Timestream InfluxDBInstance
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream InfluxDBInstance |
fn sync()
Sync Timestream InfluxDBInstance state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Timestream InfluxDBInstance resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Timestream InfluxDBInstance resource state
@swamp/aws/timestream/scheduled-queryv2026.10.23.1scheduled_query.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ScheduledQueryName? | string | The name of the scheduled query. Scheduled query names must be unique within each Region. |
| QueryString | string | The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this inst |
| ScheduleConfiguration | object | Configuration for when the scheduled query is executed. |
| NotificationConfiguration | object | Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it. |
| ClientToken? | string | Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request. If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf. After 8 hours, any request with the same ClientToken is treated as a new request. |
| ScheduledQueryExecutionRoleArn | string | The ARN for the IAM role that Timestream will assume when running the scheduled query. |
| TargetConfiguration? | object | Configuration of target store where scheduled query results are written to. |
| ErrorReportConfiguration | object | Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results. |
| KmsKeyId? | string | The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest. |
| Tags? | array | A list of key-value pairs to label the scheduled query. |
fn create()
Create a Timestream ScheduledQuery
fn get(identifier: string)
Get a Timestream ScheduledQuery
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream ScheduledQuery |
fn update()
Update a Timestream ScheduledQuery
fn delete(identifier: string)
Delete a Timestream ScheduledQuery
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream ScheduledQuery |
fn sync()
Sync Timestream ScheduledQuery state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Timestream ScheduledQuery resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Timestream ScheduledQuery resource state
@swamp/aws/timestream/tablev2026.10.23.1table.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DatabaseName | string | The name for the database which the table to be created belongs to. |
| TableName? | string | The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name. |
| RetentionProperties? | object | The retention duration of the memory store and the magnetic store. |
| Schema? | object | A Schema specifies the expected data model of the table. |
| MagneticStoreWriteProperties? | object | The properties that determine whether magnetic store writes are enabled. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Timestream Table
fn get(identifier: string)
Get a Timestream Table
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream Table |
fn update()
Update a Timestream Table
fn delete(identifier: string)
Delete a Timestream Table
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Timestream Table |
fn sync()
Sync Timestream Table state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Timestream Table resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Timestream Table resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later
- Updated: database, influx_dbbackup, influx_dbcluster, influx_dbinstance, scheduled_query, table
2026.10.15.1AGPL-3.0-or-later(was none)
- Added: influx_dbbackup
Added 1 behaviors
2026.10.13.1
- Updated: database, influx_dbcluster, influx_dbinstance, scheduled_query, table
2026.10.08.1
2026.10.06.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.21.1
2026.09.20.1
04Stats
A
100 / 100
Downloads
187
Archive size
1.2 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
05Platforms
06Labels