Skip to content
AWS for Query.Farm

aws.shield.describe_protection

Example SQL Queries

SELECT * FROM
aws.shield.describe_protection;

Description

Lists the details of a Protection object.

Table Definition

Column NameColumn Data Type
protection_id Input Column

The unique identifier (ID) for the Protection object to describe. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

VARCHAR
resource_arn Input Column

The ARN (Amazon Resource Name) of the protected Amazon Web Services resource. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

protection

The Protection that you requested. 

STRUCT(
    "id" VARCHAR,
    "name" VARCHAR,
    "resource_arn" VARCHAR,
    "health_check_ids" VARCHAR[],
    "protection_arn" VARCHAR,
    "application_layer_automatic_response_configuration" STRUCT(
        "status" VARCHAR,
        "action" STRUCT(
            "block" BOOLEAN,
            "count" BOOLEAN
        )
    )
)
Show child fields
protection.application_layer_automatic_response_configuration

The automatic application layer DDoS mitigation settings for the protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.

Show child fields
protection.application_layer_automatic_response_configuration.action

Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.

Show child fields
protection.application_layer_automatic_response_configuration.action.block

Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.

You must specify exactly one action, either Block or Count.

protection.application_layer_automatic_response_configuration.action.count

Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.

You must specify exactly one action, either Block or Count.

protection.application_layer_automatic_response_configuration.status

Indicates whether automatic application layer DDoS mitigation is enabled for the protection.

protection.health_check_ids[]
protection.id

The unique identifier (ID) of the protection.

protection.name

The name of the protection. For example, My CloudFront distributions.

protection.protection_arn

The ARN (Amazon Resource Name) of the protection.

protection.resource_arn

The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.