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	awscc.shield.protection_groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
protection_group_arn	string	The ARN (Amazon Resource Name) of the protection group.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	protection_groups	INSERT	Aggregation, Pattern, ProtectionGroupId, region
delete_resource	protection_groups	DELETE	Identifier, region
update_resource	protection_groups	UPDATE	Identifier, PatchDocument, region
list_resources	protection_groups_list_only	SELECT	region
get_resource	protection_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual protection_group.

SELECT
  region,
  protection_group_id,
  protection_group_arn,
  aggregation,
  pattern,
  members,
  resource_type,
  tags
FROM awscc.shield.protection_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ protection_group_arn }}';

list (identifiers only)

Lists all protection_groups in a region.

SELECT
  region,
  protection_group_arn
FROM awscc.shield.protection_groups_list_only
WHERE
  region = 'us-east-1';

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 awscc.shield.protection_groups (
  ProtectionGroupId,
  Aggregation,
  Pattern,
  region
)
SELECT
  '{{ protection_group_id }}',
  '{{ aggregation }}',
  '{{ pattern }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.shield.protection_groups (
  ProtectionGroupId,
  Aggregation,
  Pattern,
  Members,
  ResourceType,
  Tags,
  region
)
SELECT
  '{{ protection_group_id }}',
  '{{ aggregation }}',
  '{{ pattern }}',
  '{{ members }}',
  '{{ resource_type }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: protection_group
  props:
    - name: protection_group_id
      value: '{{ protection_group_id }}'
    - name: aggregation
      value: '{{ aggregation }}'
    - name: pattern
      value: '{{ pattern }}'
    - name: members
      value:
        - '{{ members[0] }}'
    - name: resource_type
      value: '{{ resource_type }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.shield.protection_groups
SET PatchDocument = string('{{ {
    "Aggregation": aggregation,
    "Pattern": pattern,
    "Members": members,
    "ResourceType": resource_type,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ protection_group_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.shield.protection_groups
WHERE
  Identifier = '{{ protection_group_arn }}' AND
  region = 'us-east-1'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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