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	awscc.ssmcontacts.contact_channels

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the engagement to a contact channel.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	contact_channels	INSERT	region
delete_resource	contact_channels	DELETE	Identifier, region
update_resource	contact_channels	UPDATE	Identifier, PatchDocument, region
list_resources	contact_channels_list_only	SELECT	region
get_resource	contact_channels	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual contact_channel.

SELECT
  region,
  contact_id,
  channel_name,
  channel_type,
  defer_activation,
  channel_address,
  arn
FROM awscc.ssmcontacts.contact_channels
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all contact_channels in a region.

SELECT
  region,
  arn
FROM awscc.ssmcontacts.contact_channels_list_only
WHERE
  region = 'us-east-1';

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 awscc.ssmcontacts.contact_channels (
  ContactId,
  ChannelName,
  ChannelType,
  DeferActivation,
  ChannelAddress,
  region
)
SELECT
  '{{ contact_id }}',
  '{{ channel_name }}',
  '{{ channel_type }}',
  '{{ defer_activation }}',
  '{{ channel_address }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ssmcontacts.contact_channels (
  ContactId,
  ChannelName,
  ChannelType,
  DeferActivation,
  ChannelAddress,
  region
)
SELECT
  '{{ contact_id }}',
  '{{ channel_name }}',
  '{{ channel_type }}',
  '{{ defer_activation }}',
  '{{ channel_address }}',
  '{{ 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: contact_id
        value: '{{ contact_id }}'
      - name: channel_name
        value: '{{ channel_name }}'
      - name: channel_type
        value: '{{ channel_type }}'
      - name: defer_activation
        value: '{{ defer_activation }}'
      - name: channel_address
        value: '{{ channel_address }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ssmcontacts.contact_channels
SET PatchDocument = string('{{ {
    "ChannelName": channel_name,
    "DeferActivation": defer_activation,
    "ChannelAddress": channel_address
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ssmcontacts.contact_channels
WHERE
  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