Skip to content

/AWS1/IF_EC2=>CREATEPLACEMENTGROUP()

About CreatePlacementGroup

Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.

A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.

For more information, see Placement groups in the Amazon EC2 User Guide.

Method Signature

METHODS /AWS1/IF_EC2~CREATEPLACEMENTGROUP
  IMPORTING
    !IV_PARTITIONCOUNT TYPE /AWS1/EC2INTEGER OPTIONAL
    !IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST OPTIONAL
    !IV_SPREADLEVEL TYPE /AWS1/EC2SPREADLEVEL OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_GROUPNAME TYPE /AWS1/EC2STRING OPTIONAL
    !IV_STRATEGY TYPE /AWS1/EC2PLACEMENTSTRATEGY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2creplcmtgrouprslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_partitioncount TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

The number of partitions. Valid only when Strategy is set to partition.

it_tagspecifications TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST TT_TAGSPECIFICATIONLIST

The tags to apply to the new placement group.

iv_spreadlevel TYPE /AWS1/EC2SPREADLEVEL /AWS1/EC2SPREADLEVEL

Determines how placement groups spread instances.

  • Host – You can use host only with Outpost placement groups.

  • Rack – No usage restrictions.

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Checks whether you have the required permissions for the operation, 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.

iv_groupname TYPE /AWS1/EC2STRING /AWS1/EC2STRING

A name for the placement group. Must be unique within the scope of your account for the Region.

Constraints: Up to 255 ASCII characters

iv_strategy TYPE /AWS1/EC2PLACEMENTSTRATEGY /AWS1/EC2PLACEMENTSTRATEGY

The placement strategy.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2creplcmtgrouprslt /AWS1/CL_EC2CREPLCMTGROUPRSLT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createplacementgroup(
  it_tagspecifications = VALUE /aws1/cl_ec2tagspecification=>tt_tagspecificationlist(
    (
      new /aws1/cl_ec2tagspecification(
        it_tags = VALUE /aws1/cl_ec2tag=>tt_taglist(
          (
            new /aws1/cl_ec2tag(
              iv_key = |string|
              iv_value = |string|
            )
          )
        )
        iv_resourcetype = |string|
      )
    )
  )
  iv_dryrun = ABAP_TRUE
  iv_groupname = |string|
  iv_partitioncount = 123
  iv_spreadlevel = |string|
  iv_strategy = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_placementgroup = lo_result->get_placementgroup( ).
  IF lo_placementgroup IS NOT INITIAL.
    lv_string = lo_placementgroup->get_groupname( ).
    lv_placementgroupstate = lo_placementgroup->get_state( ).
    lv_placementstrategy = lo_placementgroup->get_strategy( ).
    lv_integer = lo_placementgroup->get_partitioncount( ).
    lv_string = lo_placementgroup->get_groupid( ).
    LOOP AT lo_placementgroup->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_key( ).
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_placementgroup->get_grouparn( ).
    lv_spreadlevel = lo_placementgroup->get_spreadlevel( ).
  ENDIF.
ENDIF.

To create a placement group

This example creates a placement group with the specified name.

DATA(lo_result) = lo_client->createplacementgroup(
  iv_groupname = |my-cluster|
  iv_strategy = |cluster|
).