Skip to content

Creates a placement group in which to launch instances

Description

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. A precision-time placement group places instances on supported hardware with direct access to high-precision time sources in Amazon Web Services infrastructure.

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

Usage

ec2_create_placement_group(PartitionCount, TagSpecifications,
  SpreadLevel, LinkedGroupId, Operator, ParentGroupId, DryRun, GroupName,
  Strategy)

Arguments

  • PartitionCount

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

  • TagSpecifications

    The tags to apply to the new placement group.

  • SpreadLevel

    Determines how placement groups spread instances.

    • Host – You can use host only with Outpost placement groups.
    • Rack – No usage restrictions.

  • LinkedGroupId

    Reserved for future use.

  • Operator

    Reserved for internal use.

  • ParentGroupId

    The ID of a parent placement group. Valid only when Strategy is set to cluster.

  • DryRun

    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.

  • GroupName

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

    Constraints: Up to 255 ASCII characters

  • Strategy

    The placement strategy.

Value

A list with the following syntax:

list(
  PlacementGroup = list(
    GroupName = "string",
    State = "pending"|"available"|"deleting"|"deleted",
    Strategy = "cluster"|"spread"|"partition"|"precision-time",
    PartitionCount = 123,
    GroupId = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    GroupArn = "string",
    SpreadLevel = "host"|"rack",
    LinkedGroupId = "string",
    Operator = list(
      Managed = TRUE|FALSE,
      Principal = "string",
      HiddenByDefault = TRUE|FALSE
    ),
    ParentGroupId = "string"
  )
)

Request syntax

svc$create_placement_group(
  PartitionCount = 123,
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"image-usage-report"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-metering-policy"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"vpc-encryption-control"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"capacity-block"|"mac-modification-task"|"ipam-prefix-list-resolver"|"ipam-policy"|"ipam-prefix-list-resolver-target"|"ipam-internet-registry-association"|"secondary-interface"|"secondary-network"|"secondary-subnet"|"capacity-manager-data-export"|"vpn-concentrator"|"ipam-pool-allocation"|"capacity-reservation-cancellation-quote"|"application-status-check"|"capacity-reservation-modification-quote",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  SpreadLevel = "host"|"rack",
  LinkedGroupId = "string",
  Operator = list(
    Principal = "string"
  ),
  ParentGroupId = "string",
  DryRun = TRUE|FALSE,
  GroupName = "string",
  Strategy = "cluster"|"spread"|"partition"|"precision-time"
)

Examples

# This example creates a placement group with the specified name.
svc$create_placement_group(
  GroupName = "my-cluster",
  Strategy = "cluster"
)