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	aws.shield.proactive_engagements

Fields

Name	Datatype	Description
account_id	string
proactive_engagement_status	string	If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support. If DISABLED, 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. To enable proactive engagement, the contact list must include at least one phone number.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ProactiveEngagementStatus, EmergencyContactList, 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 proactive_engagements in a region.

SELECT
region,
account_id,
proactive_engagement_status,
emergency_contact_list
FROM aws.shield.proactive_engagements
;

Gets all properties from an individual proactive_engagement.

SELECT
region,
account_id,
proactive_engagement_status,
emergency_contact_list
FROM aws.shield.proactive_engagements
WHERE data__Identifier = '<AccountId>';

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 aws.shield.proactive_engagements (
 ProactiveEngagementStatus,
 EmergencyContactList,
 region
)
SELECT 
'{{ ProactiveEngagementStatus }}',
 '{{ EmergencyContactList }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.shield.proactive_engagements (
 ProactiveEngagementStatus,
 EmergencyContactList,
 region
)
SELECT 
 '{{ ProactiveEngagementStatus }}',
 '{{ EmergencyContactList }}',
 '{{ 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: ProactiveEngagementStatus
        value: '{{ ProactiveEngagementStatus }}'
      - name: EmergencyContactList
        value:
          - ContactNotes: '{{ ContactNotes }}'
            EmailAddress: '{{ EmailAddress }}'
            PhoneNumber: '{{ PhoneNumber }}'

DELETE example

/*+ delete */
DELETE FROM aws.shield.proactive_engagements
WHERE data__Identifier = '<AccountId>'
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