proactive_engagements

Creates, updates, deletes or gets a proactive_engagement resource or lists proactive_engagements in a region

Overview

Name	proactive_engagements
Type	Resource
Description	Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
Id	awscc.shield.proactive_engagements

Fields

get (all properties)

Name	Datatype	Description
account_id	string
proactive_engagement_status	string	If &#96;ENABLED&#96;, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.<br />If &#96;DISABLED&#96;, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
▶emergency_contact_list	array	A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.<br />To enable proactive engagement, the contact list must include at least one phone number.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
account_id	string
region	string	AWS region.

For more information, see AWS::Shield::ProactiveEngagement.

Methods

Name	Resource	Accessible by	Required Params
create_resource	proactive_engagements	INSERT	ProactiveEngagementStatus, EmergencyContactList, region
delete_resource	proactive_engagements	DELETE	Identifier, region
update_resource	proactive_engagements	UPDATE	Identifier, PatchDocument, region
list_resources	proactive_engagements_list_only	SELECT	region
get_resource	proactive_engagements	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual proactive_engagement.

SELECT
  region,
  account_id,
  proactive_engagement_status,
  emergency_contact_list
FROM awscc.shield.proactive_engagements
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ account_id }}';

list (identifiers only)

Lists all proactive_engagements in a region.

SELECT
  region,
  account_id
FROM awscc.shield.proactive_engagements_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.shield.proactive_engagements (
  ProactiveEngagementStatus,
  EmergencyContactList,
  region
)
SELECT
  '{{ proactive_engagement_status }}',
  '{{ emergency_contact_list }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.shield.proactive_engagements (
  ProactiveEngagementStatus,
  EmergencyContactList,
  region
)
SELECT
  '{{ proactive_engagement_status }}',
  '{{ emergency_contact_list }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: proactive_engagement
    props:
      - name: proactive_engagement_status
        value: '{{ proactive_engagement_status }}'
      - name: emergency_contact_list
        value:
          - contact_notes: '{{ contact_notes }}'
            email_address: '{{ email_address }}'
            phone_number: '{{ phone_number }}'

UPDATE example

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

/*+ update */
UPDATE awscc.shield.proactive_engagements
SET PatchDocument = string('{{ {
    "ProactiveEngagementStatus": proactive_engagement_status,
    "EmergencyContactList": emergency_contact_list
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.shield.proactive_engagements
WHERE
  Identifier = '{{ account_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

shield:DescribeSubscription,
shield:DescribeEmergencyContactSettings,
shield:AssociateProactiveEngagementDetails,
shield:UpdateEmergencyContactSettings,
shield:EnableProactiveEngagement

Delete

shield:DescribeSubscription,
shield:DescribeEmergencyContactSettings,
shield:UpdateEmergencyContactSettings,
shield:DisableProactiveEngagement

Read

shield:DescribeSubscription,
shield:DescribeEmergencyContactSettings

Update

shield:DescribeSubscription,
shield:DescribeEmergencyContactSettings,
shield:UpdateEmergencyContactSettings,
shield:EnableProactiveEngagement,
shield:DisableProactiveEngagement

List

shield:DescribeSubscription,
shield:DescribeEmergencyContactSettings