Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. timestream
  5. getInfluxDbInstance

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.timestream.getInfluxDbInstance

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    The AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.

    Using getInfluxDbInstance

    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 getInfluxDbInstance(args: GetInfluxDbInstanceArgs, opts?: InvokeOptions): Promise<GetInfluxDbInstanceResult>
function getInfluxDbInstanceOutput(args: GetInfluxDbInstanceOutputArgs, opts?: InvokeOptions): Output<GetInfluxDbInstanceResult>
    def get_influx_db_instance(id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetInfluxDbInstanceResult
def get_influx_db_instance_output(id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetInfluxDbInstanceResult]
    func LookupInfluxDbInstance(ctx *Context, args *LookupInfluxDbInstanceArgs, opts ...InvokeOption) (*LookupInfluxDbInstanceResult, error)
func LookupInfluxDbInstanceOutput(ctx *Context, args *LookupInfluxDbInstanceOutputArgs, opts ...InvokeOption) LookupInfluxDbInstanceResultOutput

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

    public static class GetInfluxDbInstance 
{
    public static Task<GetInfluxDbInstanceResult> InvokeAsync(GetInfluxDbInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInfluxDbInstanceResult> Invoke(GetInfluxDbInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInfluxDbInstanceResult> getInfluxDbInstance(GetInfluxDbInstanceArgs args, InvokeOptions options)
public static Output<GetInfluxDbInstanceResult> getInfluxDbInstance(GetInfluxDbInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:timestream:getInfluxDbInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

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

    getInfluxDbInstance Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
    AvailabilityZone string
    The Availability Zone (AZ) where the InfluxDB instance is created.
    DbInstanceType Pulumi.AwsNative.Timestream.InfluxDbInstanceDbInstanceType
    The compute instance of the InfluxDB instance.
    DbParameterGroupIdentifier string
    The name of an existing InfluxDB parameter group.
    DeploymentType Pulumi.AwsNative.Timestream.InfluxDbInstanceDeploymentType
    Deployment type of the InfluxDB Instance.
    Endpoint string
    The connection endpoint for the InfluxDB instance.
    Id string
    The service generated unique identifier for InfluxDB instance.
    InfluxAuthParametersSecretArn string
    The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
    LogDeliveryConfiguration Pulumi.AwsNative.Timestream.Outputs.LogDeliveryConfigurationProperties
    Configuration for sending logs to customer account from the InfluxDB instance.
    Port int
    The port number on which InfluxDB accepts connections.
    SecondaryAvailabilityZone string
    The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
    Status Pulumi.AwsNative.Timestream.InfluxDbInstanceStatus
    Status of the InfluxDB Instance.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An arbitrary set of tags (key-value pairs) for this DB instance.
    Arn string
    The Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
    AvailabilityZone string
    The Availability Zone (AZ) where the InfluxDB instance is created.
    DbInstanceType InfluxDbInstanceDbInstanceType
    The compute instance of the InfluxDB instance.
    DbParameterGroupIdentifier string
    The name of an existing InfluxDB parameter group.
    DeploymentType InfluxDbInstanceDeploymentType
    Deployment type of the InfluxDB Instance.
    Endpoint string
    The connection endpoint for the InfluxDB instance.
    Id string
    The service generated unique identifier for InfluxDB instance.
    InfluxAuthParametersSecretArn string
    The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
    LogDeliveryConfiguration LogDeliveryConfigurationProperties
    Configuration for sending logs to customer account from the InfluxDB instance.
    Port int
    The port number on which InfluxDB accepts connections.
    SecondaryAvailabilityZone string
    The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
    Status InfluxDbInstanceStatus
    Status of the InfluxDB Instance.
    Tags Tag
    An arbitrary set of tags (key-value pairs) for this DB instance.
    arn String
    The Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
    availabilityZone String
    The Availability Zone (AZ) where the InfluxDB instance is created.
    dbInstanceType InfluxDbInstanceDbInstanceType
    The compute instance of the InfluxDB instance.
    dbParameterGroupIdentifier String
    The name of an existing InfluxDB parameter group.
    deploymentType InfluxDbInstanceDeploymentType
    Deployment type of the InfluxDB Instance.
    endpoint String
    The connection endpoint for the InfluxDB instance.
    id String
    The service generated unique identifier for InfluxDB instance.
    influxAuthParametersSecretArn String
    The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
    logDeliveryConfiguration LogDeliveryConfigurationProperties
    Configuration for sending logs to customer account from the InfluxDB instance.
    port Integer
    The port number on which InfluxDB accepts connections.
    secondaryAvailabilityZone String
    The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
    status InfluxDbInstanceStatus
    Status of the InfluxDB Instance.
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this DB instance.
    arn string
    The Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
    availabilityZone string
    The Availability Zone (AZ) where the InfluxDB instance is created.
    dbInstanceType InfluxDbInstanceDbInstanceType
    The compute instance of the InfluxDB instance.
    dbParameterGroupIdentifier string
    The name of an existing InfluxDB parameter group.
    deploymentType InfluxDbInstanceDeploymentType
    Deployment type of the InfluxDB Instance.
    endpoint string
    The connection endpoint for the InfluxDB instance.
    id string
    The service generated unique identifier for InfluxDB instance.
    influxAuthParametersSecretArn string
    The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
    logDeliveryConfiguration LogDeliveryConfigurationProperties
    Configuration for sending logs to customer account from the InfluxDB instance.
    port number
    The port number on which InfluxDB accepts connections.
    secondaryAvailabilityZone string
    The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
    status InfluxDbInstanceStatus
    Status of the InfluxDB Instance.
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this DB instance.
    arn str
    The Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
    availability_zone str
    The Availability Zone (AZ) where the InfluxDB instance is created.
    db_instance_type InfluxDbInstanceDbInstanceType
    The compute instance of the InfluxDB instance.
    db_parameter_group_identifier str
    The name of an existing InfluxDB parameter group.
    deployment_type InfluxDbInstanceDeploymentType
    Deployment type of the InfluxDB Instance.
    endpoint str
    The connection endpoint for the InfluxDB instance.
    id str
    The service generated unique identifier for InfluxDB instance.
    influx_auth_parameters_secret_arn str
    The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
    log_delivery_configuration LogDeliveryConfigurationProperties
    Configuration for sending logs to customer account from the InfluxDB instance.
    port int
    The port number on which InfluxDB accepts connections.
    secondary_availability_zone str
    The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
    status InfluxDbInstanceStatus
    Status of the InfluxDB Instance.
    tags Sequence[root_Tag]
    An arbitrary set of tags (key-value pairs) for this DB instance.
    arn String
    The Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
    availabilityZone String
    The Availability Zone (AZ) where the InfluxDB instance is created.
    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"
    The compute instance of the InfluxDB instance.
    dbParameterGroupIdentifier String
    The name of an existing InfluxDB parameter group.
    deploymentType "SINGLE_AZ" | "WITH_MULTIAZ_STANDBY"
    Deployment type of the InfluxDB Instance.
    endpoint String
    The connection endpoint for the InfluxDB instance.
    id String
    The service generated unique identifier for InfluxDB instance.
    influxAuthParametersSecretArn String
    The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
    logDeliveryConfiguration Property Map
    Configuration for sending logs to customer account from the InfluxDB instance.
    port Number
    The port number on which InfluxDB accepts connections.
    secondaryAvailabilityZone String
    The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
    status "CREATING" | "AVAILABLE" | "DELETING" | "MODIFYING" | "UPDATING" | "UPDATING_DEPLOYMENT_TYPE" | "UPDATING_INSTANCE_TYPE" | "DELETED" | "FAILED"
    Status of the InfluxDB Instance.
    tags List<Property Map>
    An arbitrary set of tags (key-value pairs) for this DB instance.

    Supporting Types

    InfluxDbInstanceDbInstanceType

    InfluxDbInstanceDeploymentType

    InfluxDbInstanceStatus

    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.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native