contact_channels

Creates, updates, deletes or gets a contact_channel resource or lists contact_channels in a region

Overview

Name	contact_channels
Type	Resource
Description	Resource Type definition for AWS::SSMContacts::ContactChannel
Id	aws.ssmcontacts.contact_channels

Fields

Name	Datatype	Description
contact_id	string	ARN of the contact resource
channel_name	string	The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
channel_type	string	Device type, which specify notification channel. Currently supported values: “SMS”, “VOICE”, “EMAIL”, “CHATBOT.
defer_activation	boolean	If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.
channel_address	string	The details that SSM Incident Manager uses when trying to engage the contact channel.
arn	string	The Amazon Resource Name (ARN) of the engagement to a contact channel.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all contact_channels in a region.

SELECT
region,
contact_id,
channel_name,
channel_type,
defer_activation,
channel_address,
arn
FROM aws.ssmcontacts.contact_channels
WHERE region = 'us-east-1';

Gets all properties from an individual contact_channel.

SELECT
region,
contact_id,
channel_name,
channel_type,
defer_activation,
channel_address,
arn
FROM aws.ssmcontacts.contact_channels
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ssmcontacts.contact_channels (
 ContactId,
 ChannelName,
 ChannelType,
 DeferActivation,
 ChannelAddress,
 region
)
SELECT 
'{{ ContactId }}',
 '{{ ChannelName }}',
 '{{ ChannelType }}',
 '{{ DeferActivation }}',
 '{{ ChannelAddress }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ssmcontacts.contact_channels (
 ContactId,
 ChannelName,
 ChannelType,
 DeferActivation,
 ChannelAddress,
 region
)
SELECT 
 '{{ ContactId }}',
 '{{ ChannelName }}',
 '{{ ChannelType }}',
 '{{ DeferActivation }}',
 '{{ ChannelAddress }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: contact_channel
    props:
      - name: ContactId
        value: '{{ ContactId }}'
      - name: ChannelName
        value: '{{ ChannelName }}'
      - name: ChannelType
        value: '{{ ChannelType }}'
      - name: DeferActivation
        value: '{{ DeferActivation }}'
      - name: ChannelAddress
        value: '{{ ChannelAddress }}'

DELETE example

/*+ delete */
DELETE FROM aws.ssmcontacts.contact_channels
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

ssm-contacts:CreateContactChannel,
ssm-contacts:GetContactChannel

Read

ssm-contacts:GetContactChannel

Update

ssm-contacts:UpdateContactChannel,
ssm-contacts:GetContactChannel

Delete

ssm-contacts:DeleteContactChannel,
ssm-contacts:GetContactChannel

List

ssm-contacts:ListContactChannels