Class: MintPress::Aws::EC2::Host

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

Properties (Read/Write)

  • #allocation_time ⇒ [Time]
    'The time that the Dedicated Host was allocated.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'allocation_time'
    

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

property :allocation_time, disposition: :attribute, description: 'The time that the Dedicated Host was allocated.', source: "MintPress::Aws::EC2::Host", orig_name: 'allocation_time', type: [Time]
  • #allows_multiple_instance_types ⇒ [String]
    'Indicates whether the Dedicated Host supports multiple instance types of the same instance family, or a specific instance type only.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'allows_multiple_instance_types'
    

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

property :allows_multiple_instance_types, disposition: :attribute, description: 'Indicates whether the Dedicated Host supports multiple instance types of the same instance family, or a specific instance type only.', source: "MintPress::Aws::EC2::Host", orig_name: 'allows_multiple_instance_types', type: [String]
  • #auto_placement ⇒ [String]
    'Specify whether to enable or disable auto-placement.'
    Property Attributes
    • source ⇒ "modify_hosts"
    • orig_name ⇒ 'auto_placement'
    • modify_hosts_prop ⇒ 'auto_placement'
    • read_only ⇒ false
    

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

property :auto_placement, description: 'Specify whether to enable or disable auto-placement.', source: "modify_hosts", orig_name: 'auto_placement', type: [String], modify_hosts_prop: 'auto_placement', read_only: false
  • #availability_zone ⇒ [String]
    'The Availability Zone of the Dedicated Host.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'availability_zone'
    • from ⇒ String
    

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

property :availability_zone, disposition: :attribute, description: 'The Availability Zone of the Dedicated Host.', source: "MintPress::Aws::EC2::Host", orig_name: 'availability_zone', type: [String], from: String
  • #available_capacity ⇒ [MintPress::Aws::EC2::AvailableCapacity] (Default Value: MintPress::Aws::EC2::AvailableCapacity.new)
    'Information about the instances running on the Dedicated Host.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'available_capacity'
    • default ⇒ MintPress::Aws::EC2::AvailableCapacity.new
    

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

property :available_capacity, disposition: :attribute, description: 'Information about the instances running on the Dedicated Host.', source: "MintPress::Aws::EC2::Host", orig_name: 'available_capacity', type: [MintPress::Aws::EC2::AvailableCapacity], default: MintPress::Aws::EC2::AvailableCapacity.new
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'client_token'
    

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

property :client_token, disposition: :attribute, description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.', source: "MintPress::Aws::EC2::Host", orig_name: 'client_token', type: [String]
  • #host_properties ⇒ [MintPress::Aws::EC2::HostProperty] (Default Value: MintPress::Aws::EC2::HostProperty.new)
    'The hardware specifications of the Dedicated Host.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'host_properties'
    • default ⇒ MintPress::Aws::EC2::HostProperty.new
    

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

property :host_properties, disposition: :attribute, description: 'The hardware specifications of the Dedicated Host.', source: "MintPress::Aws::EC2::Host", orig_name: 'host_properties', type: [MintPress::Aws::EC2::HostProperty], default: MintPress::Aws::EC2::HostProperty.new
  • #host_recovery ⇒ [String]
    'Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide.'
    Property Attributes
    • source ⇒ "modify_hosts"
    • orig_name ⇒ 'host_recovery'
    • modify_hosts_prop ⇒ 'host_recovery'
    • read_only ⇒ false
    

34
35
36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host.rb', line 34

property :host_recovery, description: 'Indicates whether to enable or disable host recovery for the Dedicated
Host. For more information, see  Host Recovery in the Amazon
Elastic Compute Cloud User Guide.', source: "modify_hosts", orig_name: 'host_recovery', type: [String], modify_hosts_prop: 'host_recovery', read_only: false
  • #instances ⇒ Hash of ⇒ [MintPress::Aws::EC2::HostInstance]
    'The IDs and instance type that are currently running on the Dedicated Host.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'instances'
    

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

property :instances, disposition: :attribute, description: 'The IDs and instance type that are currently running on the Dedicated Host.', source: "MintPress::Aws::EC2::Host", orig_name: 'instances', type: [MintPress::Aws::EC2::HostInstance], array: false, hash: true
  • #member_of_service_linked_resource_group ⇒ [TrueClass,FalseClass]
    'Indicates whether the Dedicated Host is in a host resource group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'member_of_service_linked_resource_group'
    

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

property :member_of_service_linked_resource_group, disposition: :attribute, description: 'Indicates whether the Dedicated Host is in a host resource group.', source: "MintPress::Aws::EC2::Host", orig_name: 'member_of_service_linked_resource_group', type: [TrueClass,FalseClass]
  • #release_time ⇒ [Time]
    'The time that the Dedicated Host was released.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'release_time'
    

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

property :release_time, disposition: :attribute, description: 'The time that the Dedicated Host was released.', source: "MintPress::Aws::EC2::Host", orig_name: 'release_time', type: [Time]
  • #state ⇒ [String]
    'The Dedicated Host"s state.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The Dedicated Host"s state.', source: "MintPress::Aws::EC2::Host", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'Any tags assigned to the Dedicated Host.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'tags'
    

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

