Skip to content

/AWS1/CL_EC2FLEETDATA

Describes an EC2 Fleet.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_ACTIVITYSTATUS TYPE /AWS1/EC2FLEETACTIVITYSTATUS /AWS1/EC2FLEETACTIVITYSTATUS

The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.

IV_CREATETIME TYPE /AWS1/EC2DATETIME /AWS1/EC2DATETIME

The creation date and time of the EC2 Fleet.

IV_FLEETID TYPE /AWS1/EC2FLEETID /AWS1/EC2FLEETID

The ID of the EC2 Fleet.

IV_FLEETSTATE TYPE /AWS1/EC2FLEETSTATECODE /AWS1/EC2FLEETSTATECODE

The state of the EC2 Fleet.

IV_CLIENTTOKEN TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

Constraints: Maximum 64 ASCII characters

IV_EXCESSCAPTERMINATIONPLY TYPE /AWS1/EC2FLEETEXCESSCAPTERMI00 /AWS1/EC2FLEETEXCESSCAPTERMI00

Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

Supported only for fleets of type maintain.

IV_FULFILLEDCAPACITY TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The number of units fulfilled by this request compared to the set target capacity.

IV_FULFILLEDONDEMANDCAPACITY TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The number of units fulfilled by this request compared to the set target On-Demand capacity.

IT_LAUNCHTEMPLATECONFIGS TYPE /AWS1/CL_EC2FLEETLAUNCHTMPLCFG=>TT_FLEETLAUNCHTMPLCONFIGLIST TT_FLEETLAUNCHTMPLCONFIGLIST

The launch template and overrides.

IO_TARGETCAPACITYSPEC TYPE REF TO /AWS1/CL_EC2TARGETCAPACITYSPEC /AWS1/CL_EC2TARGETCAPACITYSPEC

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

IV_TERMINATEINSTSWITHEXPIR TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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

IV_TYPE TYPE /AWS1/EC2FLEETTYPE /AWS1/EC2FLEETTYPE

The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.

IV_VALIDFROM TYPE /AWS1/EC2DATETIME /AWS1/EC2DATETIME

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.

IV_VALIDUNTIL TYPE /AWS1/EC2DATETIME /AWS1/EC2DATETIME

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.

IV_REPLACEUNHEALTHYINSTANCES TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

IO_SPOTOPTIONS TYPE REF TO /AWS1/CL_EC2SPOTOPTIONS /AWS1/CL_EC2SPOTOPTIONS

The configuration of Spot Instances in an EC2 Fleet.

IO_ONDEMANDOPTIONS TYPE REF TO /AWS1/CL_EC2ONDEMANDOPTIONS /AWS1/CL_EC2ONDEMANDOPTIONS

The allocation strategy of On-Demand Instances in an EC2 Fleet.

IT_TAGS TYPE /AWS1/CL_EC2TAG=>TT_TAGLIST TT_TAGLIST

The tags for an EC2 Fleet resource.

IT_ERRORS TYPE /AWS1/CL_EC2DESCRIBEFLEETERROR=>TT_DESCRIBEFLEETSERRORSET TT_DESCRIBEFLEETSERRORSET

Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.

IT_INSTANCES TYPE /AWS1/CL_EC2DESCRFLEETSINSTS=>TT_DESCRIBEFLEETSINSTANCESSET TT_DESCRIBEFLEETSINSTANCESSET

Information about the instances that were launched by the fleet. Valid only when Type is set to instant.

IV_CONTEXT TYPE /AWS1/EC2STRING /AWS1/EC2STRING

Reserved.


Queryable Attributes

ActivityStatus

The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.

Accessible with the following methods

Method Description
GET_ACTIVITYSTATUS() Getter for ACTIVITYSTATUS, with configurable default
ASK_ACTIVITYSTATUS() Getter for ACTIVITYSTATUS w/ exceptions if field has no valu
HAS_ACTIVITYSTATUS() Determine if ACTIVITYSTATUS has a value

CreateTime

The creation date and time of the EC2 Fleet.

Accessible with the following methods

Method Description
GET_CREATETIME() Getter for CREATETIME, with configurable default
ASK_CREATETIME() Getter for CREATETIME w/ exceptions if field has no value
HAS_CREATETIME() Determine if CREATETIME has a value

FleetId

The ID of the EC2 Fleet.

Accessible with the following methods

Method Description
GET_FLEETID() Getter for FLEETID, with configurable default
ASK_FLEETID() Getter for FLEETID w/ exceptions if field has no value
HAS_FLEETID() Determine if FLEETID has a value

FleetState

The state of the EC2 Fleet.

Accessible with the following methods

Method Description
GET_FLEETSTATE() Getter for FLEETSTATE, with configurable default
ASK_FLEETSTATE() Getter for FLEETSTATE w/ exceptions if field has no value
HAS_FLEETSTATE() Determine if FLEETSTATE has a value

ClientToken

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

Constraints: Maximum 64 ASCII characters

Accessible with the following methods

Method Description
GET_CLIENTTOKEN() Getter for CLIENTTOKEN, with configurable default
ASK_CLIENTTOKEN() Getter for CLIENTTOKEN w/ exceptions if field has no value
HAS_CLIENTTOKEN() Determine if CLIENTTOKEN has a value

ExcessCapacityTerminationPolicy

Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

Supported only for fleets of type maintain.

Accessible with the following methods

Method Description
GET_EXCESSCAPTERMINATIONPLY() Getter for EXCESSCAPTERMINATIONPOLICY, with configurable def
ASK_EXCESSCAPTERMINATIONPLY() Getter for EXCESSCAPTERMINATIONPOLICY w/ exceptions if field
HAS_EXCESSCAPTERMINATIONPLY() Determine if EXCESSCAPTERMINATIONPOLICY has a value

FulfilledCapacity

The number of units fulfilled by this request compared to the set target capacity.

Accessible with the following methods

Method Description
GET_FULFILLEDCAPACITY() Getter for FULFILLEDCAPACITY, with configurable default
ASK_FULFILLEDCAPACITY() Getter for FULFILLEDCAPACITY w/ exceptions if field has no v
STR_FULFILLEDCAPACITY() String format for FULFILLEDCAPACITY, with configurable defau
HAS_FULFILLEDCAPACITY() Determine if FULFILLEDCAPACITY has a value

FulfilledOnDemandCapacity

The number of units fulfilled by this request compared to the set target On-Demand capacity.

Accessible with the following methods

Method Description
GET_FULFILLEDONDEMANDCAP() Getter for FULFILLEDONDEMANDCAPACITY, with configurable defa
ASK_FULFILLEDONDEMANDCAP() Getter for FULFILLEDONDEMANDCAPACITY w/ exceptions if field
STR_FULFILLEDONDEMANDCAP() String format for FULFILLEDONDEMANDCAPACITY, with configurab
HAS_FULFILLEDONDEMANDCAP() Determine if FULFILLEDONDEMANDCAPACITY has a value

LaunchTemplateConfigs

The launch template and overrides.

Accessible with the following methods

Method Description
GET_LAUNCHTEMPLATECONFIGS() Getter for LAUNCHTEMPLATECONFIGS, with configurable default
ASK_LAUNCHTEMPLATECONFIGS() Getter for LAUNCHTEMPLATECONFIGS w/ exceptions if field has
HAS_LAUNCHTEMPLATECONFIGS() Determine if LAUNCHTEMPLATECONFIGS has a value

TargetCapacitySpecification

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

Accessible with the following methods

Method Description
GET_TARGETCAPACITYSPEC() Getter for TARGETCAPACITYSPECIFICATION

TerminateInstancesWithExpiration

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

Accessible with the following methods

Method Description
GET_TERMINATEINSTSWITHEXPIR() Getter for TERMINATEINSTANCESWITHEXPIR, with configurable de
ASK_TERMINATEINSTSWITHEXPIR() Getter for TERMINATEINSTANCESWITHEXPIR w/ exceptions if fiel
HAS_TERMINATEINSTSWITHEXPIR() Determine if TERMINATEINSTANCESWITHEXPIR has a value

Type

The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.

Accessible with the following methods

Method Description
GET_TYPE() Getter for TYPE, with configurable default
ASK_TYPE() Getter for TYPE w/ exceptions if field has no value
HAS_TYPE() Determine if TYPE has a value

ValidFrom

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.

Accessible with the following methods

Method Description
GET_VALIDFROM() Getter for VALIDFROM, with configurable default
ASK_VALIDFROM() Getter for VALIDFROM w/ exceptions if field has no value
HAS_VALIDFROM() Determine if VALIDFROM has a value

ValidUntil

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.

Accessible with the following methods

Method Description
GET_VALIDUNTIL() Getter for VALIDUNTIL, with configurable default
ASK_VALIDUNTIL() Getter for VALIDUNTIL w/ exceptions if field has no value
HAS_VALIDUNTIL() Determine if VALIDUNTIL has a value

ReplaceUnhealthyInstances

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.

Accessible with the following methods

Method Description
GET_REPLACEUNHEALTHYINSTS() Getter for REPLACEUNHEALTHYINSTANCES, with configurable defa
ASK_REPLACEUNHEALTHYINSTS() Getter for REPLACEUNHEALTHYINSTANCES w/ exceptions if field
HAS_REPLACEUNHEALTHYINSTS() Determine if REPLACEUNHEALTHYINSTANCES has a value

SpotOptions

The configuration of Spot Instances in an EC2 Fleet.

Accessible with the following methods

Method Description
GET_SPOTOPTIONS() Getter for SPOTOPTIONS

OnDemandOptions

The allocation strategy of On-Demand Instances in an EC2 Fleet.

Accessible with the following methods

Method Description
GET_ONDEMANDOPTIONS() Getter for ONDEMANDOPTIONS

Tags

The tags for an EC2 Fleet resource.

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS has a value

Errors

Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.

Accessible with the following methods

Method Description
GET_ERRORS() Getter for ERRORS, with configurable default
ASK_ERRORS() Getter for ERRORS w/ exceptions if field has no value
HAS_ERRORS() Determine if ERRORS has a value

Instances

Information about the instances that were launched by the fleet. Valid only when Type is set to instant.

Accessible with the following methods

Method Description
GET_INSTANCES() Getter for INSTANCES, with configurable default
ASK_INSTANCES() Getter for INSTANCES w/ exceptions if field has no value
HAS_INSTANCES() Determine if INSTANCES has a value

Context

Reserved.

Accessible with the following methods

Method Description
GET_CONTEXT() Getter for CONTEXT, with configurable default
ASK_CONTEXT() Getter for CONTEXT w/ exceptions if field has no value
HAS_CONTEXT() Determine if CONTEXT has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_FLEETSET

TYPES TT_FLEETSET TYPE STANDARD TABLE OF REF TO /AWS1/CL_EC2FLEETDATA WITH DEFAULT KEY
.