Class: Aws::EC2::Types::CreateFleetRequest

Inherits:

Struct

Object
Struct
Aws::EC2::Types::CreateFleetRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ec2/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#client_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
#context ⇒ String

Reserved.
#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
#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.
#launch_template_configs ⇒ Array<Types::FleetLaunchTemplateConfigRequest>

The configuration for the EC2 Fleet.
#on_demand_options ⇒ Types::OnDemandOptionsRequest

Describes the configuration of On-Demand Instances in an EC2 Fleet.
#replace_unhealthy_instances ⇒ Boolean

Indicates whether EC2 Fleet should replace unhealthy Spot Instances.
#spot_options ⇒ Types::SpotOptionsRequest

Describes the configuration of Spot Instances in an EC2 Fleet.
#tag_specifications ⇒ Array<Types::TagSpecification>

The key-value pair for tagging the EC2 Fleet request on creation.
#target_capacity_specification ⇒ Types::TargetCapacitySpecificationRequest

The number of units to request.
#terminate_instances_with_expiration ⇒ Boolean

Indicates whether running instances should be terminated when the EC2 Fleet expires.
#type ⇒ String

The fleet type.
#valid_from ⇒ Time

The start date and time of the request, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z).
#valid_until ⇒ Time

The end date and time of the request, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z).

Instance Attribute Details

#client_token ⇒ `String`

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

(String)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#context ⇒ `String`

Reserved.

Returns:

(String)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ `Boolean`

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`.

Returns:

(Boolean)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Supported only for fleets of type ‘maintain`.

Returns:

(String)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#launch_template_configs ⇒ `Array<Types::FleetLaunchTemplateConfigRequest>`

The configuration for the EC2 Fleet.

Returns:

(Array<Types::FleetLaunchTemplateConfigRequest>)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_options ⇒ `Types::OnDemandOptionsRequest`

Describes the configuration of On-Demand Instances in an EC2 Fleet.

Returns:

(Types::OnDemandOptionsRequest)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#replace_unhealthy_instances ⇒ `Boolean`

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type ‘maintain`. For more information, see [EC2 Fleet health checks] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks

Returns:

(Boolean)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#spot_options ⇒ `Types::SpotOptionsRequest`

Describes the configuration of Spot Instances in an EC2 Fleet.

Returns:

(Types::SpotOptionsRequest)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ `Array<Types::TagSpecification>`

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see [Tag your resources].

If the fleet type is ‘instant`, specify a resource type of `fleet` to tag the fleet or `instance` to tag the instances at launch.

If the fleet type is ‘maintain` or `request`, specify a resource type of `fleet` to tag the fleet. You cannot specify a resource type of `instance`. To tag instances at launch, specify the tags in a [launch template].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template

Returns:

(Array<Types::TagSpecification>)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#target_capacity_specification ⇒ `Types::TargetCapacitySpecificationRequest`

The number of units to request.

Returns:

(Types::TargetCapacitySpecificationRequest)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#terminate_instances_with_expiration ⇒ `Boolean`

Indicates whether running instances should be terminated when the EC2 Fleet expires.

Returns:

(Boolean)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ `String`

The fleet type. The default value is ‘maintain`.

‘maintain` - The EC2 Fleet places 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 EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html

Returns:

(String)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#valid_from ⇒ `Time`

The start date and time of the request, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z). The default is to start fulfilling the request immediately.

Returns:

(Time)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#valid_until ⇒ `Time`

The end date and time of the request, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z). 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.

Returns:

(Time)

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

class CreateFleetRequest < Struct.new(
  :dry_run,
  :client_token,
  :spot_options,
  :on_demand_options,
  :excess_capacity_termination_policy,
  :launch_template_configs,
  :target_capacity_specification,
  :terminate_instances_with_expiration,
  :type,
  :valid_from,
  :valid_until,
  :replace_unhealthy_instances,
  :tag_specifications,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::EC2::Types::CreateFleetRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

#context ⇒ String

#dry_run ⇒ Boolean

#excess_capacity_termination_policy ⇒ String

#launch_template_configs ⇒ Array<Types::FleetLaunchTemplateConfigRequest>

#on_demand_options ⇒ Types::OnDemandOptionsRequest

#replace_unhealthy_instances ⇒ Boolean

#spot_options ⇒ Types::SpotOptionsRequest

#tag_specifications ⇒ Array<Types::TagSpecification>

#target_capacity_specification ⇒ Types::TargetCapacitySpecificationRequest

#terminate_instances_with_expiration ⇒ Boolean

#type ⇒ String

#valid_from ⇒ Time

#valid_until ⇒ Time

#client_token ⇒ `String`

#context ⇒ `String`

#dry_run ⇒ `Boolean`

#excess_capacity_termination_policy ⇒ `String`

#launch_template_configs ⇒ `Array<Types::FleetLaunchTemplateConfigRequest>`

#on_demand_options ⇒ `Types::OnDemandOptionsRequest`

#replace_unhealthy_instances ⇒ `Boolean`

#spot_options ⇒ `Types::SpotOptionsRequest`

#tag_specifications ⇒ `Array<Types::TagSpecification>`

#target_capacity_specification ⇒ `Types::TargetCapacitySpecificationRequest`

#terminate_instances_with_expiration ⇒ `Boolean`

#type ⇒ `String`

#valid_from ⇒ `Time`

#valid_until ⇒ `Time`