Class: Aws::TimestreamInfluxDB::Types::DbInstanceForClusterSummary

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-timestreaminfluxdb/types.rb

Overview

Contains a summary of a DB instance belonging to a DB cluster.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

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

Returns:

  • (Integer) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

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

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_type ⇒ String

The Timestream for InfluxDB instance type to run InfluxDB on.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#db_storage_type ⇒ String

The storage type for your DB instance.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_type ⇒ String

Specifies the deployment type if applicable.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The service-generated unique identifier of the DB instance.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#instance_mode ⇒ String

Specifies the DB instance’s role in the cluster.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#instance_modes ⇒ Array<String>

Specifies the DB instance’s roles in the cluster.

Returns:

  • (Array<String>) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A service-generated name for the DB instance based on the customer-supplied name for the DB cluster.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ String

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

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The port number on which InfluxDB accepts connections.

Returns:

  • (Integer) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the DB instance.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 738

class DbInstanceForClusterSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :instance_mode,
  :instance_modes)
  SENSITIVE = []
  include Aws::Structure
end