Class: Aws::TimestreamInfluxDB::Types::GetDbInstanceOutput

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

Overview

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 gibibytes).

Returns:

  • (Integer) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

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

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ String

The Availability Zone in which the DB instance resides.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_type ⇒ String

The Timestream for InfluxDB instance type that InfluxDB runs on.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#db_parameter_group_identifier ⇒ String

The id of the DB parameter group assigned to your DB instance.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#db_storage_type ⇒ String

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

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_type ⇒ String

Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

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

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

A service-generated unique identifier.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#influx_auth_parameters_secret_arn ⇒ String

The Amazon Resource Name (ARN) of the AWS 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) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#log_delivery_configuration ⇒ Types::LogDeliveryConfiguration

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

Returns:



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

Indicates if the DB instance has a public IP to facilitate access.

Returns:

  • (Boolean) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_availability_zone ⇒ String

The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the DB instance.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_subnet_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/types.rb', line 630

class GetDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :db_instance_type,
  :db_storage_type,
  :allocated_storage,
  :deployment_type,
  :vpc_subnet_ids,
  :publicly_accessible,
  :vpc_security_group_ids,
  :db_parameter_group_identifier,
  :availability_zone,
  :secondary_availability_zone,
  :log_delivery_configuration,
  :influx_auth_parameters_secret_arn)
  SENSITIVE = []
  include Aws::Structure
end