Class: Aws::TimestreamInfluxDB::Types::UpdateDbInstanceOutput

Inherits:

Struct

• Object
• Struct
• Aws::TimestreamInfluxDB::Types::UpdateDbInstanceOutput

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 instance.

• #availability_zone ⇒ String

  The Availability Zone in which the DB instance resides.

• #db_cluster_id ⇒ String

  Specifies the DbCluster to which this DbInstance belongs to.

• #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 instance.

• #db_storage_type ⇒ String

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

• #deployment_type ⇒ String

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

• #endpoint ⇒ String

  The endpoint used to connect to InfluxDB.

• #id ⇒ String

  A service-generated unique identifier.

• #influx_auth_parameters_secret_arn ⇒ String

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

• #instance_mode ⇒ String

  Specifies the DbInstance's role in the cluster.

• #log_delivery_configuration ⇒ Types::LogDeliveryConfiguration

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

• #name ⇒ String

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

• #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.

• #port ⇒ Integer

  The port number on which InfluxDB accepts connections.

• #publicly_accessible ⇒ Boolean

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

• #secondary_availability_zone ⇒ String

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

• #status ⇒ String

  The status of the DB instance.

• #vpc_security_group_ids ⇒ Array<String>

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

• #vpc_subnet_ids ⇒ Array<String>

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

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 2148

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

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

Returns:

• (String)

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ String

The Availability Zone in which the DB instance resides.

Returns:

• (String)

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_id ⇒ String

Specifies the DbCluster to which this DbInstance belongs to.

Returns:

• (String)

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_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 2148

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end

#db_parameter_group_identifier ⇒ String

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

Returns:

• (String)

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_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 2148

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

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

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

Returns:

• (String)

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

A service-generated unique identifier.

Returns:

• (String)

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_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 2148

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end

#instance_mode ⇒ String

Specifies the DbInstance's role in the cluster.

Returns:

• (String)

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_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 2148

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  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 CLI commands.

Returns:

• (String)

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

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

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_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 2148

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

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

Returns:

• (Boolean)

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

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

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the DB instance.

Returns:

• (String)

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

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

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_subnet_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

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

class UpdateDbInstanceOutput < Struct.new(
  :id,
  :name,
  :arn,
  :status,
  :endpoint,
  :port,
  :network_type,
  :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,
  :db_cluster_id,
  :instance_mode)
  SENSITIVE = []
  include Aws::Structure
end