Class: MintPress::Aws::EC2::Fleet

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fleet.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
    • create_fleet_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "modify_fleet"
    • delete_fleets_prop ⇒ 'dry_run'
    • describe_fleets_prop ⇒ 'dry_run'
    • modify_fleet_prop ⇒ 'dry_run'
    

29
30
31
32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fleet.rb', line 29

property :dry_run, create_fleet_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "modify_fleet", 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.', delete_fleets_prop: 'dry_run', describe_fleets_prop: 'dry_run', modify_fleet_prop: 'dry_run'
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
    Property Attributes
    • create_fleet_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_fleet"
    

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

property :client_token, create_fleet_prop: 'client_token', type: [String], read_only: false, source: "create_fleet", description: 'Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring
Idempotency.'
  • #spot_options ⇒ [MintPress::Aws::EC2::SpotOption] (Default Value: MintPress::Aws::EC2::SpotOption.new)
    'Describes the configuration of Spot Instances in an EC2 Fleet.'
    Property Attributes
    • create_fleet_prop ⇒ 'spot_options'
    • default ⇒ MintPress::Aws::EC2::SpotOption.new
    • read_only ⇒ false
    • source ⇒ "create_fleet"
    

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

property :spot_options, create_fleet_prop: 'spot_options', type: [MintPress::Aws::EC2::SpotOption], default: MintPress::Aws::EC2::SpotOption.new, read_only: false, source: "create_fleet", description: 'Describes the configuration of Spot Instances in an EC2 Fleet.'
  • #on_demand_options ⇒ [MintPress::Aws::EC2::OnDemandOption] (Default Value: MintPress::Aws::EC2::OnDemandOption.new)
    'Describes the configuration of On-Demand Instances in an EC2 Fleet.'
    Property Attributes
    • create_fleet_prop ⇒ 'on_demand_options'
    • default ⇒ MintPress::Aws::EC2::OnDemandOption.new
    • read_only ⇒ false
    • source ⇒ "create_fleet"
    

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

property :on_demand_options, create_fleet_prop: 'on_demand_options', type: [MintPress::Aws::EC2::OnDemandOption], default: MintPress::Aws::EC2::OnDemandOption.new, read_only: false, source: "create_fleet", description: 'Describes the configuration of On-Demand Instances in an EC2 Fleet.'
  • #excess_capacity_termination_policy ⇒ [String]
    'Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.'
    Property Attributes
    • create_fleet_prop ⇒ 'excess_capacity_termination_policy'
    • read_only ⇒ false
    • source ⇒ "modify_fleet"
    • modify_fleet_prop ⇒ 'excess_capacity_termination_policy'
    

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

property :excess_capacity_termination_policy, create_fleet_prop: 'excess_capacity_termination_policy', type: [String], read_only: false, source: "modify_fleet", description: 'Indicates whether running instances should be terminated if the total
target capacity of the EC2 Fleet is decreased below the current size
of the EC2 Fleet.', modify_fleet_prop: 'excess_capacity_termination_policy'
  • #launch_template_configs ⇒ Array of ⇒ [MintPress::Aws::EC2::FleetLaunchTemplateConfig]
    'The launch template and overrides.'
    Property Attributes
    • create_fleet_prop ⇒ 'launch_template_configs'
    • read_only ⇒ false
    • source ⇒ "modify_fleet"
    • modify_fleet_prop ⇒ 'launch_template_configs'
    

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

property :launch_template_configs, create_fleet_prop: 'launch_template_configs', type: [MintPress::Aws::EC2::FleetLaunchTemplateConfig], array: true, read_only: false, source: "modify_fleet", description: 'The launch template and overrides.', modify_fleet_prop: 'launch_template_configs'
  • #target_capacity ⇒ [MintPress::Aws::EC2::TargetCapacity] (Default Value: MintPress::Aws::EC2::TargetCapacity.new)
    'The size of the EC2 Fleet.'
    Property Attributes
    • create_fleet_prop ⇒ 'target_capacity_specification'
    • default ⇒ MintPress::Aws::EC2::TargetCapacity.new
    • read_only ⇒ false
    • source ⇒ "modify_fleet"
    • modify_fleet_prop ⇒ 'target_capacity_specification'
    

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

property :target_capacity, create_fleet_prop: 'target_capacity_specification', type: [MintPress::Aws::EC2::TargetCapacity], default: MintPress::Aws::EC2::TargetCapacity.new, read_only: false, source: "modify_fleet", description: 'The size of the EC2 Fleet.', modify_fleet_prop: 'target_capacity_specification'
  • #terminate_instances_with_expiration ⇒ [TrueClass,FalseClass]
    'Indicates whether running instances should be terminated when the EC2 Fleet expires.'
    Property Attributes
    • create_fleet_prop ⇒ 'terminate_instances_with_expiration'
    • read_only ⇒ false
    • source ⇒ "create_fleet"
    

43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fleet.rb', line 43

property :terminate_instances_with_expiration, create_fleet_prop: 'terminate_instances_with_expiration', type: [TrueClass,FalseClass], read_only: false, source: "create_fleet", description: 'Indicates whether running instances should be terminated when the EC2
Fleet expires.'
  • #type ⇒ [String]
    'The type of request. The default value is maintain. maintain - The EC2 Fleet plaees an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances. request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted. instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched. For more information, see EC2 Fleet request types in the Amazon Elastic Compute Cloud User Guide.'
    Property Attributes
    • create_fleet_prop ⇒ 'type'
    • read_only ⇒ false
    • source ⇒ "create_fleet"
    

45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fleet.rb', line 45

property :type, create_fleet_prop: 'type', type: [String], read_only: false, source: "create_fleet", description: 'The type of request. The default value is maintain.


maintain - The EC2 Fleet plaees an asynchronous request for your
desired capacity, and continues to maintain your desired Spot
capacity by replenishing interrupted Spot Instances.
request - The EC2 Fleet places an asynchronous one-time request
for your desired capacity, but does submit Spot requests in
alternative capacity pools if Spot capacity is unavailable, and does
not maintain Spot capacity if Spot Instances are interrupted.
instant - The EC2 Fleet places a synchronous one-time request for
your desired capacity, and returns errors for any instances that
could not be launched.



For more information, see EC2 Fleet request types in the Amazon
Elastic Compute Cloud User Guide.'
  • #valid_from ⇒ [Time,DateTime,Integer]
    'The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.'
    Property Attributes
    • create_fleet_prop ⇒ 'valid_from'
    • read_only ⇒ false
    • source ⇒ "create_fleet"
    

63
64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fleet.rb', line 63

property :valid_from, create_fleet_prop: 'valid_from', type: [Time,DateTime,Integer], read_only: false, source: "create_fleet", description: 'The start date and time of the request, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ). The default is to start
fulfilling the request immediately.'
  • #valid_until ⇒ [Time,DateTime,Integer]
    'The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.'
    Property Attributes
    • create_fleet_prop ⇒ 'valid_until'
    • read_only ⇒ false
    • source ⇒ "create_fleet"
    

66
67
68
69
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fleet.rb', line 66

property :valid_until, create_fleet_prop: 'valid_until', type: [Time,DateTime,Integer], read_only: false, source: "create_fleet", description: 'The end date and time of the request, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet
requests are placed or able to fulfill the request. If no value is
specified, the request remains until you cancel it.'
  • #replace_unhealthy_instances ⇒ [TrueClass,FalseClass]
    'Indicates whether EC2 Fleet should replace unhealthy instances.'
    Property Attributes
    • create_fleet_prop ⇒ 'replace_unhealthy_instances'
    • read_only ⇒ false
    • source ⇒ "create_fleet"
    

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

property :replace_unhealthy_instances, create_fleet_prop: 'replace_unhealthy_instances', type: [TrueClass,FalseClass], read_only: false, source: "create_fleet", description: 'Indicates whether EC2 Fleet should replace unhealthy instances.'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging your resources.'
    Property Attributes
    • create_fleet_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    • source ⇒ "create_fleet"
    

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

property :tags, create_fleet_prop: 'tag_specifications', type: [MintPress::Aws::EC2::Tag], array: false, read_only: false, source: "create_fleet", description: 'The key-value pair for tagging the EC2 Fleet request on creation. The
value for ResourceType must be fleet, otherwise the fleet request
fails. To tag instances at launch, specify the tags in the launch
template. For information about tagging after launch, see Tagging
your resources.', hash: true
  • #terminate_instances ⇒ [TrueClass,FalseClass]
    'Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances. To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances. Supported only for fleets of type maintain and request. For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.'
    Property Attributes
    • delete_fleets_prop ⇒ 'terminate_instances'
    • read_only ⇒ false
    • source ⇒ "delete_fleets"
    

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

property :terminate_instances, delete_fleets_prop: 'terminate_instances', type: [TrueClass,FalseClass], read_only: false, source: "delete_fleets", description: 'Indicates whether to terminate the instances when the EC2 Fleet is
deleted. The default is to terminate the instances.

To let the instances continue to run after the EC2 Fleet is deleted,
specify NoTerminateInstances. Supported only for fleets of type
maintain and request.

For instant fleets, you cannot specify NoTerminateInstances. A
deleted instant fleet with running instances is not supported.'
  • #max_results ⇒ [Integer]
    'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
    Property Attributes
    • describe_fleets_prop ⇒ 'max_results'
    • source ⇒ "describe_fleets"
    

85
86
87
88
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fleet.rb', line 85

property :max_results, describe_fleets_prop: 'max_results', type: [Integer], source: "describe_fleets", description: 'The maximum number of results to return in a single call. Specify a
value between 1 and 1000. The default value is 1000. To retrieve the
remaining results, make another call with the returned NextToken
value.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled). excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false). fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying). replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false). type - The type of request (instant | request | maintain).'
    Property Attributes
    • describe_fleets_prop ⇒ 'filters'
    • source ⇒ "describe_fleets"
    

89
90
91
92
93
94
95
96
97
98
99
100
101
102
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/fleet.rb', line 89

property :filters, describe_fleets_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_fleets", description: 'The filters.


activity-status - The progress of the EC2 Fleet ( error |
pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to
terminate running instances if the target capacity is decreased
below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active
| deleted | failed | deleted-running |
deleted-terminating | modifying).
replace-unhealthy-instances - Indicates whether EC2 Fleet should
replace unhealthy instances (true | false).
type - The type of request (instant | request | maintain).', hash: true
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The ID of the EC2 Fleet.'
    Property Attributes
    • delete_fleets_prop ⇒ 'fleet_ids'
    • read_only ⇒ false
    • source ⇒ "modify_fleet"
    • describe_fleets_prop ⇒ 'fleet_ids'
    • modify_fleet_prop ⇒ 'fleet_id'
    • default ⇒ Proc.new { self.name }
    

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

property :id, delete_fleets_prop: 'fleet_ids', type: [String], array: false, read_only: false, source: "modify_fleet", description: 'The ID of the EC2 Fleet.', describe_fleets_prop: 'fleet_ids', hash: false, modify_fleet_prop: 'fleet_id', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of Fleet.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object