protection_groups

Creates, updates, deletes, gets or lists a protection_groups resource.

Overview

Name	protection_groups
Type	Resource
Id	aws.shield.protection_groups

Fields

The following fields are returned by SELECT queries:

describe_protection_group

Name	Datatype	Description
aggregation	string	Defines how 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 distributions and origin resources for CloudFront distributions. (SUM, MEAN, MAX)
members	array	The ARNs (Amazon Resource Names) 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.
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 ARNs (Amazon Resource Names), or include all resources of a specified resource type. (ALL, ARBITRARY, BY_RESOURCE_TYPE)
protection_group_arn	string	The ARN (Amazon Resource Name) of the protection group. (pattern: <code>^arn:aws.*</code>)
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. (pattern: <code>[a-zA-Z0-9\-]*</code>)
resource_type	string	The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting. (CLOUDFRONT_DISTRIBUTION, ROUTE_53_HOSTED_ZONE, ELASTIC_IP_ALLOCATION, CLASSIC_LOAD_BALANCER, APPLICATION_LOAD_BALANCER, GLOBAL_ACCELERATOR)

list_protection_groups

Name	Datatype	Description
next_token	string	When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request. You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available. Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value. (pattern: <code>^.*$</code>)
protection_groups	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_protection_group	select	region		Returns the specification for the specified protection group.
list_protection_groups	select	region		Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
create_protection_group	insert	region, ProtectionGroupId, Aggregation, Pattern		Creates 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.
update_protection_group	update	region, ProtectionGroupId, Aggregation, Pattern		Updates an existing protection group. A protection group is 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.
delete_protection_group	delete	region		Removes the specified protection group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_protection_group

Returns the specification for the specified protection group.

SELECT
aggregation,
members,
pattern,
protection_group_arn,
protection_group_id,
resource_type
FROM aws.shield.protection_groups
WHERE region = '{{ region }}' -- required
;

list_protection_groups

Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.

SELECT
next_token,
protection_groups
FROM aws.shield.protection_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_protection_group

Creates 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.

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

Manifest

# Description fields are for documentation purposes
- name: protection_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the protection_groups resource.
  - name: ProtectionGroupId
    value: "{{ ProtectionGroupId }}"
    description: |
      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.
  - name: Aggregation
    value: "{{ Aggregation }}"
    description: |
      Defines how 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.
    valid_values: ['SUM', 'MEAN', 'MAX']
  - name: Pattern
    value: "{{ Pattern }}"
    description: |
      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.
    valid_values: ['ALL', 'ARBITRARY', 'BY_RESOURCE_TYPE']
  - name: ResourceType
    value: "{{ ResourceType }}"
    description: |
      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.
    valid_values: ['CLOUDFRONT_DISTRIBUTION', 'ROUTE_53_HOSTED_ZONE', 'ELASTIC_IP_ALLOCATION', 'CLASSIC_LOAD_BALANCER', 'APPLICATION_LOAD_BALANCER', 'GLOBAL_ACCELERATOR']
  - name: Members
    value:
      - "{{ Members }}"
    description: |
      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.
  - name: Tags
    description: |
      One or more tag key-value pairs for the protection group.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_protection_group

Updates an existing protection group. A protection group is 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.

UPDATE aws.shield.protection_groups
SET 
ProtectionGroupId = '{{ ProtectionGroupId }}',
Aggregation = '{{ Aggregation }}',
Pattern = '{{ Pattern }}',
ResourceType = '{{ ResourceType }}',
Members = '{{ Members }}'
WHERE 
region = '{{ region }}' --required
AND ProtectionGroupId = '{{ ProtectionGroupId }}' --required
AND Aggregation = '{{ Aggregation }}' --required
AND Pattern = '{{ Pattern }}' --required;

DELETE examples

delete_protection_group

Removes the specified protection group.

DELETE FROM aws.shield.protection_groups
WHERE region = '{{ region }}' --required
;