Aws/wafv2
@swamp/aws/wafv2v2026.10.13.1
01README
AWS WAFV2 infrastructure models
02Release Notes
- Updated: ipset, logging_configuration, regex_pattern_set, rule_group, web_acl, web_aclassociation
03Behaviors
@swamp/aws/wafv2/ipsetv2026.10.13.1ipset.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. |
| Description? | string | Description of the entity. |
| Name? | string | Name of the IPSet. |
| Scope | enum | Use CLOUDFRONT for CloudFront IPSet, use REGIONAL for Application Load Balancer and API Gateway. |
| IPAddressVersion | enum | Type of addresses in the IPSet, use IPV4 for IPV4 IP addresses, IPV6 for IPV6 address. |
| Addresses | array | List of IPAddresses. |
| Tags? | array |
fn create()
Create a WAFv2 IPSet
fn get(identifier: string)
Get a WAFv2 IPSet
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 IPSet |
fn update()
Update a WAFv2 IPSet
fn delete(identifier: string)
Delete a WAFv2 IPSet
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 IPSet |
fn sync()
Sync WAFv2 IPSet state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WAFv2 IPSet 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)— WAFv2 IPSet resource state
@swamp/aws/wafv2/logging-configurationv2026.10.13.1logging_configuration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| ResourceArn | string | The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. |
| LogDestinationConfigs | array | The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL. |
| RedactedFields? | array | The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx. |
| LoggingFilter? | object | Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. |
fn create()
Create a WAFv2 LoggingConfiguration
fn get(identifier: string)
Get a WAFv2 LoggingConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 LoggingConfiguration |
fn update()
Update a WAFv2 LoggingConfiguration
fn delete(identifier: string)
Delete a WAFv2 LoggingConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 LoggingConfiguration |
fn sync()
Sync WAFv2 LoggingConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WAFv2 LoggingConfiguration 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)— WAFv2 LoggingConfiguration resource state
@swamp/aws/wafv2/regex-pattern-setv2026.10.13.1regex_pattern_set.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. |
| Description? | string | Description of the entity. |
| Name? | string | Name of the RegexPatternSet. |
| RegularExpressionList | array | |
| Scope | enum | Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway. |
| Tags? | array |
fn create()
Create a WAFv2 RegexPatternSet
fn get(identifier: string)
Get a WAFv2 RegexPatternSet
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 RegexPatternSet |
fn update()
Update a WAFv2 RegexPatternSet
fn delete(identifier: string)
Delete a WAFv2 RegexPatternSet
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 RegexPatternSet |
fn sync()
Sync WAFv2 RegexPatternSet state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WAFv2 RegexPatternSet 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)— WAFv2 RegexPatternSet resource state
@swamp/aws/wafv2/rule-groupv2026.10.13.1rule_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. |
| Capacity | number | |
| Description? | string | Description of the entity. |
| Scope | enum | Use CLOUDFRONT for CloudFront RuleGroup, use REGIONAL for Application Load Balancer and API Gateway. |
| Rules? | array | Collection of Rules. |
| VisibilityConfig | object | Visibility Metric of the RuleGroup. |
| Tags? | array | |
| CustomResponseBodies? | record | Custom response key and body map. |
| AvailableLabels? | array | Collection of Available Labels. |
| ConsumedLabels? | array | Collection of Consumed Labels. |
| MonetizationConfig? | object | Configures monetization for the web ACL or rule group. |
fn create()
Create a WAFv2 RuleGroup
fn get(identifier: string)
Get a WAFv2 RuleGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 RuleGroup |
fn update()
Update a WAFv2 RuleGroup
fn delete(identifier: string)
Delete a WAFv2 RuleGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 RuleGroup |
fn sync()
Sync WAFv2 RuleGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WAFv2 RuleGroup 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)— WAFv2 RuleGroup resource state
@swamp/aws/wafv2/web-aclv2026.10.13.1web_acl.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. |
| DefaultAction | object | Default Action WebACL will take against ingress traffic when there is no matching Rule. |
| Description? | string | Description of the entity. |
| Name? | string | Name of the WebACL. |
| Scope | enum | Use CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway. |
| Rules? | array | Collection of Rules. |
| VisibilityConfig | object | Visibility Metric of the WebACL. |
| DataProtectionConfig? | object | Collection of dataProtects. |
| ApplicationConfig? | object | Collection of application attributes. |
| Tags? | array | |
| CustomResponseBodies? | record | Custom response key and body map. |
| CaptchaConfig? | object | |
| ChallengeConfig? | object | |
| TokenDomains? | array | List of domains to accept in web request tokens, in addition to the domain of the protected resource. |
| AssociationConfig? | object | AssociationConfig for body inspection |
| OnSourceDDoSProtectionConfig? | object | Configures the options for on-source DDoS protection provided by supported resource type. |
| MonetizationConfig? | object | Configures monetization for the web ACL or rule group. |
fn create()
Create a WAFv2 WebACL
fn get(identifier: string)
Get a WAFv2 WebACL
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 WebACL |
fn update()
Update a WAFv2 WebACL
fn delete(identifier: string)
Delete a WAFv2 WebACL
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 WebACL |
fn sync()
Sync WAFv2 WebACL state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WAFv2 WebACL 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)— WAFv2 WebACL resource state
@swamp/aws/wafv2/web-aclassociationv2026.10.13.1web_aclassociation.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. |
| ResourceArn | string | |
| WebACLArn | string |
fn create()
Create a WAFv2 WebACLAssociation
fn get(identifier: string)
Get a WAFv2 WebACLAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 WebACLAssociation |
fn update()
Update a WAFv2 WebACLAssociation
fn delete(identifier: string)
Delete a WAFv2 WebACLAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WAFv2 WebACLAssociation |
fn sync()
Sync WAFv2 WebACLAssociation state from AWS
Resources
state(infinite)— WAFv2 WebACLAssociation resource state
04Previous Versions
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
2026.09.20.1
2026.09.19.1
2026.09.18.1
05Stats
A
93 / 100
Downloads
23
Archive size
1.2 MB
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
- License1/2partial
no SPDX license declared
- Verified public repository2/2earned
06Platforms
07Labels