You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::RDS::Types::ReservedDBInstance

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::ReservedDBInstance

Defined in:

gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #currency_code ⇒ String

  The currency code for the reserved DB instance.

• #db_instance_class ⇒ String

  The DB instance class for the reserved DB instance.

• #db_instance_count ⇒ Integer

  The number of reserved DB instances.

• #duration ⇒ Integer

  The duration of the reservation in seconds.

• #fixed_price ⇒ Float

  The fixed price charged for this reserved DB instance.

• #multi_az ⇒ Boolean

  Indicates if the reservation applies to Multi-AZ deployments.

• #offering_type ⇒ String

  The offering type of this reserved DB instance.

• #product_description ⇒ String

  The description of the reserved DB instance.

• #recurring_charges ⇒ Array<Types::RecurringCharge>

  The recurring price charged to run this reserved DB instance.

• #reserved_db_instance_arn ⇒ String

  The Amazon Resource Name (ARN) for the reserved DB instance.

• #reserved_db_instance_id ⇒ String

  The unique identifier for the reservation.

• #reserved_db_instances_offering_id ⇒ String

  The offering identifier.

• #start_time ⇒ Time

  The time the reservation started.

• #state ⇒ String

  The state of the reserved DB instance.

• #usage_price ⇒ Float

  The hourly price charged for this reserved DB instance.

Instance Attribute Details

#currency_code ⇒ String

The currency code for the reserved DB instance.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#db_instance_class ⇒ String

The DB instance class for the reserved DB instance.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#db_instance_count ⇒ Integer

The number of reserved DB instances.

Returns:

• (Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#duration ⇒ Integer

The duration of the reservation in seconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#fixed_price ⇒ Float

The fixed price charged for this reserved DB instance.

Returns:

• (Float)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#multi_az ⇒ Boolean

Indicates if the reservation applies to Multi-AZ deployments.

Returns:

• (Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#offering_type ⇒ String

The offering type of this reserved DB instance.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#product_description ⇒ String

The description of the reserved DB instance.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#recurring_charges ⇒ Array<Types::RecurringCharge>

The recurring price charged to run this reserved DB instance.

Returns:

• (Array<Types::RecurringCharge>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#reserved_db_instance_arn ⇒ String

The Amazon Resource Name (ARN) for the reserved DB instance.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#reserved_db_instance_id ⇒ String

The unique identifier for the reservation.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#reserved_db_instances_offering_id ⇒ String

The offering identifier.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#start_time ⇒ Time

The time the reservation started.

Returns:

• (Time)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#state ⇒ String

The state of the reserved DB instance.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end

#usage_price ⇒ Float

The hourly price charged for this reserved DB instance.

Returns:

• (Float)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12774

class ReservedDBInstance < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :db_instance_count,
  :product_description,
  :offering_type,
  :multi_az,
  :state,
  :recurring_charges,
  :reserved_db_instance_arn)
  include Aws::Structure
end