Class: Aws::TimestreamInfluxDB::Types::GetDbClusterOutput

Inherits:

Struct

• Object
• Struct
• Aws::TimestreamInfluxDB::Types::GetDbClusterOutput

Defined in:

gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allocated_storage ⇒ Integer

  The amount of storage allocated for your DB storage type (in gibibytes).

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the DB cluster.

• #db_instance_type ⇒ String

  The Timestream for InfluxDB instance type that InfluxDB runs on.

• #db_parameter_group_identifier ⇒ String

  The ID of the DB parameter group assigned to your DB cluster.

• #db_storage_type ⇒ String

  The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

• #deployment_type ⇒ String

  Deployment type of the DB cluster.

• #endpoint ⇒ String

  The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.

• #engine_type ⇒ String

  The engine type of your DB cluster.

• #failover_mode ⇒ String

  The configured failover mode for the DB cluster.

• #id ⇒ String

  Service-generated unique identifier of the DB cluster to retrieve.

• #influx_auth_parameters_secret_arn ⇒ String

  The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters.

• #log_delivery_configuration ⇒ Types::LogDeliveryConfiguration

  Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

• #name ⇒ String

  Customer-supplied name of the Timestream for InfluxDB cluster.

• #network_type ⇒ String

  Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

• #port ⇒ Integer

  The port number on which InfluxDB accepts connections.

• #publicly_accessible ⇒ Boolean

  Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.

• #reader_endpoint ⇒ String

  The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

• #status ⇒ String

  The status of the DB cluster.

• #vpc_security_group_ids ⇒ Array<String>

  A list of VPC security group IDs associated with the DB cluster.

• #vpc_subnet_ids ⇒ Array<String>

  A list of VPC subnet IDs associated with the DB cluster.

Instance Attribute Details

#allocated_storage ⇒ Integer

The amount of storage allocated for your DB storage type (in gibibytes).

Returns:

• (Integer)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the DB cluster.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_type ⇒ String

The Timestream for InfluxDB instance type that InfluxDB runs on.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#db_parameter_group_identifier ⇒ String

The ID of the DB parameter group assigned to your DB cluster.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#db_storage_type ⇒ String

The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_type ⇒ String

Deployment type of the DB cluster.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#engine_type ⇒ String

The engine type of your DB cluster.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#failover_mode ⇒ String

The configured failover mode for the DB cluster.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

Service-generated unique identifier of the DB cluster to retrieve.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#influx_auth_parameters_secret_arn ⇒ String

The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#log_delivery_configuration ⇒ Types::LogDeliveryConfiguration

Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

Returns:

• (Types::LogDeliveryConfiguration)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Customer-supplied name of the Timestream for InfluxDB cluster.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ String

Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The port number on which InfluxDB accepts connections.

Returns:

• (Integer)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.

Returns:

• (Boolean)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#reader_endpoint ⇒ String

The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the DB cluster.

Returns:

• (String)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ Array<String>

A list of VPC security group IDs associated with the DB cluster.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_subnet_ids ⇒ Array<String>

A list of VPC subnet IDs associated with the DB cluster.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 1091

class GetDbClusterOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :reader_endpoint,
  :port,
  :deployment_type,
  :db_instance_type,
  :network_type,
  :db_storage_type,
  :allocated_storage,
  :engine_type,
  :publicly_accessible,
  :db_parameter_group_identifier,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :failover_mode)
  SENSITIVE = []
  include Aws::Structure
end