1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. timestream
  5. getInfluxDbCluster

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.59.0
published on Monday, Mar 30, 2026 by Pulumi
aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.59.0
published on Monday, Mar 30, 2026 by Pulumi

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

    Using getInfluxDbCluster

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInfluxDbCluster(args: GetInfluxDbClusterArgs, opts?: InvokeOptions): Promise<GetInfluxDbClusterResult>
    function getInfluxDbClusterOutput(args: GetInfluxDbClusterOutputArgs, opts?: InvokeOptions): Output<GetInfluxDbClusterResult>
    def get_influx_db_cluster(id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetInfluxDbClusterResult
    def get_influx_db_cluster_output(id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetInfluxDbClusterResult]
    func LookupInfluxDbCluster(ctx *Context, args *LookupInfluxDbClusterArgs, opts ...InvokeOption) (*LookupInfluxDbClusterResult, error)
    func LookupInfluxDbClusterOutput(ctx *Context, args *LookupInfluxDbClusterOutputArgs, opts ...InvokeOption) LookupInfluxDbClusterResultOutput

    > Note: This function is named LookupInfluxDbCluster in the Go SDK.

    public static class GetInfluxDbCluster 
    {
        public static Task<GetInfluxDbClusterResult> InvokeAsync(GetInfluxDbClusterArgs args, InvokeOptions? opts = null)
        public static Output<GetInfluxDbClusterResult> Invoke(GetInfluxDbClusterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInfluxDbClusterResult> getInfluxDbCluster(GetInfluxDbClusterArgs args, InvokeOptions options)
    public static Output<GetInfluxDbClusterResult> getInfluxDbCluster(GetInfluxDbClusterArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:timestream:getInfluxDbCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The service generated unique identifier for InfluxDB cluster.
    Id string
    The service generated unique identifier for InfluxDB cluster.
    id String
    The service generated unique identifier for InfluxDB cluster.
    id string
    The service generated unique identifier for InfluxDB cluster.
    id str
    The service generated unique identifier for InfluxDB cluster.
    id String
    The service generated unique identifier for InfluxDB cluster.

    getInfluxDbCluster Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) that is associated with the InfluxDB cluster.
    DbInstanceType Pulumi.AwsNative.Timestream.InfluxDbClusterDbInstanceType
    The compute instance of the InfluxDB cluster.
    DbParameterGroupIdentifier string
    The name of an existing InfluxDB parameter group.
    Endpoint string
    The connection endpoint for the InfluxDB cluster.
    EngineType Pulumi.AwsNative.Timestream.InfluxDbClusterEngineType
    The engine type for the InfluxDB cluster.
    FailoverMode Pulumi.AwsNative.Timestream.InfluxDbClusterFailoverMode
    Failover mode of 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.
    LogDeliveryConfiguration Pulumi.AwsNative.Timestream.Outputs.LogDeliveryConfigurationProperties
    Configuration for sending logs to customer account from the InfluxDB cluster.
    Port int
    The port number on which InfluxDB accepts connections.
    ReaderEndpoint string
    The reader endpoint for the InfluxDB cluster.
    Status Pulumi.AwsNative.Timestream.InfluxDbClusterStatus
    Status of the InfluxDB cluster.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An arbitrary set of tags (key-value pairs) for this DB cluster.
    Arn string
    The Amazon Resource Name (ARN) that is associated with the InfluxDB cluster.
    DbInstanceType InfluxDbClusterDbInstanceType
    The compute instance of the InfluxDB cluster.
    DbParameterGroupIdentifier string
    The name of an existing InfluxDB parameter group.
    Endpoint string
    The connection endpoint for the InfluxDB cluster.
    EngineType InfluxDbClusterEngineType
    The engine type for the InfluxDB cluster.
    FailoverMode InfluxDbClusterFailoverMode
    Failover mode of 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.
    LogDeliveryConfiguration LogDeliveryConfigurationProperties
    Configuration for sending logs to customer account from the InfluxDB cluster.
    Port int
    The port number on which InfluxDB accepts connections.
    ReaderEndpoint string
    The reader endpoint for the InfluxDB cluster.
    Status InfluxDbClusterStatus
    Status of the InfluxDB cluster.
    Tags Tag
    An arbitrary set of tags (key-value pairs) for this DB cluster.
    arn String
    The Amazon Resource Name (ARN) that is associated with the InfluxDB cluster.
    dbInstanceType InfluxDbClusterDbInstanceType
    The compute instance of the InfluxDB cluster.
    dbParameterGroupIdentifier String
    The name of an existing InfluxDB parameter group.
    endpoint String
    The connection endpoint for the InfluxDB cluster.
    engineType InfluxDbClusterEngineType
    The engine type for the InfluxDB cluster.
    failoverMode InfluxDbClusterFailoverMode
    Failover mode of 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.
    logDeliveryConfiguration LogDeliveryConfigurationProperties
    Configuration for sending logs to customer account from the InfluxDB cluster.
    port Integer
    The port number on which InfluxDB accepts connections.
    readerEndpoint String
    The reader endpoint for the InfluxDB cluster.
    status InfluxDbClusterStatus
    Status of the InfluxDB cluster.
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this DB cluster.
    arn string
    The Amazon Resource Name (ARN) that is associated with the InfluxDB cluster.
    dbInstanceType InfluxDbClusterDbInstanceType
    The compute instance of the InfluxDB cluster.
    dbParameterGroupIdentifier string
    The name of an existing InfluxDB parameter group.
    endpoint string
    The connection endpoint for the InfluxDB cluster.
    engineType InfluxDbClusterEngineType
    The engine type for the InfluxDB cluster.
    failoverMode InfluxDbClusterFailoverMode
    Failover mode of 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.
    logDeliveryConfiguration LogDeliveryConfigurationProperties
    Configuration for sending logs to customer account from the InfluxDB cluster.
    port number
    The port number on which InfluxDB accepts connections.
    readerEndpoint string
    The reader endpoint for the InfluxDB cluster.
    status InfluxDbClusterStatus
    Status of the InfluxDB cluster.
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this DB cluster.
    arn str
    The Amazon Resource Name (ARN) that is associated with the InfluxDB cluster.
    db_instance_type InfluxDbClusterDbInstanceType
    The compute instance of the InfluxDB cluster.
    db_parameter_group_identifier str
    The name of an existing InfluxDB parameter group.
    endpoint str
    The connection endpoint for the InfluxDB cluster.
    engine_type InfluxDbClusterEngineType
    The engine type for the InfluxDB cluster.
    failover_mode InfluxDbClusterFailoverMode
    Failover mode of the InfluxDB cluster.
    id str
    The service generated unique identifier for InfluxDB cluster.
    influx_auth_parameters_secret_arn str
    The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB cluster.
    log_delivery_configuration LogDeliveryConfigurationProperties
    Configuration for sending logs to customer account from the InfluxDB cluster.
    port int
    The port number on which InfluxDB accepts connections.
    reader_endpoint str
    The reader endpoint for the InfluxDB cluster.
    status InfluxDbClusterStatus
    Status of the InfluxDB cluster.
    tags Sequence[root_Tag]
    An arbitrary set of tags (key-value pairs) for this DB cluster.
    arn String
    The Amazon Resource Name (ARN) that is associated with the InfluxDB cluster.
    dbInstanceType "db.influx.medium" | "db.influx.large" | "db.influx.xlarge" | "db.influx.2xlarge" | "db.influx.4xlarge" | "db.influx.8xlarge" | "db.influx.12xlarge" | "db.influx.16xlarge" | "db.influx.24xlarge"
    The compute instance of the InfluxDB cluster.
    dbParameterGroupIdentifier String
    The name of an existing InfluxDB parameter group.
    endpoint String
    The connection endpoint for the InfluxDB cluster.
    engineType "INFLUXDB_V2" | "INFLUXDB_V3_CORE" | "INFLUXDB_V3_ENTERPRISE"
    The engine type for the InfluxDB cluster.
    failoverMode "AUTOMATIC" | "NO_FAILOVER"
    Failover mode of 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.
    logDeliveryConfiguration Property Map
    Configuration for sending logs to customer account from the InfluxDB cluster.
    port Number
    The port number on which InfluxDB accepts connections.
    readerEndpoint String
    The reader endpoint for the InfluxDB cluster.
    status "CREATING" | "UPDATING" | "UPDATING_INSTANCE_TYPE" | "MAINTENANCE" | "DELETING" | "AVAILABLE" | "REBOOTING" | "REBOOT_FAILED" | "PARTIALLY_AVAILABLE" | "FAILED" | "DELETED"
    Status of the InfluxDB cluster.
    tags List<Property Map>
    An arbitrary set of tags (key-value pairs) for this DB cluster.

    Supporting Types

    InfluxDbClusterDbInstanceType

    InfluxDbClusterEngineType

    InfluxDbClusterFailoverMode

    InfluxDbClusterStatus

    LogDeliveryConfigurationProperties

    S3Configuration Pulumi.AwsNative.Timestream.Inputs.LogDeliveryConfigurationPropertiesS3ConfigurationProperties
    S3 configuration for sending logs to customer account from the InfluxDB instance.
    S3Configuration LogDeliveryConfigurationPropertiesS3ConfigurationProperties
    S3 configuration for sending logs to customer account from the InfluxDB instance.
    s3Configuration LogDeliveryConfigurationPropertiesS3ConfigurationProperties
    S3 configuration for sending logs to customer account from the InfluxDB instance.
    s3Configuration LogDeliveryConfigurationPropertiesS3ConfigurationProperties
    S3 configuration for sending logs to customer account from the InfluxDB instance.
    s3_configuration LogDeliveryConfigurationPropertiesS3ConfigurationProperties
    S3 configuration for sending logs to customer account from the InfluxDB instance.
    s3Configuration Property Map
    S3 configuration for sending logs to customer account from the InfluxDB instance.

    LogDeliveryConfigurationPropertiesS3ConfigurationProperties

    BucketName string
    The bucket name for logs to be sent from the InfluxDB instance
    Enabled bool
    Specifies whether logging to customer specified bucket is enabled.
    BucketName string
    The bucket name for logs to be sent from the InfluxDB instance
    Enabled bool
    Specifies whether logging to customer specified bucket is enabled.
    bucketName String
    The bucket name for logs to be sent from the InfluxDB instance
    enabled Boolean
    Specifies whether logging to customer specified bucket is enabled.
    bucketName string
    The bucket name for logs to be sent from the InfluxDB instance
    enabled boolean
    Specifies whether logging to customer specified bucket is enabled.
    bucket_name str
    The bucket name for logs to be sent from the InfluxDB instance
    enabled bool
    Specifies whether logging to customer specified bucket is enabled.
    bucketName String
    The bucket name for logs to be sent from the InfluxDB instance
    enabled Boolean
    Specifies whether logging to customer specified bucket is enabled.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.59.0
    published on Monday, Mar 30, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.