placement_groups

Creates, updates, deletes or gets a placement_group resource or lists placement_groups in a region

Overview

Name	placement_groups
Type	Resource
Description	Resource Type definition for AWS::EC2::PlacementGroup
Id	awscc.ec2.placement_groups

Fields

get (all properties)

Name	Datatype	Description
strategy	string	The placement strategy.
group_name	string	The Group Name of Placement Group.
spread_level	string	The Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread
partition_count	integer	The number of partitions. Valid only when Strategy is set to partition
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
group_name	string	The Group Name of Placement Group.
region	string	AWS region.

For more information, see AWS::EC2::PlacementGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	placement_groups	INSERT	region
delete_resource	placement_groups	DELETE	Identifier, region
list_resources	placement_groups_list_only	SELECT	region
get_resource	placement_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual placement_group.

SELECT
  region,
  strategy,
  group_name,
  spread_level,
  partition_count,
  tags
FROM awscc.ec2.placement_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ group_name }}';

list (identifiers only)

Lists all placement_groups in a region.

SELECT
  region,
  group_name
FROM awscc.ec2.placement_groups_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new placement_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ec2.placement_groups (
  Strategy,
  SpreadLevel,
  PartitionCount,
  Tags,
  region
)
SELECT
  '{{ strategy }}',
  '{{ spread_level }}',
  '{{ partition_count }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.placement_groups (
  Strategy,
  SpreadLevel,
  PartitionCount,
  Tags,
  region
)
SELECT
  '{{ strategy }}',
  '{{ spread_level }}',
  '{{ partition_count }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: placement_group
  props:
    - name: strategy
      value: '{{ strategy }}'
    - name: spread_level
      value: '{{ spread_level }}'
    - name: partition_count
      value: '{{ partition_count }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.placement_groups
WHERE
  Identifier = '{{ group_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the placement_groups resource, the following permissions are required:

Create

ec2:CreatePlacementGroup,
ec2:DescribePlacementGroups,
ec2:CreateTags

Read

ec2:DescribePlacementGroups

Delete

ec2:DeletePlacementGroup,
ec2:DescribePlacementGroups

List

ec2:DescribePlacementGroups