Class: Aws::EC2::Types::CapacityManagerDimension

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CapacityManagerDimension

Defined in:

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

Overview

Represents dimension values for capacity metrics, including resource identifiers, geographic information, and reservation details used for grouping and filtering capacity data.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  The Amazon Web Services account ID that owns the capacity resource.

• #account_name ⇒ String

  The name of the Amazon Web Services account that owns the capacity resource.

• #availability_zone_id ⇒ String

  The unique identifier of the Availability Zone where the capacity resource is located.

• #instance_family ⇒ String

  The EC2 instance family of the capacity resource.

• #instance_platform ⇒ String

  The platform or operating system of the instance.

• #instance_type ⇒ String

  The specific EC2 instance type of the capacity resource.

• #reservation_arn ⇒ String

  The Amazon Resource Name (ARN) of the capacity reservation.

• #reservation_create_timestamp ⇒ Time

  The timestamp when the capacity reservation was originally created, in milliseconds since epoch.

• #reservation_end_date_type ⇒ String

  The type of end date for the capacity reservation.

• #reservation_end_timestamp ⇒ Time

  The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch.

• #reservation_id ⇒ String

  The unique identifier of the capacity reservation.

• #reservation_instance_match_criteria ⇒ String

  The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.

• #reservation_start_timestamp ⇒ Time

  The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch.

• #reservation_state ⇒ String

  The current state of the capacity reservation.

• #reservation_type ⇒ String

  The type of capacity reservation.

• #reservation_unused_financial_owner ⇒ String

  The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.

• #resource_region ⇒ String

  The Amazon Web Services Region where the capacity resource is located.

• #tags ⇒ Array<Types::CapacityManagerTagDimension>

  The tags associated with the capacity resource, represented as key-value pairs.

• #tenancy ⇒ String

  The tenancy of the EC2 instances associated with this capacity dimension.

Instance Attribute Details

#account_id ⇒ String

The Amazon Web Services account ID that owns the capacity resource.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#account_name ⇒ String

The name of the Amazon Web Services account that owns the capacity resource. This dimension is only available when Organizations access is enabled for Capacity Manager.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_id ⇒ String

The unique identifier of the Availability Zone where the capacity resource is located.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_family ⇒ String

The EC2 instance family of the capacity resource.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_platform ⇒ String

The platform or operating system of the instance.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

The specific EC2 instance type of the capacity resource.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_arn ⇒ String

The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across Amazon Web Services services to reference the specific reservation.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_create_timestamp ⇒ Time

The timestamp when the capacity reservation was originally created, in milliseconds since epoch. This differs from the start timestamp as reservations can be created before they become active.

Returns:

• (Time)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_end_date_type ⇒ String

The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_end_timestamp ⇒ Time

The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch. After this time, the reservation will not provide any capacity.

Returns:

• (Time)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_id ⇒ String

The unique identifier of the capacity reservation.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_instance_match_criteria ⇒ String

The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_start_timestamp ⇒ Time

The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.

Returns:

• (Time)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_state ⇒ String

The current state of the capacity reservation.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_type ⇒ String

The type of capacity reservation.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_unused_financial_owner ⇒ String

The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_region ⇒ String

The Amazon Web Services Region where the capacity resource is located.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::CapacityManagerTagDimension>

The tags associated with the capacity resource, represented as key-value pairs. Only tags that have been activated for monitoring via UpdateCapacityManagerMonitoredTagKeys are included.

Returns:

• (Array<Types::CapacityManagerTagDimension>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tenancy ⇒ String

The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5681

class CapacityManagerDimension < Struct.new(
  :resource_region,
  :availability_zone_id,
  :account_id,
  :account_name,
  :instance_family,
  :instance_type,
  :instance_platform,
  :reservation_arn,
  :reservation_id,
  :reservation_type,
  :reservation_create_timestamp,
  :reservation_start_timestamp,
  :reservation_end_timestamp,
  :reservation_end_date_type,
  :tenancy,
  :reservation_state,
  :reservation_instance_match_criteria,
  :reservation_unused_financial_owner,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end