Class: Aws::TimestreamInfluxDB::Types::DbInstanceSummary

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

Overview

Contains a summary of a DB instance.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

The amount of storage to allocate for your DbStorageType in GiB (gibibytes).

Returns:

  • (Integer) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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

#arn ⇒ String

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

Returns:

  • (String) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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

#db_instance_type ⇒ String

The Timestream for InfluxDB instance type to run InfluxDB on.

Returns:

  • (String) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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

#db_storage_type ⇒ String

The storage type for your DB instance.

Returns:

  • (String) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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

#deployment_type ⇒ String

Single-Instance or with a MultiAZ Standby for High availability.

Returns:

  • (String) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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

#endpoint ⇒ String

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

Returns:

  • (String) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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

#id ⇒ String

The service-generated unique identifier of the DB instance.

Returns:

  • (String) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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

#name ⇒ String

This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and Amazon Web Services CLI commands.

Returns:

  • (String) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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

#network_type ⇒ String

Specifies whether the networkType 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) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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

#port ⇒ Integer

The port number on which InfluxDB accepts connections.

Returns:

  • (Integer) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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

#status ⇒ String

The status of the DB instance.

Returns:

  • (String) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 422

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