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) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 401

class DbInstanceSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :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) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 401

class DbInstanceSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :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) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 401

class DbInstanceSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :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) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 401

class DbInstanceSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :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) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 401

class DbInstanceSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :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) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 401

class DbInstanceSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :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) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 401

class DbInstanceSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :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 AWS CLI commands.

Returns:

  • (String) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 401

class DbInstanceSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :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) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 401

class DbInstanceSummary < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :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) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-timestreaminfluxdb/types.rb', line 401

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