influxdb_instances_list_only
Lists influxdb_instances
in a region or regions, for all properties use influxdb_instances
Overview
Name | influxdb_instances_list_only |
Type | Resource |
Description | The AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance. |
Id | aws.timestream.influxdb_instances_list_only |
Fields
Name | Datatype | Description |
---|---|---|
username | string | The username for the InfluxDB instance. |
password | string | The password for the InfluxDB instance. |
organization | string | The organization for the InfluxDB instance. |
bucket | string | The bucket for the InfluxDB instance. |
db_instance_type | string | The compute instance of the InfluxDB instance. |
vpc_subnet_ids | array | A list of EC2 subnet IDs for this InfluxDB instance. |
vpc_security_group_ids | array | A list of Amazon EC2 VPC security groups to associate with this InfluxDB instance. |
publicly_accessible | boolean | Attach a public IP to the customer ENI. |
db_storage_type | string | The storage type of the InfluxDB instance. |
allocated_storage | integer | The allocated storage for the InfluxDB instance. |
db_parameter_group_identifier | string | The name of an existing InfluxDB parameter group. |
log_delivery_configuration | object | Configuration for sending logs to customer account from the InfluxDB instance. |
status | string | Status of the InfluxDB Instance. |
arn | string | The Amazon Resource Name (ARN) that is associated with the InfluxDB instance. |
name | string | The unique name that is associated with the InfluxDB instance. |
availability_zone | string | The Availability Zone (AZ) where the InfluxDB instance is created. |
secondary_availability_zone | string | The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY. |
endpoint | string | The connection endpoint for the InfluxDB instance. |
influx_auth_parameters_secret_arn | string | The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance. |
id | string | The service generated unique identifier for InfluxDB instance. |
deployment_type | string | Deployment type of the InfluxDB Instance. |
tags | array | An arbitrary set of tags (key-value pairs) for this DB instance. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Lists all influxdb_instances
in a region.
SELECT
region,
id
FROM aws.timestream.influxdb_instances_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the influxdb_instances_list_only
resource, see influxdb_instances