rotation_overrides

Creates, updates, deletes, gets or lists a rotation_overrides resource.

Overview

Name	rotation_overrides
Type	Resource
Id	aws.ssm_contacts.rotation_overrides

Fields

The following fields are returned by SELECT queries:

list_rotation_overrides

Name	Datatype	Description
create_time	string (date-time)	The time a rotation override was created.
end_time	string (date-time)	The time a rotation override ends.
new_contact_ids	array	The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
rotation_override_id	string	The Amazon Resource Name (ARN) of the override to an on-call rotation. (pattern: <code>([a-fA-Z0-9]{8,11}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}</code>)
start_time	string (date-time)	The time a rotation override begins.

get_rotation_override

Name	Datatype	Description
create_time	string (date-time)	The date and time when the override was created.
end_time	string (date-time)	The date and time when the override ends.
new_contact_ids	array	The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
rotation_arn	string	The Amazon Resource Name (ARN) of the on-call rotation that was overridden. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=/,.@]:[0-9]+:([\w+=/,.@:-]+)</code>)
rotation_override_id	string	The Amazon Resource Name (ARN) of the override to an on-call rotation. (pattern: <code>([a-fA-Z0-9]{8,11}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}</code>)
start_time	string (date-time)	The date and time when the override goes into effect.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_rotation_overrides	select	region		Retrieves a list of overrides currently specified for an on-call rotation.
get_rotation_override	select	region		Retrieves information about an override to an on-call rotation.
create_rotation_override	insert	region, RotationId, NewContactIds, StartTime, EndTime		Creates an override for a rotation in an on-call schedule.
delete_rotation_override	delete	region		Deletes an existing override for an on-call rotation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_rotation_overrides

Retrieves a list of overrides currently specified for an on-call rotation.

SELECT
create_time,
end_time,
new_contact_ids,
rotation_override_id,
start_time
FROM aws.ssm_contacts.rotation_overrides
WHERE region = '{{ region }}' -- required
;

get_rotation_override

Retrieves information about an override to an on-call rotation.

SELECT
create_time,
end_time,
new_contact_ids,
rotation_arn,
rotation_override_id,
start_time
FROM aws.ssm_contacts.rotation_overrides
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_rotation_override

Creates an override for a rotation in an on-call schedule.

INSERT INTO aws.ssm_contacts.rotation_overrides (
RotationId,
NewContactIds,
StartTime,
EndTime,
IdempotencyToken,
region
)
SELECT 
'{{ RotationId }}' /* required */,
'{{ NewContactIds }}' /* required */,
'{{ StartTime }}' /* required */,
'{{ EndTime }}' /* required */,
'{{ IdempotencyToken }}',
'{{ region }}'
RETURNING
rotation_override_id
;

Manifest

# Description fields are for documentation purposes
- name: rotation_overrides
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the rotation_overrides resource.
  - name: RotationId
    value: "{{ RotationId }}"
    description: |
      The Amazon Resource Name (ARN) of the rotation to create an override for.
  - name: NewContactIds
    value:
      - "{{ NewContactIds }}"
    description: |
      The Amazon Resource Names (ARNs) of the contacts to replace those in the current on-call rotation with. If you want to include any current team members in the override shift, you must include their ARNs in the new contact ID list.
  - name: StartTime
    value: "{{ StartTime }}"
    description: |
      The date and time when the override goes into effect.
  - name: EndTime
    value: "{{ EndTime }}"
    description: |
      The date and time when the override ends.
  - name: IdempotencyToken
    value: "{{ IdempotencyToken }}"
    description: |
      A token that ensures that the operation is called only once with the specified details.

DELETE examples

delete_rotation_override

Deletes an existing override for an on-call rotation.

DELETE FROM aws.ssm_contacts.rotation_overrides
WHERE region = '{{ region }}' --required
;