protection_groups

Creates, updates, deletes or gets a protection_group resource or lists protection_groups in a region

Overview

Name	protection_groups
Type	Resource
Description	A grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
Id	aws.shield.protection_groups

Fields

Name	Datatype	Description
protection_group_id	string	The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
protection_group_arn	string	The ARN (Amazon Resource Name) of the protection group.
aggregation	string	Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events. * Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically. * Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers. * Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.
pattern	string	The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
members	array	The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set `Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.
resource_type	string	The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.
tags	array	One or more tag key-value pairs for the Protection object.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Aggregation, Pattern, ProtectionGroupId, 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 protection_groups in a region.

SELECT
region,
protection_group_id,
protection_group_arn,
aggregation,
pattern,
members,
resource_type,
tags
FROM aws.shield.protection_groups
;

Gets all properties from an individual protection_group.

SELECT
region,
protection_group_id,
protection_group_arn,
aggregation,
pattern,
members,
resource_type,
tags
FROM aws.shield.protection_groups
WHERE data__Identifier = '<ProtectionGroupArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.shield.protection_groups (
 ProtectionGroupId,
 Aggregation,
 Pattern,
 region
)
SELECT 
'{{ ProtectionGroupId }}',
 '{{ Aggregation }}',
 '{{ Pattern }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.shield.protection_groups (
 ProtectionGroupId,
 Aggregation,
 Pattern,
 Members,
 ResourceType,
 Tags,
 region
)
SELECT 
 '{{ ProtectionGroupId }}',
 '{{ Aggregation }}',
 '{{ Pattern }}',
 '{{ Members }}',
 '{{ ResourceType }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: protection_group
    props:
      - name: ProtectionGroupId
        value: '{{ ProtectionGroupId }}'
      - name: Aggregation
        value: '{{ Aggregation }}'
      - name: Pattern
        value: '{{ Pattern }}'
      - name: Members
        value:
          - '{{ Members[0] }}'
      - name: ResourceType
        value: '{{ ResourceType }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.shield.protection_groups
WHERE data__Identifier = '<ProtectionGroupArn>'
AND region = 'us-east-1';

Permissions

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

Create

shield:CreateProtectionGroup,
shield:TagResource

Delete

shield:DeleteProtectionGroup,
shield:UntagResource

Read

shield:DescribeProtectionGroup,
shield:ListTagsForResource

Update

shield:UpdateProtectionGroup,
shield:ListTagsForResource,
shield:TagResource,
shield:UntagResource

List

shield:ListProtectionGroups