property :tags, disposition: :attribute, description: 'Any tags assigned to the Dedicated Host.', source: "MintPress::Aws::EC2::Host", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, hash: true
  • #filter ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. auto-placement - Whether auto-placement is enabled or disabled (on | off). availability-zone - The Availability Zone of the host. client-token - The idempotency token that you provided when you allocated the host. host-reservation-id - The ID of the reservation assigned to this host. instance-type - The instance type size that the Dedicated Host is configured to support. state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure). tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.'
    Property Attributes
    • describe_hosts_prop ⇒ 'filter'
    • source ⇒ "describe_hosts"
    

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host.rb', line 42

property :filter, describe_hosts_prop: 'filter', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_hosts", description: 'The filters.


auto-placement - Whether auto-placement is enabled or disabled
(on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you
allocated the host.
host-reservation-id - The ID of the reservation assigned to this
host.
instance-type - The instance type size that the Dedicated Host is
configured to support.
state - The allocation state of the Dedicated Host (available |
under-assessment | permanent-failure | released |
released-permanent-failure).
tag-key - The key of a tag assigned to the resource. Use this
filter to find all resources assigned a tag with a specific key,
regardless of the tag value.', 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 returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error. You cannot specify this parameter and the host IDs parameter in the same request.'
    Property Attributes
    • describe_hosts_prop ⇒ 'max_results'
    • source ⇒ "describe_hosts"
    

60
61
62
63
64
65
66
67
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host.rb', line 60

property :max_results, describe_hosts_prop: 'max_results', type: [Integer], source: "describe_hosts", 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 returned nextToken value. This value can be between 5 and
500. If maxResults is given a larger value than 500, you receive an
error.

You cannot specify this parameter and the host IDs parameter in the
same request.'
  • #instance_type ⇒ [String]
    'Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type. If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.'
    Property Attributes
    • modify_hosts_prop ⇒ 'instance_type'
    • read_only ⇒ false
    • source ⇒ "modify_hosts"
    

68
69
70
71
72
73
74
75
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host.rb', line 68

property :instance_type, modify_hosts_prop: 'instance_type', type: [String], read_only: false, source: "modify_hosts", description: 'Specifies the instance type to be supported by the Dedicated Host.
Specify this parameter to modify a Dedicated Host to support only a
specific instance type.

If you want to modify a Dedicated Host to support multiple instance
types in its current instance family, omit this parameter and specify
InstanceFamily instead. You cannot specify InstanceType and
InstanceFamily in the same request.'
  • #instance_family ⇒ [String]
    'Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family. If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.'
    Property Attributes
    • modify_hosts_prop ⇒ 'instance_family'
    • read_only ⇒ false
    • source ⇒ "modify_hosts"
    

76
77
78
79
80
81
82
83
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host.rb', line 76

property :instance_family, modify_hosts_prop: 'instance_family', type: [String], read_only: false, source: "modify_hosts", description: 'Specifies the instance family to be supported by the Dedicated Host.
Specify this parameter to modify a Dedicated Host to support multiple
instance types within its current instance family.

If you want to modify a Dedicated Host to support a specific instance
type only, omit this parameter and specify InstanceType instead.
You cannot specify InstanceFamily and InstanceType in the same
request.'
  • #host_reservation ⇒ [MintPress::Aws::EC2::HostReservation]
    'The reservation ID of the Dedicated Host.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'host_reservation_id'
    • from ⇒ String
    

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

property :host_reservation, disposition: :attribute, description: 'The reservation ID of the Dedicated Host.', source: "MintPress::Aws::EC2::Host", orig_name: 'host_reservation_id', type: [MintPress::Aws::EC2::HostReservation], from: String
  • #owner ⇒ [String]
    'The ID of the AWS account that owns the Dedicated Host.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::Host"
    • orig_name ⇒ 'owner_id'
    

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

property :owner, disposition: :attribute, description: 'The ID of the AWS account that owns the Dedicated Host.', source: "MintPress::Aws::EC2::Host", orig_name: 'owner_id', type: [String]
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The IDs of the Dedicated Hosts to release.'
    Property Attributes
    • describe_hosts_prop ⇒ 'host_ids'
    • source ⇒ "release_hosts"
    • modify_hosts_prop ⇒ 'host_ids'
    • read_only ⇒ false
    • release_hosts_prop ⇒ 'host_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, describe_hosts_prop: 'host_ids', type: [String], array: false, source: "release_hosts", description: 'The IDs of the Dedicated Hosts to release.', modify_hosts_prop: 'host_ids', read_only: false, release_hosts_prop: 'host_ids', hash: false, default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

property :name, type: String
  • #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 
    

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

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
    

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

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 = {}) ⇒ Host

Returns a new instance of Host.

Instance Method Details

#describe ⇒ Object

#modify ⇒ Object

#release ⇒ Object