Skip to main content

influxdb_instances_list_only

Lists influxdb_instances in a region or regions, for all properties use influxdb_instances

Overview

Nameinfluxdb_instances_list_only
TypeResource
DescriptionThe AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.
Idaws.timestream.influxdb_instances_list_only

Fields

NameDatatypeDescription
usernamestringThe username for the InfluxDB instance.
passwordstringThe password for the InfluxDB instance.
organizationstringThe organization for the InfluxDB instance.
bucketstringThe bucket for the InfluxDB instance.
db_instance_typestringThe compute instance of the InfluxDB instance.
vpc_subnet_idsarrayA list of EC2 subnet IDs for this InfluxDB instance.
vpc_security_group_idsarrayA list of Amazon EC2 VPC security groups to associate with this InfluxDB instance.
publicly_accessiblebooleanAttach a public IP to the customer ENI.
db_storage_typestringThe storage type of the InfluxDB instance.
allocated_storageintegerThe allocated storage for the InfluxDB instance.
db_parameter_group_identifierstringThe name of an existing InfluxDB parameter group.
log_delivery_configurationobjectConfiguration for sending logs to customer account from the InfluxDB instance.
statusstringStatus of the InfluxDB Instance.
arnstringThe Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
namestringThe unique name that is associated with the InfluxDB instance.
availability_zonestringThe Availability Zone (AZ) where the InfluxDB instance is created.
secondary_availability_zonestringThe Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
endpointstringThe connection endpoint for the InfluxDB instance.
influx_auth_parameters_secret_arnstringThe Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
idstringThe service generated unique identifier for InfluxDB instance.
deployment_typestringDeployment type of the InfluxDB Instance.
tagsarrayAn arbitrary set of tags (key-value pairs) for this DB instance.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

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