rotations

Creates, updates, deletes or gets a rotation resource or lists rotations in a region

Overview

Name	rotations
Type	Resource
Description	Resource Type definition for AWS::SSMContacts::Rotation.
Id	awscc.ssmcontacts.rotations

Fields

get (all properties)

Name	Datatype	Description
name	string	Name of the Rotation
contact_ids	array	Members of the rotation
start_time	string	Start time of the first shift of Oncall Schedule
time_zone_id	string	TimeZone Identifier for the Oncall Schedule
▶recurrence	object	Information about when an on-call rotation is in effect and how long the rotation period lasts.
▶tags	array
arn	string	The Amazon Resource Name (ARN) of the rotation.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the rotation.
region	string	AWS region.

For more information, see AWS::SSMContacts::Rotation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	rotations	INSERT	Name, ContactIds, StartTime, TimeZoneId, Recurrence, region
delete_resource	rotations	DELETE	Identifier, region
update_resource	rotations	UPDATE	Identifier, PatchDocument, region
list_resources	rotations_list_only	SELECT	region
get_resource	rotations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual rotation.

SELECT
  region,
  name,
  contact_ids,
  start_time,
  time_zone_id,
  recurrence,
  tags,
  arn
FROM awscc.ssmcontacts.rotations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all rotations in a region.

SELECT
  region,
  arn
FROM awscc.ssmcontacts.rotations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ssmcontacts.rotations (
  Name,
  ContactIds,
  StartTime,
  TimeZoneId,
  Recurrence,
  region
)
SELECT
  '{{ name }}',
  '{{ contact_ids }}',
  '{{ start_time }}',
  '{{ time_zone_id }}',
  '{{ recurrence }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ssmcontacts.rotations (
  Name,
  ContactIds,
  StartTime,
  TimeZoneId,
  Recurrence,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ contact_ids }}',
  '{{ start_time }}',
  '{{ time_zone_id }}',
  '{{ recurrence }}',
  '{{ 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: rotation
  props:
    - name: name
      value: '{{ name }}'
    - name: contact_ids
      value:
        - '{{ contact_ids[0] }}'
    - name: start_time
      value: '{{ start_time }}'
    - name: time_zone_id
      value: '{{ time_zone_id }}'
    - name: recurrence
      value:
        monthly_settings:
          - day_of_month: '{{ day_of_month }}'
            hand_off_time: '{{ hand_off_time }}'
        weekly_settings:
          - day_of_week: '{{ day_of_week }}'
            hand_off_time: null
        daily_settings:
          - null
        number_of_on_calls: '{{ number_of_on_calls }}'
        recurrence_multiplier: '{{ recurrence_multiplier }}'
        shift_coverages:
          - day_of_week: null
            coverage_times:
              - start_time: null
                end_time: null
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a rotation resource, using stack-deploy.

/*+ update */
UPDATE awscc.ssmcontacts.rotations
SET PatchDocument = string('{{ {
    "Name": name,
    "ContactIds": contact_ids,
    "StartTime": start_time,
    "TimeZoneId": time_zone_id,
    "Recurrence": recurrence,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ssmcontacts.rotations
WHERE
  Identifier = '{{ arn }}' 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 rotations resource, the following permissions are required:

Create

ssm-contacts:CreateRotation,
ssm-contacts:GetRotation,
ssm-contacts:TagResource,
ssm-contacts:ListTagsForResource

Read

ssm-contacts:GetRotation,
ssm-contacts:ListTagsForResource

Update

ssm-contacts:UpdateRotation,
ssm-contacts:GetRotation,
ssm-contacts:TagResource,
ssm-contacts:ListTagsForResource,
ssm-contacts:UntagResource

Delete

ssm-contacts:DeleteRotation,
ssm-contacts:GetRotation,
ssm-contacts:ListTagsForResource,
ssm-contacts:UntagResource

List

ssm-contacts:ListRotations,
ssm-contacts:GetRotation,
ssm-contacts:ListTagsForResource