Class: Aws::OpenSearchService::Types::ReservedInstance

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchService::Types::ReservedInstance

Defined in:

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

Overview

Details of a reserved OpenSearch instance.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #billing_subscription_id ⇒ Integer
• #currency_code ⇒ String

  The currency code for the reserved OpenSearch instance offering.

• #duration ⇒ Integer

  The duration, in seconds, for which the OpenSearch instance is reserved.

• #fixed_price ⇒ Float

  The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.

• #instance_count ⇒ Integer

  The number of OpenSearch instances that have been reserved.

• #instance_type ⇒ String

  The OpenSearch instance type offered by the reserved instance offering.

• #payment_option ⇒ String

  The payment option as defined in the reserved OpenSearch instance offering.

• #recurring_charges ⇒ Array<Types::RecurringCharge>

  The charge to your account regardless of whether you are creating any domains using the instance offering.

• #reservation_name ⇒ String

  The customer-specified identifier to track this reservation.

• #reserved_instance_id ⇒ String

  The unique identifier for the reservation.

• #reserved_instance_offering_id ⇒ String

  The offering identifier.

• #start_time ⇒ Time

  The time the reservation started.

• #state ⇒ String

  The state of the reserved OpenSearch instance.

• #usage_price ⇒ Float

  The rate you are charged for each hour for the domain that is using this reserved instance.

Instance Attribute Details

#billing_subscription_id ⇒ Integer

Returns:

• (Integer)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#currency_code ⇒ String

The currency code for the reserved OpenSearch instance offering.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#duration ⇒ Integer

The duration, in seconds, for which the OpenSearch instance is reserved.

Returns:

• (Integer)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#fixed_price ⇒ Float

The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.

Returns:

• (Float)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#instance_count ⇒ Integer

The number of OpenSearch instances that have been reserved.

Returns:

• (Integer)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

The OpenSearch instance type offered by the reserved instance offering.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#payment_option ⇒ String

The payment option as defined in the reserved OpenSearch instance offering.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#recurring_charges ⇒ Array<Types::RecurringCharge>

The charge to your account regardless of whether you are creating any domains using the instance offering.

Returns:

• (Array<Types::RecurringCharge>)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_name ⇒ String

The customer-specified identifier to track this reservation.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#reserved_instance_id ⇒ String

The unique identifier for the reservation.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#reserved_instance_offering_id ⇒ String

The offering identifier.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The time the reservation started.

Returns:

• (Time)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the reserved OpenSearch instance.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end

#usage_price ⇒ Float

The rate you are charged for each hour for the domain that is using this reserved instance.

Returns:

• (Float)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4153

class ReservedInstance < Struct.new(
  :reservation_name,
  :reserved_instance_id,
  :billing_subscription_id,
  :reserved_instance_offering_id,
  :instance_type,
  :start_time,
  :duration,
  :fixed_price,
  :usage_price,
  :currency_code,
  :instance_count,
  :state,
  :payment_option,
  :recurring_charges)
  SENSITIVE = []
  include Aws::Structure
end