Skip to main content
← back to extensions

@swamp/aws/shield

v2026.04.23.3

AWS SHIELD infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

awsshieldcloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/shield

@swamp/aws/shield/drtaccessv2026.04.23.2drtaccess.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
LogBucketList?arrayAuthorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
RoleArnstringAuthorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.
createCreate a Shield DRTAccess
getGet a Shield DRTAccess
ArgumentTypeDescription
identifierstringThe primary identifier of the Shield DRTAccess
updateUpdate a Shield DRTAccess
deleteDelete a Shield DRTAccess
ArgumentTypeDescription
identifierstringThe primary identifier of the Shield DRTAccess
syncSync Shield DRTAccess state from AWS

Resources

state(infinite)— Shield DRTAccess resource state
@swamp/aws/shield/proactive-engagementv2026.04.23.2proactive_engagement.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ProactiveEngagementStatusenumIf `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.
EmergencyContactListarrayA 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.
createCreate a Shield ProactiveEngagement
getGet a Shield ProactiveEngagement
ArgumentTypeDescription
identifierstringThe primary identifier of the Shield ProactiveEngagement
updateUpdate a Shield ProactiveEngagement
deleteDelete a Shield ProactiveEngagement
ArgumentTypeDescription
identifierstringThe primary identifier of the Shield ProactiveEngagement
syncSync Shield ProactiveEngagement state from AWS

Resources

state(infinite)— Shield ProactiveEngagement resource state
@swamp/aws/shield/protectionv2026.04.23.2protection.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NamestringFriendly name for the Protection.
ResourceArnstringThe ARN (Amazon Resource Name) of the resource to be protected.
HealthCheckArns?arrayThe Amazon Resource Names (ARNs) of the health check to associate with the protection.
ApplicationLayerAutomaticResponseConfiguration?objectThe automatic application layer DDoS mitigation settings for a 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.
Tags?arrayOne or more tag key-value pairs for the Protection object.
createCreate a Shield Protection
getGet a Shield Protection
ArgumentTypeDescription
identifierstringThe primary identifier of the Shield Protection
updateUpdate a Shield Protection
deleteDelete a Shield Protection
ArgumentTypeDescription
identifierstringThe primary identifier of the Shield Protection
syncSync Shield Protection state from AWS

Resources

state(infinite)— Shield Protection resource state
@swamp/aws/shield/protection-groupv2026.04.23.2protection_group.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ProtectionGroupIdstringThe 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.
AggregationenumDefines 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
PatternenumThe 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?arrayThe 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.
ResourceType?enumThe 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?arrayOne or more tag key-value pairs for the Protection object.
createCreate a Shield ProtectionGroup
getGet a Shield ProtectionGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the Shield ProtectionGroup
updateUpdate a Shield ProtectionGroup
deleteDelete a Shield ProtectionGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the Shield ProtectionGroup
syncSync Shield ProtectionGroup state from AWS

Resources

state(infinite)— Shield ProtectionGroup resource state