Aws/shield
@swamp/aws/shieldv2026.09.11.1
01README
AWS SHIELD infrastructure models
02Models
@swamp/aws/shield/drtaccessv2026.08.17.2drtaccess.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| LogBucketList? | array | Authorizes 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. |
| RoleArn | string | Authorizes 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. |
fn create()
Create a Shield DRTAccess
fn get(identifier: string)
Get a Shield DRTAccess
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Shield DRTAccess |
fn update()
Update a Shield DRTAccess
fn delete(identifier: string)
Delete a Shield DRTAccess
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Shield DRTAccess |
fn sync()
Sync Shield DRTAccess state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Shield DRTAccess resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Shield DRTAccess resource state
@swamp/aws/shield/proactive-engagementv2026.08.17.2proactive_engagement.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ProactiveEngagementStatus | enum | If `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. |
| EmergencyContactList | array | A 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. |
fn create()
Create a Shield ProactiveEngagement
fn get(identifier: string)
Get a Shield ProactiveEngagement
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Shield ProactiveEngagement |
fn update()
Update a Shield ProactiveEngagement
fn delete(identifier: string)
Delete a Shield ProactiveEngagement
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Shield ProactiveEngagement |
fn sync()
Sync Shield ProactiveEngagement state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Shield ProactiveEngagement resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Shield ProactiveEngagement resource state
@swamp/aws/shield/protectionv2026.08.17.2protection.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | Friendly name for the Protection. |
| ResourceArn | string | The ARN (Amazon Resource Name) of the resource to be protected. |
| HealthCheckArns? | array | The Amazon Resource Names (ARNs) of the health check to associate with the protection. |
| ApplicationLayerAutomaticResponseConfiguration? | object | The 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? | array | One or more tag key-value pairs for the Protection object. |
fn create()
Create a Shield Protection
fn get(identifier: string)
Get a Shield Protection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Shield Protection |
fn update()
Update a Shield Protection
fn delete(identifier: string)
Delete a Shield Protection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Shield Protection |
fn sync()
Sync Shield Protection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Shield Protection resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Shield Protection resource state
@swamp/aws/shield/protection-groupv2026.08.17.2protection_group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ProtectionGroupId | 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. |
| Aggregation | enum | 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 |
| Pattern | enum | 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. |
| ResourceType? | enum | 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. |
fn create()
Create a Shield ProtectionGroup
fn get(identifier: string)
Get a Shield ProtectionGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Shield ProtectionGroup |
fn update()
Update a Shield ProtectionGroup
fn delete(identifier: string)
Delete a Shield ProtectionGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Shield ProtectionGroup |
fn sync()
Sync Shield ProtectionGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Shield ProtectionGroup resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Shield ProtectionGroup resource state
03Previous Versions
2026.09.10.1
2026.09.09.1
2026.09.08.1
2026.09.07.1
2026.09.06.3
2026.09.06.1
2026.09.05.1
2026.09.04.1
2026.09.03.1
2026.09.02.1
2026.09.01.1
2026.08.31.1
2026.08.30.1
2026.08.29.1
2026.08.28.1
2026.08.27.1
2026.08.26.1
2026.08.25.6
2026.08.25.5
04Stats
A
100 / 100
Downloads
0
Archive size
993.1 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels