Class: MintPress::Aws::EC2::InstanceType

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_type.rb

Properties (Read/Write)

  • #dry_run ⇒ [TrueClass,FalseClass]
    'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
    Property Attributes
    • describe_instance_types_prop ⇒ 'dry_run'
    • source ⇒ "describe_instance_types"
    

18
19
20
21
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_type.rb', line 18

property :dry_run, describe_instance_types_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_instance_types", description: 'Checks whether you have the required permissions for the action,
without actually making the request, and provides an error response.
If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
  • #instance_types ⇒ Array of ⇒ [String]
    'The instance types. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.'
    Property Attributes
    • describe_instance_types_prop ⇒ 'instance_types'
    • source ⇒ "describe_instance_types"
    

22
23
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_type.rb', line 22

property :instance_types, describe_instance_types_prop: 'instance_types', type: [String], array: true, source: "describe_instance_types", description: 'The instance types. For more information, see Instance Types in
the Amazon Elastic Compute Cloud User Guide.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. Filter names and values are case-sensitive. auto-recovery-supported - Indicates whether auto recovery is supported (true | false). bare-metal - Indicates whether it is a bare metal instance type (true | false). burstable-performance-supported - Indicates whether it is a burstable performance instance type (true | false). current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false). ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps. ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type. ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s. ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps. ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type. ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s. ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default). ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported). ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported). free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false). hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false). hypervisor - The hypervisor (nitro | xen). instance-storage-info.disk.count - The number of local disks. instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB. instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd). instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported) | unsupported). instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB. instance-storage-supported - Indicates whether the instance type has local instance storage (true | false). instance-type - The instance type (for example c5.2xlarge or c5*). memory-info.size-in-mib - The memory size. network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false). network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported). network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface. network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface. network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false). network-info.maximum-network-interfaces - The maximum number of network interfaces per instance. network-info.network-performance - The network performance (for example, "25 Gigabit"). processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64). processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz. supported-root-device-type - The root device type (ebs | instance-store). supported-usage-class - The usage class (on-demand | spot). supported-virtualization-type - The virtualization type (hvm | paravirtual). vcpu-info.default-cores - The default number of cores for the instance type. vcpu-info.default-threads-per-core - The default number of threads per core for the instance type. vcpu-info.default-vcpus - The default number of vCPUs for the instance type. vcpu-info.valid-cores - The number of cores that can be configured for the instance type. vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".'
    Property Attributes
    • describe_instance_types_prop ⇒ 'filters'
    • source ⇒ "describe_instance_types"
    

24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_type.rb', line 24

property :filters, describe_instance_types_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_instance_types", description: 'One or more filters. Filter names and values are case-sensitive.


auto-recovery-supported - Indicates whether auto recovery is
supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type
(true | false).
burstable-performance-supported - Indicates whether it is a
burstable performance instance type (true | false).
current-generation - Indicates whether this instance type is the
latest generation instance type of an instance family (true |
false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The
baseline bandwidth performance for an EBS-optimized instance type,
in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline
input/output storage operations per second for an EBS-optimized
instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The
baseline throughput performance for an EBS-optimized instance type,
in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The
maximum bandwidth performance for an EBS-optimized instance type, in
Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum
input/output storage operations per second for an EBS-optimized
instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The
maximum throughput performance for an EBS-optimized instance type,
in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance
type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is
supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory
express (NVMe) is supported for EBS volumes (required |
supported | unsupported).
free-tier-eligible - Indicates whether the instance type is
eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is
supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each
instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the
local instance storage disks (hdd | ssd).
instance-storage-info.nvme-support - Indicates whether
non-volatile memory express (NVMe) is supported for instance store
(required | supported) | unsupported).
instance-storage-info.total-size-in-gb - The total amount of
storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type
has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or
c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-supported - Indicates whether the instance type
supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network
Adapter (ENA) is supported or required (required | supported |
unsupported).
network-info.ipv4-addresses-per-interface - The maximum number of
private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of
private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type
supports IPv6 (true | false).
network-info.maximum-network-interfaces - The maximum number of
network interfaces per instance.
network-info.network-performance - The network performance (for
example, "25 Gigabit").
processor-info.supported-architecture - The CPU architecture
(arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed,
in GHz.
supported-root-device-type - The root device type (ebs |
instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm |
paravirtual).
vcpu-info.default-cores - The default number of cores for the
instance type.
vcpu-info.default-threads-per-core - The default number of threads
per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the
instance type.
vcpu-info.valid-cores - The number of cores that can be configured
for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core
that can be configured for the instance type. For example, "1" or
"1,2".', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the next token value.'
    Property Attributes
    • describe_instance_types_prop ⇒ 'max_results'
    • source ⇒ "describe_instance_types"
    

116
117
118
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_type.rb', line 116

property :max_results, describe_instance_types_prop: 'max_results', type: [Integer], source: "describe_instance_types", description: 'The maximum number of results to return for the request in a single
page. The remaining results can be seen by sending another request
with the next token value.'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

122
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_type.rb', line 122

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

125
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_type.rb', line 125

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ InstanceType

Returns a new instance of InstanceType.

Instance Method Details

#describe ⇒ Object