VaporShell.WAFv2.psm1
|
# PSM1 Contents function Format-Json { [CmdletBinding()] Param ( [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)] [String] $Json ) Begin { $cleaner = { param([String]$Line) Process{ [Regex]::Replace( $Line, "\\u(?<Value>[a-zA-Z0-9]{4})", { param($m)([char]([int]::Parse( $m.Groups['Value'].Value, [System.Globalization.NumberStyles]::HexNumber ))).ToString() } ) } } } Process { if ($PSVersionTable.PSVersion.Major -lt 6) { try { $indent = 0; $res = $Json -split '\n' | ForEach-Object { if ($_ -match '[\}\]]') { # This line contains ] or }, decrement the indentation level $indent-- } $line = (' ' * $indent * 2) + $_.TrimStart().Replace(': ', ': ') if ($_ -match '[\{\[]') { # This line contains [ or {, increment the indentation level $indent++ } $cleaner.Invoke($line) } $res -join "`n" } catch { ($Json -split '\n' | ForEach-Object {$cleaner.Invoke($_)}) -join "`n" } } else { ($Json -split '\n' | ForEach-Object {$cleaner.Invoke($_)}) -join "`n" } } } function Get-TrueCount { Param ( [parameter(Mandatory = $false,Position = 0,ValueFromPipeline = $true)] $Array ) Process { if ($array) { if ($array.Count) { $count = $array.Count } else { $count = 1 } } else { $count = 0 } } End { return $count } } function New-VSError { <# .SYNOPSIS Error generator function to use in tandem with $PSCmdlet.ThrowTerminatingError() .PARAMETER Result Allows input of an error from AWS SDK, resulting in the Exception message being parsed out. .PARAMETER String Used to create basic String message errors in the same wrapper #> [cmdletbinding(DefaultParameterSetName="Result")] param( [parameter(Position=0,ParameterSetName="Result")] $Result, [parameter(Position=0,ParameterSetName="String")] $String ) switch ($PSCmdlet.ParameterSetName) { Result { $Exception = "$($result.Exception.InnerException.Message)" } String { $Exception = "$String" } } $e = New-Object "System.Exception" $Exception $errorRecord = New-Object 'System.Management.Automation.ErrorRecord' $e, $null, ([System.Management.Automation.ErrorCategory]::InvalidOperation), $null return $errorRecord } function ResolveS3Endpoint { <# .SYNOPSIS Resolves the S3 endpoint most appropriate for each region. #> Param ( [parameter(Mandatory=$true,Position=0)] [ValidateSet("eu-west-2","ap-south-1","us-east-2","sa-east-1","us-west-1","us-west-2","eu-west-1","ap-southeast-2","ca-central-1","ap-northeast-2","us-east-1","eu-central-1","ap-southeast-1","ap-northeast-1")] [String] $Region ) $endpointMap = @{ "us-east-2" = "s3.us-east-2.amazonaws.com" "us-east-1" = "s3.amazonaws.com" "us-west-1" = "s3-us-west-1.amazonaws.com" "us-west-2" = "s3-us-west-2.amazonaws.com" "ca-central-1" = "s3.ca-central-1.amazonaws.com" "ap-south-1" = "s3.ap-south-1.amazonaws.com" "ap-northeast-2" = "s3.ap-northeast-2.amazonaws.com" "ap-southeast-1" = "s3-ap-southeast-1.amazonaws.com" "ap-southeast-2" = "s3-ap-southeast-2.amazonaws.com" "ap-northeast-1" = "s3-ap-northeast-1.amazonaws.com" "eu-central-1" = "s3.eu-central-1.amazonaws.com" "eu-west-1" = "s3-eu-west-1.amazonaws.com" "eu-west-2" = "s3.eu-west-2.amazonaws.com" "sa-east-1" = "s3-sa-east-1.amazonaws.com" } return $endpointMap[$Region] } function Add-VSWAFv2RuleGroupAndStatementOne { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.AndStatementOne resource property to the template. Logical AND statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.AndStatementOne resource property to the template. Logical AND statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatementone.html .PARAMETER Statements Logical AND statements used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatementone.html#cfn-wafv2-rulegroup-andstatementone-statements UpdateType: Mutable Type: List ItemType: StatementTwo .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupAndStatementOne])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Statements ) Process { $obj = [WAFv2RuleGroupAndStatementOne]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupAndStatementOne' function Add-VSWAFv2RuleGroupAndStatementTwo { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.AndStatementTwo resource property to the template. Logical AND statement used in statement nesting. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.AndStatementTwo resource property to the template. Logical AND statement used in statement nesting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatementtwo.html .PARAMETER Statements Logical AND statements used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatementtwo.html#cfn-wafv2-rulegroup-andstatementtwo-statements UpdateType: Mutable Type: List ItemType: StatementThree .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupAndStatementTwo])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Statements ) Process { $obj = [WAFv2RuleGroupAndStatementTwo]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupAndStatementTwo' function Add-VSWAFv2RuleGroupByteMatchStatement { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.ByteMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.ByteMatchStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html .PARAMETER SearchString A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive. Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you. For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you provide the string BadBot in the value of SearchString. You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-searchstring UpdateType: Mutable PrimitiveType: String .PARAMETER SearchStringBase64 String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in SearchString instead. You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-searchstringbase64 UpdateType: Mutable PrimitiveType: String .PARAMETER FieldToMatch The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .PARAMETER PositionalConstraint The area within the portion of a web request that you want AWS WAF to search for SearchString. Valid values include the following: **CONTAINS** The specified part of the web request must include the value of SearchString, but the location doesn't matter. **CONTAINS_WORD** The specified part of the web request must include the value of SearchString, and SearchString must contain only alphanumeric characters or underscore A-Z, a-z, 0-9, or _. In addition, SearchString must be a word, which means that both of the following are true: + SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore _. Examples include the value of a header and ;BadBot. + SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore _, for example, BadBot; and -BadBot;. **EXACTLY** The value of the specified part of the web request must exactly match the value of SearchString. **STARTS_WITH** The value of SearchString must appear at the beginning of the specified part of the web request. **ENDS_WITH** The value of SearchString must appear at the end of the specified part of the web request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-positionalconstraint UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupByteMatchStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $SearchString, [parameter(Mandatory = $false)] [object] $SearchStringBase64, [parameter(Mandatory = $true)] $FieldToMatch, [parameter(Mandatory = $true)] [object] $TextTransformations, [parameter(Mandatory = $true)] [object] $PositionalConstraint ) Process { $obj = [WAFv2RuleGroupByteMatchStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupByteMatchStatement' function Add-VSWAFv2RuleGroupFieldToMatch { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.FieldToMatch resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.FieldToMatch resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. The part of a web request that you want AWS WAF to inspect. Include the FieldToMatch types that you want to inspect, with additional specifications as needed, according to the type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html .PARAMETER SingleHeader Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-singleheader UpdateType: Mutable PrimitiveType: Json .PARAMETER SingleQueryArgument Inspect a single query argument. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*. The name can be up to 30 characters long and isn't case sensitive. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-singlequeryargument UpdateType: Mutable PrimitiveType: Json .PARAMETER AllQueryArguments Inspect all query arguments. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-allqueryarguments UpdateType: Mutable PrimitiveType: Json .PARAMETER UriPath Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-uripath UpdateType: Mutable PrimitiveType: Json .PARAMETER QueryString Inspect the query string. This is the part of a URL that appears after a ? character, if any. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-querystring UpdateType: Mutable PrimitiveType: Json .PARAMETER Body Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. Note that only the first 8 KB 8192 bytes of the request body are forwarded to AWS WAF for inspection. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-body UpdateType: Mutable PrimitiveType: Json .PARAMETER Method Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-method UpdateType: Mutable PrimitiveType: Json .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupFieldToMatch])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [VSJson] $SingleHeader, [parameter(Mandatory = $false)] [VSJson] $SingleQueryArgument, [parameter(Mandatory = $false)] [VSJson] $AllQueryArguments, [parameter(Mandatory = $false)] [VSJson] $UriPath, [parameter(Mandatory = $false)] [VSJson] $QueryString, [parameter(Mandatory = $false)] [VSJson] $Body, [parameter(Mandatory = $false)] [VSJson] $Method ) Process { $obj = [WAFv2RuleGroupFieldToMatch]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupFieldToMatch' function Add-VSWAFv2RuleGroupForwardedIPConfiguration { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.ForwardedIPConfiguration resource property to the template. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.ForwardedIPConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html .PARAMETER HeaderName Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html#cfn-wafv2-rulegroup-forwardedipconfiguration-headername UpdateType: Mutable PrimitiveType: String .PARAMETER FallbackBehavior Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html#cfn-wafv2-rulegroup-forwardedipconfiguration-fallbackbehavior UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupForwardedIPConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $HeaderName, [parameter(Mandatory = $true)] [object] $FallbackBehavior ) Process { $obj = [WAFv2RuleGroupForwardedIPConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupForwardedIPConfiguration' function Add-VSWAFv2RuleGroupGeoMatchStatement { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.GeoMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.GeoMatchStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement used to identify web requests based on country of origin. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html .PARAMETER CountryCodes An array of two-character country codes, for example, "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html#cfn-wafv2-rulegroup-geomatchstatement-countrycodes UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER ForwardedIPConfig *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html#cfn-wafv2-rulegroup-geomatchstatement-forwardedipconfig UpdateType: Mutable Type: ForwardedIPConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupGeoMatchStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $CountryCodes, [parameter(Mandatory = $false)] $ForwardedIPConfig ) Process { $obj = [WAFv2RuleGroupGeoMatchStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupGeoMatchStatement' function Add-VSWAFv2RuleGroupIPSetForwardedIPConfiguration { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.IPSetForwardedIPConfiguration resource property to the template. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.IPSetForwardedIPConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html .PARAMETER HeaderName Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html#cfn-wafv2-rulegroup-ipsetforwardedipconfiguration-headername UpdateType: Mutable PrimitiveType: String .PARAMETER FallbackBehavior Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html#cfn-wafv2-rulegroup-ipsetforwardedipconfiguration-fallbackbehavior UpdateType: Mutable PrimitiveType: String .PARAMETER Position Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html#cfn-wafv2-rulegroup-ipsetforwardedipconfiguration-position UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupIPSetForwardedIPConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $HeaderName, [parameter(Mandatory = $true)] [object] $FallbackBehavior, [parameter(Mandatory = $true)] [object] $Position ) Process { $obj = [WAFv2RuleGroupIPSetForwardedIPConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupIPSetForwardedIPConfiguration' function Add-VSWAFv2RuleGroupIPSetReferenceStatement { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.IPSetReferenceStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.IPSetReferenceStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet. Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html .PARAMETER Arn The Amazon Resource Name ARN of the IPSet that this statement references. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html#cfn-wafv2-rulegroup-ipsetreferencestatement-arn UpdateType: Mutable PrimitiveType: String .PARAMETER IPSetForwardedIPConfig *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html#cfn-wafv2-rulegroup-ipsetreferencestatement-ipsetforwardedipconfig UpdateType: Mutable Type: IPSetForwardedIPConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupIPSetReferenceStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Arn, [parameter(Mandatory = $false)] $IPSetForwardedIPConfig ) Process { $obj = [WAFv2RuleGroupIPSetReferenceStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupIPSetReferenceStatement' function Add-VSWAFv2RuleGroupNotStatementOne { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.NotStatementOne resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.NotStatementOne resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatementone.html .PARAMETER Statement Logical NOT statement used to negate the match results of a nested statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatementone.html#cfn-wafv2-rulegroup-notstatementone-statement UpdateType: Mutable Type: StatementTwo .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupNotStatementOne])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $Statement ) Process { $obj = [WAFv2RuleGroupNotStatementOne]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupNotStatementOne' function Add-VSWAFv2RuleGroupNotStatementTwo { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.NotStatementTwo resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.NotStatementTwo resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatementtwo.html .PARAMETER Statement Logical NOT statement used to negate the match results of a nested statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatementtwo.html#cfn-wafv2-rulegroup-notstatementtwo-statement UpdateType: Mutable Type: StatementThree .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupNotStatementTwo])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $Statement ) Process { $obj = [WAFv2RuleGroupNotStatementTwo]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupNotStatementTwo' function Add-VSWAFv2RuleGroupOrStatementOne { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.OrStatementOne resource property to the template. Logical OR statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.OrStatementOne resource property to the template. Logical OR statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatementone.html .PARAMETER Statements Logical OR statements. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatementone.html#cfn-wafv2-rulegroup-orstatementone-statements UpdateType: Mutable Type: List ItemType: StatementTwo .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupOrStatementOne])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Statements ) Process { $obj = [WAFv2RuleGroupOrStatementOne]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupOrStatementOne' function Add-VSWAFv2RuleGroupOrStatementTwo { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.OrStatementTwo resource property to the template. Logical OR statement used in statement nesting. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.OrStatementTwo resource property to the template. Logical OR statement used in statement nesting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatementtwo.html .PARAMETER Statements Logical OR statements used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatementtwo.html#cfn-wafv2-rulegroup-orstatementtwo-statements UpdateType: Mutable Type: List ItemType: StatementThree .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupOrStatementTwo])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Statements ) Process { $obj = [WAFv2RuleGroupOrStatementTwo]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupOrStatementTwo' function Add-VSWAFv2RuleGroupRateBasedStatementOne { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.RateBasedStatementOne resource property to the template. A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.RateBasedStatementOne resource property to the template. A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementone.html .PARAMETER Limit Limit on the web request that match any nested statement criteria in any 5 minute period. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementone.html#cfn-wafv2-rulegroup-ratebasedstatementone-limit UpdateType: Mutable PrimitiveType: Integer .PARAMETER AggregateKeyType Setting that indicates how to aggregate the request counts. Currently, you must set this to IP. The request counts are aggregated on IP addresses. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementone.html#cfn-wafv2-rulegroup-ratebasedstatementone-aggregatekeytype UpdateType: Mutable PrimitiveType: String .PARAMETER ScopeDownStatement Statement nested inside a rate-based statement to narrow the scope of the requests that AWS WAF counts. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementone.html#cfn-wafv2-rulegroup-ratebasedstatementone-scopedownstatement UpdateType: Mutable Type: StatementTwo .PARAMETER ForwardedIPConfig *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementone.html#cfn-wafv2-rulegroup-ratebasedstatementone-forwardedipconfig UpdateType: Mutable Type: ForwardedIPConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupRateBasedStatementOne])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Limit, [parameter(Mandatory = $true)] [object] $AggregateKeyType, [parameter(Mandatory = $false)] $ScopeDownStatement, [parameter(Mandatory = $false)] $ForwardedIPConfig ) Process { $obj = [WAFv2RuleGroupRateBasedStatementOne]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupRateBasedStatementOne' function Add-VSWAFv2RuleGroupRateBasedStatementTwo { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.RateBasedStatementTwo resource property to the template. A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.RateBasedStatementTwo resource property to the template. A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementtwo.html .PARAMETER Limit Limit on the web request that match any nested statement criteria in any 5 minute period. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementtwo.html#cfn-wafv2-rulegroup-ratebasedstatementtwo-limit UpdateType: Mutable PrimitiveType: Integer .PARAMETER AggregateKeyType Setting that indicates how to aggregate the request counts. Currently, you must set this to IP. The request counts are aggregated on IP addresses. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementtwo.html#cfn-wafv2-rulegroup-ratebasedstatementtwo-aggregatekeytype UpdateType: Mutable PrimitiveType: String .PARAMETER ScopeDownStatement Statement nested inside a rate-based statement to narrow the scope of the requests that AWS WAF counts. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementtwo.html#cfn-wafv2-rulegroup-ratebasedstatementtwo-scopedownstatement UpdateType: Mutable Type: StatementThree .PARAMETER ForwardedIPConfig *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementtwo.html#cfn-wafv2-rulegroup-ratebasedstatementtwo-forwardedipconfig UpdateType: Mutable Type: ForwardedIPConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupRateBasedStatementTwo])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Limit, [parameter(Mandatory = $true)] [object] $AggregateKeyType, [parameter(Mandatory = $false)] $ScopeDownStatement, [parameter(Mandatory = $false)] $ForwardedIPConfig ) Process { $obj = [WAFv2RuleGroupRateBasedStatementTwo]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupRateBasedStatementTwo' function Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet. Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html .PARAMETER Arn The Amazon Resource Name ARN of the RegexPatternSet that this statement references. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-arn UpdateType: Mutable PrimitiveType: String .PARAMETER FieldToMatch The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupRegexPatternSetReferenceStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Arn, [parameter(Mandatory = $true)] $FieldToMatch, [parameter(Mandatory = $true)] [object] $TextTransformations ) Process { $obj = [WAFv2RuleGroupRegexPatternSetReferenceStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupRegexPatternSetReferenceStatement' function Add-VSWAFv2RuleGroupRule { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.Rule resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.Rule resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. Each rule includes one top-level Statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html .PARAMETER Name A friendly name of the rule. You can't change the name of a Rule after you create it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-name UpdateType: Mutable PrimitiveType: String .PARAMETER Priority If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-priority UpdateType: Mutable PrimitiveType: Integer .PARAMETER Statement The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-statement UpdateType: Mutable Type: StatementOne .PARAMETER Action The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-action UpdateType: Mutable Type: RuleAction .PARAMETER VisibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-visibilityconfig UpdateType: Mutable Type: VisibilityConfig .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupRule])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Name, [parameter(Mandatory = $true)] [object] $Priority, [parameter(Mandatory = $true)] $Statement, [parameter(Mandatory = $false)] $Action, [parameter(Mandatory = $true)] $VisibilityConfig ) Process { $obj = [WAFv2RuleGroupRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupRule' function Add-VSWAFv2RuleGroupRuleAction { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.RuleAction resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.RuleAction resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html .PARAMETER Allow Instructs AWS WAF to allow the web request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-allow UpdateType: Mutable PrimitiveType: Json .PARAMETER Block Instructs AWS WAF to block the web request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-block UpdateType: Mutable PrimitiveType: Json .PARAMETER Count Instructs AWS WAF to count the web request and allow it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-count UpdateType: Mutable PrimitiveType: Json .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupRuleAction])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [VSJson] $Allow, [parameter(Mandatory = $false)] [VSJson] $Block, [parameter(Mandatory = $false)] [VSJson] $Count ) Process { $obj = [WAFv2RuleGroupRuleAction]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupRuleAction' function Add-VSWAFv2RuleGroupSizeConstraintStatement { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.SizeConstraintStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.SizeConstraintStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (> or less than (<. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. If you choose URI for the value of Part of the request to filter on, the slash (/ in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html .PARAMETER FieldToMatch The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER ComparisonOperator The operator to use to compare the request part to the size setting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-comparisonoperator UpdateType: Mutable PrimitiveType: String .PARAMETER Size The size, in byte, to compare to the request part, after any transformations. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-size UpdateType: Mutable PrimitiveType: Integer .PARAMETER TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupSizeConstraintStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $FieldToMatch, [parameter(Mandatory = $true)] [object] $ComparisonOperator, [parameter(Mandatory = $true)] [object] $Size, [parameter(Mandatory = $true)] [object] $TextTransformations ) Process { $obj = [WAFv2RuleGroupSizeConstraintStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupSizeConstraintStatement' function Add-VSWAFv2RuleGroupSqliMatchStatement { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.SqliMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.SqliMatchStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html .PARAMETER FieldToMatch The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html#cfn-wafv2-rulegroup-sqlimatchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html#cfn-wafv2-rulegroup-sqlimatchstatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupSqliMatchStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $FieldToMatch, [parameter(Mandatory = $true)] [object] $TextTransformations ) Process { $obj = [WAFv2RuleGroupSqliMatchStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupSqliMatchStatement' function Add-VSWAFv2RuleGroupStatementOne { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.StatementOne resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.StatementOne resource property to the template. Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html .PARAMETER ByteMatchStatement A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement Statement used to identify web requests based on country of origin. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER IPSetReferenceStatement Statement that references a set of IP addresses to compare to incoming requests. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .PARAMETER RateBasedStatement A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-ratebasedstatement UpdateType: Mutable Type: RateBasedStatementOne .PARAMETER AndStatement Logical AND statement used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-andstatement UpdateType: Mutable Type: AndStatementOne .PARAMETER OrStatement Logical OR statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-orstatement UpdateType: Mutable Type: OrStatementOne .PARAMETER NotStatement Logical NOT statement used to negate the match results of a nested statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementone.html#cfn-wafv2-rulegroup-statementone-notstatement UpdateType: Mutable Type: NotStatementOne .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupStatementOne])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ByteMatchStatement, [parameter(Mandatory = $false)] $SqliMatchStatement, [parameter(Mandatory = $false)] $XssMatchStatement, [parameter(Mandatory = $false)] $SizeConstraintStatement, [parameter(Mandatory = $false)] $GeoMatchStatement, [parameter(Mandatory = $false)] $IPSetReferenceStatement, [parameter(Mandatory = $false)] $RegexPatternSetReferenceStatement, [parameter(Mandatory = $false)] $RateBasedStatement, [parameter(Mandatory = $false)] $AndStatement, [parameter(Mandatory = $false)] $OrStatement, [parameter(Mandatory = $false)] $NotStatement ) Process { $obj = [WAFv2RuleGroupStatementOne]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupStatementOne' function Add-VSWAFv2RuleGroupStatementThree { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.StatementThree resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.StatementThree resource property to the template. Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html .PARAMETER ByteMatchStatement A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement Statement used to identify web requests based on country of origin. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER IPSetReferenceStatement Statement that references a set of IP addresses to compare to incoming requests. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementthree.html#cfn-wafv2-rulegroup-statementthree-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupStatementThree])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ByteMatchStatement, [parameter(Mandatory = $false)] $SqliMatchStatement, [parameter(Mandatory = $false)] $XssMatchStatement, [parameter(Mandatory = $false)] $SizeConstraintStatement, [parameter(Mandatory = $false)] $GeoMatchStatement, [parameter(Mandatory = $false)] $IPSetReferenceStatement, [parameter(Mandatory = $false)] $RegexPatternSetReferenceStatement ) Process { $obj = [WAFv2RuleGroupStatementThree]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupStatementThree' function Add-VSWAFv2RuleGroupStatementTwo { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.StatementTwo resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.StatementTwo resource property to the template. Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html .PARAMETER ByteMatchStatement A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement Statement used to identify web requests based on country of origin. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER IPSetReferenceStatement Statement that references a set of IP addresses to compare to incoming requests. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .PARAMETER RateBasedStatement A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-ratebasedstatement UpdateType: Mutable Type: RateBasedStatementTwo .PARAMETER AndStatement Logical AND statement used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-andstatement UpdateType: Mutable Type: AndStatementTwo .PARAMETER OrStatement Logical OR statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-orstatement UpdateType: Mutable Type: OrStatementTwo .PARAMETER NotStatement Logical NOT statement used to negate the match results of a nested statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statementtwo.html#cfn-wafv2-rulegroup-statementtwo-notstatement UpdateType: Mutable Type: NotStatementTwo .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupStatementTwo])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ByteMatchStatement, [parameter(Mandatory = $false)] $SqliMatchStatement, [parameter(Mandatory = $false)] $XssMatchStatement, [parameter(Mandatory = $false)] $SizeConstraintStatement, [parameter(Mandatory = $false)] $GeoMatchStatement, [parameter(Mandatory = $false)] $IPSetReferenceStatement, [parameter(Mandatory = $false)] $RegexPatternSetReferenceStatement, [parameter(Mandatory = $false)] $RateBasedStatement, [parameter(Mandatory = $false)] $AndStatement, [parameter(Mandatory = $false)] $OrStatement, [parameter(Mandatory = $false)] $NotStatement ) Process { $obj = [WAFv2RuleGroupStatementTwo]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupStatementTwo' function Add-VSWAFv2RuleGroupTextTransformation { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.TextTransformation resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.TextTransformation resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html .PARAMETER Priority Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html#cfn-wafv2-rulegroup-texttransformation-priority UpdateType: Mutable PrimitiveType: Integer .PARAMETER Type You can specify the following transformation types: **CMD_LINE** When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: + Delete the following characters: " ' ^ + Delete spaces before the following characters: / + Replace the following characters with a space: , ; + Replace multiple spaces with one space + Convert uppercase letters A-Z to lowercase a-z **COMPRESS_WHITE_SPACE** Use this option to replace the following characters with a space character decimal 32: + f, formfeed, decimal 12 + t, tab, decimal 9 + n, newline, decimal 10 + r, carriage return, decimal 13 + v, vertical tab, decimal 11 + non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. **HTML_ENTITY_DECODE** Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: + Replaces ampersandquot; with " + Replaces ampersandnbsp; with a non-breaking space, decimal 160 + Replaces ampersandlt; with a "less than" symbol + Replaces ampersandgt; with > + Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters + Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters **LOWERCASE** Use this option to convert uppercase letters A-Z to lowercase a-z. **URL_DECODE** Use this option to decode a URL-encoded value. **NONE** Specify NONE if you don't want any text transformations. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html#cfn-wafv2-rulegroup-texttransformation-type UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupTextTransformation])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Priority, [parameter(Mandatory = $true)] [object] $Type ) Process { $obj = [WAFv2RuleGroupTextTransformation]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupTextTransformation' function Add-VSWAFv2RuleGroupVisibilityConfig { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.VisibilityConfig resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.VisibilityConfig resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Defines and enables Amazon CloudWatch metrics and web request sample collection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html .PARAMETER SampledRequestsEnabled A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-sampledrequestsenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER CloudWatchMetricsEnabled A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics: https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-cloudwatchmetricsenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER MetricName A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters A-Z, a-z, 0-9, with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-metricname UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupVisibilityConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $SampledRequestsEnabled, [parameter(Mandatory = $true)] [object] $CloudWatchMetricsEnabled, [parameter(Mandatory = $true)] [object] $MetricName ) Process { $obj = [WAFv2RuleGroupVisibilityConfig]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupVisibilityConfig' function Add-VSWAFv2RuleGroupXssMatchStatement { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup.XssMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup.XssMatchStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement that defines a cross-site scripting (XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html .PARAMETER FieldToMatch The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html#cfn-wafv2-rulegroup-xssmatchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html#cfn-wafv2-rulegroup-xssmatchstatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroupXssMatchStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $FieldToMatch, [parameter(Mandatory = $true)] [object] $TextTransformations ) Process { $obj = [WAFv2RuleGroupXssMatchStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2RuleGroupXssMatchStatement' function Add-VSWAFv2WebACLAndStatementOne { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.AndStatementOne resource property to the template. Logical AND statement used in statement nesting. .DESCRIPTION Adds an AWS::WAFv2::WebACL.AndStatementOne resource property to the template. Logical AND statement used in statement nesting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatementone.html .PARAMETER Statements Logical AND statements used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatementone.html#cfn-wafv2-webacl-andstatementone-statements UpdateType: Mutable Type: List ItemType: StatementTwo .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLAndStatementOne])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Statements ) Process { $obj = [WAFv2WebACLAndStatementOne]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLAndStatementOne' function Add-VSWAFv2WebACLAndStatementTwo { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.AndStatementTwo resource property to the template. Logical AND statement used in statement nesting. .DESCRIPTION Adds an AWS::WAFv2::WebACL.AndStatementTwo resource property to the template. Logical AND statement used in statement nesting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatementtwo.html .PARAMETER Statements Logical AND statements used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatementtwo.html#cfn-wafv2-webacl-andstatementtwo-statements UpdateType: Mutable Type: List ItemType: StatementThree .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLAndStatementTwo])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Statements ) Process { $obj = [WAFv2WebACLAndStatementTwo]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLAndStatementTwo' function Add-VSWAFv2WebACLByteMatchStatement { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.ByteMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.ByteMatchStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html .PARAMETER SearchString A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive. Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you. For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you provide the string BadBot in the value of SearchString. You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-searchstring UpdateType: Mutable PrimitiveType: String .PARAMETER SearchStringBase64 String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in SearchString instead. You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-searchstringbase64 UpdateType: Mutable PrimitiveType: String .PARAMETER FieldToMatch The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .PARAMETER PositionalConstraint The area within the portion of a web request that you want AWS WAF to search for SearchString. Valid values include the following: **CONTAINS** The specified part of the web request must include the value of SearchString, but the location doesn't matter. **CONTAINS_WORD** The specified part of the web request must include the value of SearchString, and SearchString must contain only alphanumeric characters or underscore A-Z, a-z, 0-9, or _. In addition, SearchString must be a word, which means that both of the following are true: + SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore _. Examples include the value of a header and ;BadBot. + SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore _, for example, BadBot; and -BadBot;. **EXACTLY** The value of the specified part of the web request must exactly match the value of SearchString. **STARTS_WITH** The value of SearchString must appear at the beginning of the specified part of the web request. **ENDS_WITH** The value of SearchString must appear at the end of the specified part of the web request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-positionalconstraint UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLByteMatchStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $SearchString, [parameter(Mandatory = $false)] [object] $SearchStringBase64, [parameter(Mandatory = $true)] $FieldToMatch, [parameter(Mandatory = $true)] [object] $TextTransformations, [parameter(Mandatory = $true)] [object] $PositionalConstraint ) Process { $obj = [WAFv2WebACLByteMatchStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLByteMatchStatement' function Add-VSWAFv2WebACLDefaultAction { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.DefaultAction resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.DefaultAction resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. In a WebACL, this is the action that you want AWS WAF to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action, so count is not allowed. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html .PARAMETER Allow Specifies that AWS WAF should allow requests by default. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html#cfn-wafv2-webacl-defaultaction-allow UpdateType: Mutable PrimitiveType: Json .PARAMETER Block Specifies that AWS WAF should block requests by default. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html#cfn-wafv2-webacl-defaultaction-block UpdateType: Mutable PrimitiveType: Json .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLDefaultAction])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [VSJson] $Allow, [parameter(Mandatory = $false)] [VSJson] $Block ) Process { $obj = [WAFv2WebACLDefaultAction]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLDefaultAction' function Add-VSWAFv2WebACLExcludedRule { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.ExcludedRule resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.ExcludedRule resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT. This effectively excludes the rule from acting on web requests. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html .PARAMETER Name The name of the rule to exclude. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html#cfn-wafv2-webacl-excludedrule-name UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLExcludedRule])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Name ) Process { $obj = [WAFv2WebACLExcludedRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLExcludedRule' function Add-VSWAFv2WebACLFieldToMatch { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.FieldToMatch resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.FieldToMatch resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. The part of a web request that you want AWS WAF to inspect. Include the FieldToMatch types that you want to inspect, with additional specifications as needed, according to the type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html .PARAMETER SingleHeader Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-singleheader UpdateType: Mutable PrimitiveType: Json .PARAMETER SingleQueryArgument Inspect a single query argument. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*. The name can be up to 30 characters long and isn't case sensitive. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-singlequeryargument UpdateType: Mutable PrimitiveType: Json .PARAMETER AllQueryArguments Inspect all query arguments. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-allqueryarguments UpdateType: Mutable PrimitiveType: Json .PARAMETER UriPath Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-uripath UpdateType: Mutable PrimitiveType: Json .PARAMETER QueryString Inspect the query string. This is the part of a URL that appears after a ? character, if any. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-querystring UpdateType: Mutable PrimitiveType: Json .PARAMETER Body Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. Note that only the first 8 KB 8192 bytes of the request body are forwarded to AWS WAF for inspection. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-body UpdateType: Mutable PrimitiveType: Json .PARAMETER Method Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-method UpdateType: Mutable PrimitiveType: Json .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLFieldToMatch])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [VSJson] $SingleHeader, [parameter(Mandatory = $false)] [VSJson] $SingleQueryArgument, [parameter(Mandatory = $false)] [VSJson] $AllQueryArguments, [parameter(Mandatory = $false)] [VSJson] $UriPath, [parameter(Mandatory = $false)] [VSJson] $QueryString, [parameter(Mandatory = $false)] [VSJson] $Body, [parameter(Mandatory = $false)] [VSJson] $Method ) Process { $obj = [WAFv2WebACLFieldToMatch]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLFieldToMatch' function Add-VSWAFv2WebACLForwardedIPConfiguration { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.ForwardedIPConfiguration resource property to the template. .DESCRIPTION Adds an AWS::WAFv2::WebACL.ForwardedIPConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html .PARAMETER HeaderName Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html#cfn-wafv2-webacl-forwardedipconfiguration-headername UpdateType: Mutable PrimitiveType: String .PARAMETER FallbackBehavior Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html#cfn-wafv2-webacl-forwardedipconfiguration-fallbackbehavior UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLForwardedIPConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $HeaderName, [parameter(Mandatory = $true)] [object] $FallbackBehavior ) Process { $obj = [WAFv2WebACLForwardedIPConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLForwardedIPConfiguration' function Add-VSWAFv2WebACLGeoMatchStatement { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.GeoMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.GeoMatchStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement used to identify web requests based on country of origin. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html .PARAMETER CountryCodes An array of two-character country codes, for example, "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html#cfn-wafv2-webacl-geomatchstatement-countrycodes UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER ForwardedIPConfig *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html#cfn-wafv2-webacl-geomatchstatement-forwardedipconfig UpdateType: Mutable Type: ForwardedIPConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLGeoMatchStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $CountryCodes, [parameter(Mandatory = $false)] $ForwardedIPConfig ) Process { $obj = [WAFv2WebACLGeoMatchStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLGeoMatchStatement' function Add-VSWAFv2WebACLIPSetForwardedIPConfiguration { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.IPSetForwardedIPConfiguration resource property to the template. .DESCRIPTION Adds an AWS::WAFv2::WebACL.IPSetForwardedIPConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetforwardedipconfiguration.html .PARAMETER HeaderName Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetforwardedipconfiguration.html#cfn-wafv2-webacl-ipsetforwardedipconfiguration-headername UpdateType: Mutable PrimitiveType: String .PARAMETER FallbackBehavior Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetforwardedipconfiguration.html#cfn-wafv2-webacl-ipsetforwardedipconfiguration-fallbackbehavior UpdateType: Mutable PrimitiveType: String .PARAMETER Position Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetforwardedipconfiguration.html#cfn-wafv2-webacl-ipsetforwardedipconfiguration-position UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLIPSetForwardedIPConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $HeaderName, [parameter(Mandatory = $true)] [object] $FallbackBehavior, [parameter(Mandatory = $true)] [object] $Position ) Process { $obj = [WAFv2WebACLIPSetForwardedIPConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLIPSetForwardedIPConfiguration' function Add-VSWAFv2WebACLIPSetReferenceStatement { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.IPSetReferenceStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.IPSetReferenceStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet. Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetreferencestatement.html .PARAMETER Arn The Amazon Resource Name ARN of the IPSet that this statement references. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetreferencestatement.html#cfn-wafv2-webacl-ipsetreferencestatement-arn UpdateType: Mutable PrimitiveType: String .PARAMETER IPSetForwardedIPConfig *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetreferencestatement.html#cfn-wafv2-webacl-ipsetreferencestatement-ipsetforwardedipconfig UpdateType: Mutable Type: IPSetForwardedIPConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLIPSetReferenceStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Arn, [parameter(Mandatory = $false)] $IPSetForwardedIPConfig ) Process { $obj = [WAFv2WebACLIPSetReferenceStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLIPSetReferenceStatement' function Add-VSWAFv2WebACLManagedRuleGroupStatement { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.ManagedRuleGroupStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.ManagedRuleGroupStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups. You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html .PARAMETER Name The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-name UpdateType: Mutable PrimitiveType: String .PARAMETER VendorName The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-vendorname UpdateType: Mutable PrimitiveType: String .PARAMETER ExcludedRules The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-excludedrules UpdateType: Mutable Type: List ItemType: ExcludedRule .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLManagedRuleGroupStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Name, [parameter(Mandatory = $true)] [object] $VendorName, [parameter(Mandatory = $false)] [object] $ExcludedRules ) Process { $obj = [WAFv2WebACLManagedRuleGroupStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLManagedRuleGroupStatement' function Add-VSWAFv2WebACLNotStatementOne { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.NotStatementOne resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.NotStatementOne resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatementone.html .PARAMETER Statement Logical NOT statement used to negate the match results of a nested statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatementone.html#cfn-wafv2-webacl-notstatementone-statement UpdateType: Mutable Type: StatementTwo .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLNotStatementOne])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $Statement ) Process { $obj = [WAFv2WebACLNotStatementOne]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLNotStatementOne' function Add-VSWAFv2WebACLNotStatementTwo { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.NotStatementTwo resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.NotStatementTwo resource property to the template. Logical NOT statement used to negate the match results of a nested statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatementtwo.html .PARAMETER Statement Logical NOT statement used to negate the match results of a nested statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatementtwo.html#cfn-wafv2-webacl-notstatementtwo-statement UpdateType: Mutable Type: StatementThree .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLNotStatementTwo])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $Statement ) Process { $obj = [WAFv2WebACLNotStatementTwo]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLNotStatementTwo' function Add-VSWAFv2WebACLOrStatementOne { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.OrStatementOne resource property to the template. Logical OR statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.OrStatementOne resource property to the template. Logical OR statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatementone.html .PARAMETER Statements Logical OR statement used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatementone.html#cfn-wafv2-webacl-orstatementone-statements UpdateType: Mutable Type: List ItemType: StatementTwo .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLOrStatementOne])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Statements ) Process { $obj = [WAFv2WebACLOrStatementOne]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLOrStatementOne' function Add-VSWAFv2WebACLOrStatementTwo { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.OrStatementTwo resource property to the template. Logical OR statement used in statement nesting. .DESCRIPTION Adds an AWS::WAFv2::WebACL.OrStatementTwo resource property to the template. Logical OR statement used in statement nesting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatementtwo.html .PARAMETER Statements Logical OR statements used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatementtwo.html#cfn-wafv2-webacl-orstatementtwo-statements UpdateType: Mutable Type: List ItemType: StatementThree .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLOrStatementTwo])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Statements ) Process { $obj = [WAFv2WebACLOrStatementTwo]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLOrStatementTwo' function Add-VSWAFv2WebACLOverrideAction { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.OverrideAction resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.OverrideAction resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. The action to use to override the Action settings on the rules in the web ACL. You can use none, in which case the rule actions are in effect, or count, in which case, if a rule matches a web request, it only counts the match. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html .PARAMETER Count Override the rule action settings to count. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html#cfn-wafv2-webacl-overrideaction-count UpdateType: Mutable PrimitiveType: Json .PARAMETER None Don't override the rule action settings. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html#cfn-wafv2-webacl-overrideaction-none UpdateType: Mutable PrimitiveType: Json .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLOverrideAction])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [VSJson] $Count, [parameter(Mandatory = $false)] [VSJson] $None ) Process { $obj = [WAFv2WebACLOverrideAction]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLOverrideAction' function Add-VSWAFv2WebACLRateBasedStatementOne { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.RateBasedStatementOne resource property to the template. A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. .DESCRIPTION Adds an AWS::WAFv2::WebACL.RateBasedStatementOne resource property to the template. A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementone.html .PARAMETER Limit Limit on the web request that match any nested statement criteria in any 5 minute period. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementone.html#cfn-wafv2-webacl-ratebasedstatementone-limit UpdateType: Mutable PrimitiveType: Integer .PARAMETER AggregateKeyType Setting that indicates how to aggregate the request counts. Currently, you must set this to IP. The request counts are aggregated on IP addresses. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementone.html#cfn-wafv2-webacl-ratebasedstatementone-aggregatekeytype UpdateType: Mutable PrimitiveType: String .PARAMETER ScopeDownStatement Statement nested inside a rate-based statement to narrow the scope of the requests that AWS WAF counts. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementone.html#cfn-wafv2-webacl-ratebasedstatementone-scopedownstatement UpdateType: Mutable Type: StatementTwo .PARAMETER ForwardedIPConfig *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementone.html#cfn-wafv2-webacl-ratebasedstatementone-forwardedipconfig UpdateType: Mutable Type: ForwardedIPConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLRateBasedStatementOne])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Limit, [parameter(Mandatory = $true)] [object] $AggregateKeyType, [parameter(Mandatory = $false)] $ScopeDownStatement, [parameter(Mandatory = $false)] $ForwardedIPConfig ) Process { $obj = [WAFv2WebACLRateBasedStatementOne]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLRateBasedStatementOne' function Add-VSWAFv2WebACLRateBasedStatementTwo { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.RateBasedStatementTwo resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.RateBasedStatementTwo resource property to the template. Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementtwo.html .PARAMETER Limit Limit on the web request that match any nested statement criteria in any 5 minute period. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementtwo.html#cfn-wafv2-webacl-ratebasedstatementtwo-limit UpdateType: Mutable PrimitiveType: Integer .PARAMETER AggregateKeyType Setting that indicates how to aggregate the request counts. Currently, you must set this to IP. The request counts are aggregated on IP addresses. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementtwo.html#cfn-wafv2-webacl-ratebasedstatementtwo-aggregatekeytype UpdateType: Mutable PrimitiveType: String .PARAMETER ScopeDownStatement Statement nested inside a rate-based statement to narrow the scope of the requests that AWS WAF counts. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementtwo.html#cfn-wafv2-webacl-ratebasedstatementtwo-scopedownstatement UpdateType: Mutable Type: StatementThree .PARAMETER ForwardedIPConfig *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementtwo.html#cfn-wafv2-webacl-ratebasedstatementtwo-forwardedipconfig UpdateType: Mutable Type: ForwardedIPConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLRateBasedStatementTwo])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Limit, [parameter(Mandatory = $true)] [object] $AggregateKeyType, [parameter(Mandatory = $false)] $ScopeDownStatement, [parameter(Mandatory = $false)] $ForwardedIPConfig ) Process { $obj = [WAFv2WebACLRateBasedStatementTwo]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLRateBasedStatementTwo' function Add-VSWAFv2WebACLRegexPatternSetReferenceStatement { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet. Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html .PARAMETER Arn The Amazon Resource Name ARN of the RegexPatternSet that this statement references. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html#cfn-wafv2-webacl-regexpatternsetreferencestatement-arn UpdateType: Mutable PrimitiveType: String .PARAMETER FieldToMatch The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html#cfn-wafv2-webacl-regexpatternsetreferencestatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html#cfn-wafv2-webacl-regexpatternsetreferencestatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLRegexPatternSetReferenceStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Arn, [parameter(Mandatory = $true)] $FieldToMatch, [parameter(Mandatory = $true)] [object] $TextTransformations ) Process { $obj = [WAFv2WebACLRegexPatternSetReferenceStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLRegexPatternSetReferenceStatement' function Add-VSWAFv2WebACLRule { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.Rule resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.Rule resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. Each rule includes one top-level Statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html .PARAMETER Name A friendly name of the rule. You can't change the name of a Rule after you create it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-name UpdateType: Mutable PrimitiveType: String .PARAMETER Priority If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-priority UpdateType: Mutable PrimitiveType: Integer .PARAMETER Statement The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-statement UpdateType: Mutable Type: StatementOne .PARAMETER Action The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting. This is used only for rules whose statements don't reference a rule group. Rule statements that reference a rule group are RuleGroupReferenceStatement and ManagedRuleGroupReferenceStatement. You must set either this Action setting or the rule's OverrideAction, but not both: + If the rule statement doesn't reference a rule group, you must set this rule action setting and you must not set the rule's override action setting. + If the rule statement references a rule group, you must not set this action setting, because the actions are already set on the rules inside the rule group. You must set the rule's override action setting to indicate specifically whether to override the actions that are set on the rules in the rule group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-action UpdateType: Mutable Type: RuleAction .PARAMETER OverrideAction The override action to apply to the rules in a rule group, instead of the individual rule action settings. This is used only for rules whose statements reference a rule group. Rule statements that reference a rule group are RuleGroupReferenceStatement and ManagedRuleGroupReferenceStatement. Set the override action to none to leave the rule group rule actions in effect. Set it to count to only count matches, regardless of the rule action settings. You must set either this OverrideAction setting or the Action setting, but not both: + If the rule statement references a rule group, you must set this override action setting and you must not set the rule's action setting. + If the rule statement doesn't reference a rule group, you must set the rule action setting and you must not set the rule's override action setting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-overrideaction UpdateType: Mutable Type: OverrideAction .PARAMETER VisibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-visibilityconfig UpdateType: Mutable Type: VisibilityConfig .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLRule])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Name, [parameter(Mandatory = $true)] [object] $Priority, [parameter(Mandatory = $true)] $Statement, [parameter(Mandatory = $false)] $Action, [parameter(Mandatory = $false)] $OverrideAction, [parameter(Mandatory = $true)] $VisibilityConfig ) Process { $obj = [WAFv2WebACLRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLRule' function Add-VSWAFv2WebACLRuleAction { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.RuleAction resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.RuleAction resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html .PARAMETER Allow Instructs AWS WAF to allow the web request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-allow UpdateType: Mutable PrimitiveType: Json .PARAMETER Block Instructs AWS WAF to block the web request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-block UpdateType: Mutable PrimitiveType: Json .PARAMETER Count Instructs AWS WAF to count the web request and allow it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-count UpdateType: Mutable PrimitiveType: Json .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLRuleAction])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [VSJson] $Allow, [parameter(Mandatory = $false)] [VSJson] $Block, [parameter(Mandatory = $false)] [VSJson] $Count ) Process { $obj = [WAFv2WebACLRuleAction]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLRuleAction' function Add-VSWAFv2WebACLRuleGroupReferenceStatement { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.RuleGroupReferenceStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.RuleGroupReferenceStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html .PARAMETER Arn The Amazon Resource Name ARN of the entity. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-arn UpdateType: Mutable PrimitiveType: String .PARAMETER ExcludedRules The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-excludedrules UpdateType: Mutable Type: List ItemType: ExcludedRule .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLRuleGroupReferenceStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Arn, [parameter(Mandatory = $false)] [object] $ExcludedRules ) Process { $obj = [WAFv2WebACLRuleGroupReferenceStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLRuleGroupReferenceStatement' function Add-VSWAFv2WebACLSizeConstraintStatement { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.SizeConstraintStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.SizeConstraintStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (> or less than (<. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. If you choose URI for the value of Part of the request to filter on, the slash (/ in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html .PARAMETER FieldToMatch The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER ComparisonOperator The operator to use to compare the request part to the size setting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-comparisonoperator UpdateType: Mutable PrimitiveType: String .PARAMETER Size The size, in byte, to compare to the request part, after any transformations. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-size UpdateType: Mutable PrimitiveType: Integer .PARAMETER TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLSizeConstraintStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $FieldToMatch, [parameter(Mandatory = $true)] [object] $ComparisonOperator, [parameter(Mandatory = $true)] [object] $Size, [parameter(Mandatory = $true)] [object] $TextTransformations ) Process { $obj = [WAFv2WebACLSizeConstraintStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLSizeConstraintStatement' function Add-VSWAFv2WebACLSqliMatchStatement { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.SqliMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.SqliMatchStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html .PARAMETER FieldToMatch The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html#cfn-wafv2-webacl-sqlimatchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html#cfn-wafv2-webacl-sqlimatchstatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLSqliMatchStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $FieldToMatch, [parameter(Mandatory = $true)] [object] $TextTransformations ) Process { $obj = [WAFv2WebACLSqliMatchStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLSqliMatchStatement' function Add-VSWAFv2WebACLStatementOne { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.StatementOne resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.StatementOne resource property to the template. Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html .PARAMETER ByteMatchStatement A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement Statement used to identify web requests based on country of origin. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER RuleGroupReferenceStatement A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You can't nest this type of statement within another. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-rulegroupreferencestatement UpdateType: Mutable Type: RuleGroupReferenceStatement .PARAMETER IPSetReferenceStatement Statement that references a set of IP addresses to compare to incoming requests. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .PARAMETER ManagedRuleGroupStatement Statement that references a managed rule group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-managedrulegroupstatement UpdateType: Mutable Type: ManagedRuleGroupStatement .PARAMETER RateBasedStatement A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-ratebasedstatement UpdateType: Mutable Type: RateBasedStatementOne .PARAMETER AndStatement Logical AND statement used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-andstatement UpdateType: Mutable Type: AndStatementOne .PARAMETER OrStatement Logical OR statement used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-orstatement UpdateType: Mutable Type: OrStatementOne .PARAMETER NotStatement Logical NOT statement used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementone.html#cfn-wafv2-webacl-statementone-notstatement UpdateType: Mutable Type: NotStatementOne .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLStatementOne])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ByteMatchStatement, [parameter(Mandatory = $false)] $SqliMatchStatement, [parameter(Mandatory = $false)] $XssMatchStatement, [parameter(Mandatory = $false)] $SizeConstraintStatement, [parameter(Mandatory = $false)] $GeoMatchStatement, [parameter(Mandatory = $false)] $RuleGroupReferenceStatement, [parameter(Mandatory = $false)] $IPSetReferenceStatement, [parameter(Mandatory = $false)] $RegexPatternSetReferenceStatement, [parameter(Mandatory = $false)] $ManagedRuleGroupStatement, [parameter(Mandatory = $false)] $RateBasedStatement, [parameter(Mandatory = $false)] $AndStatement, [parameter(Mandatory = $false)] $OrStatement, [parameter(Mandatory = $false)] $NotStatement ) Process { $obj = [WAFv2WebACLStatementOne]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLStatementOne' function Add-VSWAFv2WebACLStatementThree { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.StatementThree resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.StatementThree resource property to the template. Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html .PARAMETER ByteMatchStatement A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement Statement used to identify web requests based on country of origin. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER RuleGroupReferenceStatement A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You can't nest this type of statement within another. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-rulegroupreferencestatement UpdateType: Mutable Type: RuleGroupReferenceStatement .PARAMETER IPSetReferenceStatement Statement that references a set of IP addresses to compare to incoming requests. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .PARAMETER ManagedRuleGroupStatement Statement that references a managed rule group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementthree.html#cfn-wafv2-webacl-statementthree-managedrulegroupstatement UpdateType: Mutable Type: ManagedRuleGroupStatement .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLStatementThree])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ByteMatchStatement, [parameter(Mandatory = $false)] $SqliMatchStatement, [parameter(Mandatory = $false)] $XssMatchStatement, [parameter(Mandatory = $false)] $SizeConstraintStatement, [parameter(Mandatory = $false)] $GeoMatchStatement, [parameter(Mandatory = $false)] $RuleGroupReferenceStatement, [parameter(Mandatory = $false)] $IPSetReferenceStatement, [parameter(Mandatory = $false)] $RegexPatternSetReferenceStatement, [parameter(Mandatory = $false)] $ManagedRuleGroupStatement ) Process { $obj = [WAFv2WebACLStatementThree]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLStatementThree' function Add-VSWAFv2WebACLStatementTwo { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.StatementTwo resource property to the template. Rules statement. .DESCRIPTION Adds an AWS::WAFv2::WebACL.StatementTwo resource property to the template. Rules statement. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html .PARAMETER ByteMatchStatement A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-bytematchstatement UpdateType: Mutable Type: ByteMatchStatement .PARAMETER SqliMatchStatement Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-sqlimatchstatement UpdateType: Mutable Type: SqliMatchStatement .PARAMETER XssMatchStatement A rule statement that defines a cross-site scripting XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-xssmatchstatement UpdateType: Mutable Type: XssMatchStatement .PARAMETER SizeConstraintStatement A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than or less than. For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes 8 KB. If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. If you choose URI for the value of Part of the request to filter on, the slash / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-sizeconstraintstatement UpdateType: Mutable Type: SizeConstraintStatement .PARAMETER GeoMatchStatement Statement used to identify web requests based on country of origin. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-geomatchstatement UpdateType: Mutable Type: GeoMatchStatement .PARAMETER RuleGroupReferenceStatement A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You can't nest this type of statement within another. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-rulegroupreferencestatement UpdateType: Mutable Type: RuleGroupReferenceStatement .PARAMETER IPSetReferenceStatement Statement that references a set of IP addresses to compare to incoming requests. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-ipsetreferencestatement UpdateType: Mutable Type: IPSetReferenceStatement .PARAMETER RegexPatternSetReferenceStatement A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet with the expressions that you want to detect, then use that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-regexpatternsetreferencestatement UpdateType: Mutable Type: RegexPatternSetReferenceStatement .PARAMETER ManagedRuleGroupStatement Statement that references a managed rule group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-managedrulegroupstatement UpdateType: Mutable Type: ManagedRuleGroupStatement .PARAMETER RateBasedStatement A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that's sending excessive requests. When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. You can't nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-ratebasedstatement UpdateType: Mutable Type: RateBasedStatementTwo .PARAMETER AndStatement Logical AND statement used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-andstatement UpdateType: Mutable Type: AndStatementTwo .PARAMETER OrStatement Logical OR statement used in statement nesting. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-orstatement UpdateType: Mutable Type: OrStatementTwo .PARAMETER NotStatement Logical NOT statement used to negate the match results of a nested statement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statementtwo.html#cfn-wafv2-webacl-statementtwo-notstatement UpdateType: Mutable Type: NotStatementTwo .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLStatementTwo])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ByteMatchStatement, [parameter(Mandatory = $false)] $SqliMatchStatement, [parameter(Mandatory = $false)] $XssMatchStatement, [parameter(Mandatory = $false)] $SizeConstraintStatement, [parameter(Mandatory = $false)] $GeoMatchStatement, [parameter(Mandatory = $false)] $RuleGroupReferenceStatement, [parameter(Mandatory = $false)] $IPSetReferenceStatement, [parameter(Mandatory = $false)] $RegexPatternSetReferenceStatement, [parameter(Mandatory = $false)] $ManagedRuleGroupStatement, [parameter(Mandatory = $false)] $RateBasedStatement, [parameter(Mandatory = $false)] $AndStatement, [parameter(Mandatory = $false)] $OrStatement, [parameter(Mandatory = $false)] $NotStatement ) Process { $obj = [WAFv2WebACLStatementTwo]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLStatementTwo' function Add-VSWAFv2WebACLTextTransformation { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.TextTransformation resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.TextTransformation resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html .PARAMETER Priority Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html#cfn-wafv2-webacl-texttransformation-priority UpdateType: Mutable PrimitiveType: Integer .PARAMETER Type You can specify the following transformation types: **CMD_LINE** When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: + Delete the following characters: " ' ^ + Delete spaces before the following characters: / + Replace the following characters with a space: , ; + Replace multiple spaces with one space + Convert uppercase letters A-Z to lowercase a-z **COMPRESS_WHITE_SPACE** Use this option to replace the following characters with a space character decimal 32: + f, formfeed, decimal 12 + t, tab, decimal 9 + n, newline, decimal 10 + r, carriage return, decimal 13 + v, vertical tab, decimal 11 + non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. **HTML_ENTITY_DECODE** Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: + Replaces ampersandquot; with " + Replaces ampersandnbsp; with a non-breaking space, decimal 160 + Replaces ampersandlt; with a "less than" symbol + Replaces ampersandgt; with > + Replaces characters that are represented in hexadecimal format, ampersand#xhhhh;, with the corresponding characters + Replaces characters that are represented in decimal format, ampersand#nnnn;, with the corresponding characters **LOWERCASE** Use this option to convert uppercase letters A-Z to lowercase a-z. **URL_DECODE** Use this option to decode a URL-encoded value. **NONE** Specify NONE if you don't want any text transformations. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html#cfn-wafv2-webacl-texttransformation-type UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLTextTransformation])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Priority, [parameter(Mandatory = $true)] [object] $Type ) Process { $obj = [WAFv2WebACLTextTransformation]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLTextTransformation' function Add-VSWAFv2WebACLVisibilityConfig { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.VisibilityConfig resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.VisibilityConfig resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Defines and enables Amazon CloudWatch metrics and web request sample collection. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html .PARAMETER SampledRequestsEnabled A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html#cfn-wafv2-webacl-visibilityconfig-sampledrequestsenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER CloudWatchMetricsEnabled A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics: https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html#cfn-wafv2-webacl-visibilityconfig-cloudwatchmetricsenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER MetricName A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters A-Z, a-z, 0-9, with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html#cfn-wafv2-webacl-visibilityconfig-metricname UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLVisibilityConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $SampledRequestsEnabled, [parameter(Mandatory = $true)] [object] $CloudWatchMetricsEnabled, [parameter(Mandatory = $true)] [object] $MetricName ) Process { $obj = [WAFv2WebACLVisibilityConfig]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLVisibilityConfig' function Add-VSWAFv2WebACLXssMatchStatement { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL.XssMatchStatement resource property to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL.XssMatchStatement resource property to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. A rule statement that defines a cross-site scripting (XSS match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html .PARAMETER FieldToMatch The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html#cfn-wafv2-webacl-xssmatchstatement-fieldtomatch UpdateType: Mutable Type: FieldToMatch .PARAMETER TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html#cfn-wafv2-webacl-xssmatchstatement-texttransformations UpdateType: Mutable Type: List ItemType: TextTransformation .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLXssMatchStatement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $FieldToMatch, [parameter(Mandatory = $true)] [object] $TextTransformations ) Process { $obj = [WAFv2WebACLXssMatchStatement]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSWAFv2WebACLXssMatchStatement' function New-VSWAFv2IPSet { <# .SYNOPSIS Adds an AWS::WAFv2::IPSet resource to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::IPSet resource to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Use an AWS::WAFv2::IPSet: #aws-resource-wafv2-ipset to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IP set that lists those IP addresses. You use an IP set by providing its Amazon Resource Name (ARN to the rule statement IPSetReferenceStatement, when you add a rule to a rule group or web ACL. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html .PARAMETER LogicalId The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description A friendly description of the IP set. You cannot change the description of an IP set after you create it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-description UpdateType: Mutable PrimitiveType: String .PARAMETER Name A friendly name of the IP set. You cannot change the name of an IPSet after you create it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-name UpdateType: Mutable PrimitiveType: String .PARAMETER Scope Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer ALB or an API Gateway stage. Valid Values are CLOUDFRONT and REGIONAL. For CLOUDFRONT, you must create your WAFv2 resources in the US East N. Virginia Region, us-east-1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-scope UpdateType: Mutable PrimitiveType: String .PARAMETER IPAddressVersion Specify IPV4 or IPV6. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-ipaddressversion UpdateType: Mutable PrimitiveType: String .PARAMETER Addresses Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing CIDR notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6. Examples: + To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. + To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. + To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. + To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-addresses UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER Tags Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category such as "environment" and the tag value represents a specific value within that category such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-tags UpdateType: Mutable Type: List ItemType: Tag .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER UpdateReplacePolicy Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. When you initiate a stack update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template and parameters. If you update a resource property that requires that the resource be replaced, AWS CloudFormation recreates the resource during the update. Recreating the resource generates a new physical ID. AWS CloudFormation creates the replacement resource first, and then changes references from other dependent resources to point to the replacement resource. By default, AWS CloudFormation then deletes the old resource. Using the UpdateReplacePolicy, you can specify that AWS CloudFormation retain or (in some cases) create a snapshot of the old resource. For resources that support snapshots, such as AWS::EC2::Volume, specify Snapshot to have AWS CloudFormation create a snapshot before deleting the old resource instance. You can apply the UpdateReplacePolicy attribute to any resource. UpdateReplacePolicy is only executed if you update a resource property whose update behavior is specified as Replacement, thereby causing AWS CloudFormation to replace the old resource with a new one with a new physical ID. For example, if you update the Engine property of an AWS::RDS::DBInstance resource type, AWS CloudFormation creates a new resource and replaces the current DB instance resource with the new one. The UpdateReplacePolicy attribute would then dictate whether AWS CloudFormation deleted, retained, or created a snapshot of the old DB instance. The update behavior for each property of a resource is specified in the reference topic for that resource in the AWS Resource and Property Types Reference. For more information on resource update behavior, see Update Behaviors of Stack Resources. The UpdateReplacePolicy attribute applies to stack updates you perform directly, as well as stack updates performed using change sets. Note Resources that are retained continue to exist and continue to incur applicable charges until you delete those resources. Snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots. UpdateReplacePolicy retains the old physical resource or snapshot, but removes it from AWS CloudFormation's scope. UpdateReplacePolicy differs from the DeletionPolicy attribute in that it only applies to resources replaced during stack updates. Use DeletionPolicy for resources deleted when a stack is deleted, or when the resource definition itself is deleted from the template as part of a stack update. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER DependsOn With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. .PARAMETER Metadata The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. This will be returned when describing the resource using AWS CLI. .PARAMETER UpdatePolicy Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. You must use the "Add-UpdatePolicy" function or the [UpdatePolicy] class here. .PARAMETER Condition Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2IPSet])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [object] $Description, [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $true)] [object] $Scope, [parameter(Mandatory = $true)] [object] $IPAddressVersion, [parameter(Mandatory = $true)] $Addresses, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter()] [DeletionPolicy] $DeletionPolicy, [parameter()] [UpdateReplacePolicy] $UpdateReplacePolicy, [parameter(Mandatory = $false)] [string[]] $DependsOn, [parameter(Mandatory = $false)] [VSJson] $Metadata, [parameter(Mandatory = $false)] [UpdatePolicy] $UpdatePolicy, [parameter(Mandatory = $false)] [string] $Condition ) Process { $obj = [WAFv2IPSet]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'New-VSWAFv2IPSet' function New-VSWAFv2RegexPatternSet { <# .SYNOPSIS Adds an AWS::WAFv2::RegexPatternSet resource to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RegexPatternSet resource to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Use an AWS::WAFv2::RegexPatternSet: #aws-resource-wafv2-regexpatternset to have AWS WAF inspect a web request component for a specific set of regex patterns. You use a regex pattern set by providing its Amazon Resource Name (ARN to the rule statement RegexPatternSetReferenceStatement, when you add a rule to a rule group or web ACL. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html .PARAMETER LogicalId The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Description A friendly description of the set. You cannot change the description of a set after you create it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-description UpdateType: Mutable PrimitiveType: String .PARAMETER Name A friendly name of the set. You cannot change the name after you create the set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-name UpdateType: Mutable PrimitiveType: String .PARAMETER RegularExpressionList The regular expression patterns in the set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-regularexpressionlist UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER Scope Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer ALB or an API Gateway stage. Valid Values are CLOUDFRONT and REGIONAL. For CLOUDFRONT, you must create your WAFv2 resources in the US East N. Virginia Region, us-east-1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-scope UpdateType: Mutable PrimitiveType: String .PARAMETER Tags Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category such as "environment" and the tag value represents a specific value within that category such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-tags UpdateType: Mutable Type: List ItemType: Tag .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER UpdateReplacePolicy Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. When you initiate a stack update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template and parameters. If you update a resource property that requires that the resource be replaced, AWS CloudFormation recreates the resource during the update. Recreating the resource generates a new physical ID. AWS CloudFormation creates the replacement resource first, and then changes references from other dependent resources to point to the replacement resource. By default, AWS CloudFormation then deletes the old resource. Using the UpdateReplacePolicy, you can specify that AWS CloudFormation retain or (in some cases) create a snapshot of the old resource. For resources that support snapshots, such as AWS::EC2::Volume, specify Snapshot to have AWS CloudFormation create a snapshot before deleting the old resource instance. You can apply the UpdateReplacePolicy attribute to any resource. UpdateReplacePolicy is only executed if you update a resource property whose update behavior is specified as Replacement, thereby causing AWS CloudFormation to replace the old resource with a new one with a new physical ID. For example, if you update the Engine property of an AWS::RDS::DBInstance resource type, AWS CloudFormation creates a new resource and replaces the current DB instance resource with the new one. The UpdateReplacePolicy attribute would then dictate whether AWS CloudFormation deleted, retained, or created a snapshot of the old DB instance. The update behavior for each property of a resource is specified in the reference topic for that resource in the AWS Resource and Property Types Reference. For more information on resource update behavior, see Update Behaviors of Stack Resources. The UpdateReplacePolicy attribute applies to stack updates you perform directly, as well as stack updates performed using change sets. Note Resources that are retained continue to exist and continue to incur applicable charges until you delete those resources. Snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots. UpdateReplacePolicy retains the old physical resource or snapshot, but removes it from AWS CloudFormation's scope. UpdateReplacePolicy differs from the DeletionPolicy attribute in that it only applies to resources replaced during stack updates. Use DeletionPolicy for resources deleted when a stack is deleted, or when the resource definition itself is deleted from the template as part of a stack update. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER DependsOn With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. .PARAMETER Metadata The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. This will be returned when describing the resource using AWS CLI. .PARAMETER UpdatePolicy Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. You must use the "Add-UpdatePolicy" function or the [UpdatePolicy] class here. .PARAMETER Condition Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RegexPatternSet])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [object] $Description, [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $true)] $RegularExpressionList, [parameter(Mandatory = $true)] [object] $Scope, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter()] [DeletionPolicy] $DeletionPolicy, [parameter()] [UpdateReplacePolicy] $UpdateReplacePolicy, [parameter(Mandatory = $false)] [string[]] $DependsOn, [parameter(Mandatory = $false)] [VSJson] $Metadata, [parameter(Mandatory = $false)] [UpdatePolicy] $UpdatePolicy, [parameter(Mandatory = $false)] [string] $Condition ) Process { $obj = [WAFv2RegexPatternSet]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'New-VSWAFv2RegexPatternSet' function New-VSWAFv2RuleGroup { <# .SYNOPSIS Adds an AWS::WAFv2::RuleGroup resource to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::RuleGroup resource to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Use an AWS::WAFv2::RuleGroup: #aws-resource-wafv2-rulegroup to define a collection of rules for inspecting and controlling web requests. You use a rule group in an AWS::WAFv2::WebACL: aws-resource-wafv2-webacl.md by providing its Amazon Resource Name (ARN to the rule statement RuleGroupReferenceStatement, when you add rules to the web ACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html .PARAMETER LogicalId The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Capacity The web ACL capacity units WCUs required for this rule group. When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity. AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-capacity UpdateType: Mutable PrimitiveType: Integer .PARAMETER Description A friendly description of the rule group. You cannot change the description of a rule group after you create it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-description UpdateType: Mutable PrimitiveType: String .PARAMETER Name A friendly name of the rule group. You cannot change the name of a rule group after you create it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-name UpdateType: Mutable PrimitiveType: String .PARAMETER Scope Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer ALB or an API Gateway stage. Valid Values are CLOUDFRONT and REGIONAL. For CLOUDFRONT, you must create your WAFv2 resources in the US East N. Virginia Region, us-east-1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-scope UpdateType: Mutable PrimitiveType: String .PARAMETER Rules The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-rules UpdateType: Mutable Type: List ItemType: Rule .PARAMETER VisibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-visibilityconfig UpdateType: Mutable Type: VisibilityConfig .PARAMETER Tags Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category such as "environment" and the tag value represents a specific value within that category such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-tags UpdateType: Mutable Type: List ItemType: Tag .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER UpdateReplacePolicy Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. When you initiate a stack update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template and parameters. If you update a resource property that requires that the resource be replaced, AWS CloudFormation recreates the resource during the update. Recreating the resource generates a new physical ID. AWS CloudFormation creates the replacement resource first, and then changes references from other dependent resources to point to the replacement resource. By default, AWS CloudFormation then deletes the old resource. Using the UpdateReplacePolicy, you can specify that AWS CloudFormation retain or (in some cases) create a snapshot of the old resource. For resources that support snapshots, such as AWS::EC2::Volume, specify Snapshot to have AWS CloudFormation create a snapshot before deleting the old resource instance. You can apply the UpdateReplacePolicy attribute to any resource. UpdateReplacePolicy is only executed if you update a resource property whose update behavior is specified as Replacement, thereby causing AWS CloudFormation to replace the old resource with a new one with a new physical ID. For example, if you update the Engine property of an AWS::RDS::DBInstance resource type, AWS CloudFormation creates a new resource and replaces the current DB instance resource with the new one. The UpdateReplacePolicy attribute would then dictate whether AWS CloudFormation deleted, retained, or created a snapshot of the old DB instance. The update behavior for each property of a resource is specified in the reference topic for that resource in the AWS Resource and Property Types Reference. For more information on resource update behavior, see Update Behaviors of Stack Resources. The UpdateReplacePolicy attribute applies to stack updates you perform directly, as well as stack updates performed using change sets. Note Resources that are retained continue to exist and continue to incur applicable charges until you delete those resources. Snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots. UpdateReplacePolicy retains the old physical resource or snapshot, but removes it from AWS CloudFormation's scope. UpdateReplacePolicy differs from the DeletionPolicy attribute in that it only applies to resources replaced during stack updates. Use DeletionPolicy for resources deleted when a stack is deleted, or when the resource definition itself is deleted from the template as part of a stack update. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER DependsOn With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. .PARAMETER Metadata The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. This will be returned when describing the resource using AWS CLI. .PARAMETER UpdatePolicy Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. You must use the "Add-UpdatePolicy" function or the [UpdatePolicy] class here. .PARAMETER Condition Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2RuleGroup])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $Capacity, [parameter(Mandatory = $false)] [object] $Description, [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $true)] [object] $Scope, [parameter(Mandatory = $false)] [object] $Rules, [parameter(Mandatory = $true)] $VisibilityConfig, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter()] [DeletionPolicy] $DeletionPolicy, [parameter()] [UpdateReplacePolicy] $UpdateReplacePolicy, [parameter(Mandatory = $false)] [string[]] $DependsOn, [parameter(Mandatory = $false)] [VSJson] $Metadata, [parameter(Mandatory = $false)] [UpdatePolicy] $UpdatePolicy, [parameter(Mandatory = $false)] [string] $Condition ) Process { $obj = [WAFv2RuleGroup]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'New-VSWAFv2RuleGroup' function New-VSWAFv2WebACL { <# .SYNOPSIS Adds an AWS::WAFv2::WebACL resource to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACL resource to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Use an AWS::WAFv2::WebACL: #aws-resource-wafv2-webacl to define a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block for any request that does not match any of the rules. The rules in a web ACL can contain rule statements that you define explicitly and rule statements that reference rule groups and managed rule groups. You can associate a web ACL with one or more AWS resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway API, or an Application Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html .PARAMETER LogicalId The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER DefaultAction The action to perform if none of the Rules contained in the WebACL match. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-defaultaction UpdateType: Mutable Type: DefaultAction .PARAMETER Description A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-description UpdateType: Mutable PrimitiveType: String .PARAMETER Name A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-name UpdateType: Mutable PrimitiveType: String .PARAMETER Scope Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer ALB or an API Gateway stage. Valid Values are CLOUDFRONT and REGIONAL. For CLOUDFRONT, you must create your WAFv2 resources in the US East N. Virginia Region, us-east-1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-scope UpdateType: Mutable PrimitiveType: String .PARAMETER Rules The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-rules UpdateType: Mutable Type: List ItemType: Rule .PARAMETER VisibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-visibilityconfig UpdateType: Mutable Type: VisibilityConfig .PARAMETER Tags Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category such as "environment" and the tag value represents a specific value within that category such as "test," "development," or "production". You can add up to 50 tags to each AWS resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-tags UpdateType: Mutable Type: List ItemType: Tag .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER UpdateReplacePolicy Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. When you initiate a stack update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template and parameters. If you update a resource property that requires that the resource be replaced, AWS CloudFormation recreates the resource during the update. Recreating the resource generates a new physical ID. AWS CloudFormation creates the replacement resource first, and then changes references from other dependent resources to point to the replacement resource. By default, AWS CloudFormation then deletes the old resource. Using the UpdateReplacePolicy, you can specify that AWS CloudFormation retain or (in some cases) create a snapshot of the old resource. For resources that support snapshots, such as AWS::EC2::Volume, specify Snapshot to have AWS CloudFormation create a snapshot before deleting the old resource instance. You can apply the UpdateReplacePolicy attribute to any resource. UpdateReplacePolicy is only executed if you update a resource property whose update behavior is specified as Replacement, thereby causing AWS CloudFormation to replace the old resource with a new one with a new physical ID. For example, if you update the Engine property of an AWS::RDS::DBInstance resource type, AWS CloudFormation creates a new resource and replaces the current DB instance resource with the new one. The UpdateReplacePolicy attribute would then dictate whether AWS CloudFormation deleted, retained, or created a snapshot of the old DB instance. The update behavior for each property of a resource is specified in the reference topic for that resource in the AWS Resource and Property Types Reference. For more information on resource update behavior, see Update Behaviors of Stack Resources. The UpdateReplacePolicy attribute applies to stack updates you perform directly, as well as stack updates performed using change sets. Note Resources that are retained continue to exist and continue to incur applicable charges until you delete those resources. Snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots. UpdateReplacePolicy retains the old physical resource or snapshot, but removes it from AWS CloudFormation's scope. UpdateReplacePolicy differs from the DeletionPolicy attribute in that it only applies to resources replaced during stack updates. Use DeletionPolicy for resources deleted when a stack is deleted, or when the resource definition itself is deleted from the template as part of a stack update. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER DependsOn With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. .PARAMETER Metadata The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. This will be returned when describing the resource using AWS CLI. .PARAMETER UpdatePolicy Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. You must use the "Add-UpdatePolicy" function or the [UpdatePolicy] class here. .PARAMETER Condition Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACL])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] $DefaultAction, [parameter(Mandatory = $false)] [object] $Description, [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $true)] [object] $Scope, [parameter(Mandatory = $false)] [object] $Rules, [parameter(Mandatory = $true)] $VisibilityConfig, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter()] [DeletionPolicy] $DeletionPolicy, [parameter()] [UpdateReplacePolicy] $UpdateReplacePolicy, [parameter(Mandatory = $false)] [string[]] $DependsOn, [parameter(Mandatory = $false)] [VSJson] $Metadata, [parameter(Mandatory = $false)] [UpdatePolicy] $UpdatePolicy, [parameter(Mandatory = $false)] [string] $Condition ) Process { $obj = [WAFv2WebACL]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'New-VSWAFv2WebACL' function New-VSWAFv2WebACLAssociation { <# .SYNOPSIS Adds an AWS::WAFv2::WebACLAssociation resource to the template. **Note** .DESCRIPTION Adds an AWS::WAFv2::WebACLAssociation resource to the template. **Note** This is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html. Use a web ACL association to define an association between a Web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB or an API Gateway stage. For AWS CloudFront, don't use this resource. Instead, use your CloudFront distribution configuration. To associate a Web ACL with a distribution, provide the Amazon Resource Name (ARN of the AWS::WAFv2::WebACL: aws-resource-wafv2-webacl.md to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html .PARAMETER LogicalId The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ResourceArn The Amazon Resource Name ARN of the resource to associate with the web ACL. The ARN must be in one of the following formats: + For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id + For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html#cfn-wafv2-webaclassociation-resourcearn UpdateType: Immutable PrimitiveType: String .PARAMETER WebACLArn The Amazon Resource Name ARN of the Web ACL that you want to associate with the resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html#cfn-wafv2-webaclassociation-webaclarn UpdateType: Immutable PrimitiveType: String .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER UpdateReplacePolicy Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. When you initiate a stack update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template and parameters. If you update a resource property that requires that the resource be replaced, AWS CloudFormation recreates the resource during the update. Recreating the resource generates a new physical ID. AWS CloudFormation creates the replacement resource first, and then changes references from other dependent resources to point to the replacement resource. By default, AWS CloudFormation then deletes the old resource. Using the UpdateReplacePolicy, you can specify that AWS CloudFormation retain or (in some cases) create a snapshot of the old resource. For resources that support snapshots, such as AWS::EC2::Volume, specify Snapshot to have AWS CloudFormation create a snapshot before deleting the old resource instance. You can apply the UpdateReplacePolicy attribute to any resource. UpdateReplacePolicy is only executed if you update a resource property whose update behavior is specified as Replacement, thereby causing AWS CloudFormation to replace the old resource with a new one with a new physical ID. For example, if you update the Engine property of an AWS::RDS::DBInstance resource type, AWS CloudFormation creates a new resource and replaces the current DB instance resource with the new one. The UpdateReplacePolicy attribute would then dictate whether AWS CloudFormation deleted, retained, or created a snapshot of the old DB instance. The update behavior for each property of a resource is specified in the reference topic for that resource in the AWS Resource and Property Types Reference. For more information on resource update behavior, see Update Behaviors of Stack Resources. The UpdateReplacePolicy attribute applies to stack updates you perform directly, as well as stack updates performed using change sets. Note Resources that are retained continue to exist and continue to incur applicable charges until you delete those resources. Snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots. UpdateReplacePolicy retains the old physical resource or snapshot, but removes it from AWS CloudFormation's scope. UpdateReplacePolicy differs from the DeletionPolicy attribute in that it only applies to resources replaced during stack updates. Use DeletionPolicy for resources deleted when a stack is deleted, or when the resource definition itself is deleted from the template as part of a stack update. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER DependsOn With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. .PARAMETER Metadata The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. This will be returned when describing the resource using AWS CLI. .PARAMETER UpdatePolicy Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. You must use the "Add-UpdatePolicy" function or the [UpdatePolicy] class here. .PARAMETER Condition Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. .FUNCTIONALITY Vaporshell #> [OutputType([WAFv2WebACLAssociation])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $ResourceArn, [parameter(Mandatory = $true)] [object] $WebACLArn, [parameter()] [DeletionPolicy] $DeletionPolicy, [parameter()] [UpdateReplacePolicy] $UpdateReplacePolicy, [parameter(Mandatory = $false)] [string[]] $DependsOn, [parameter(Mandatory = $false)] [VSJson] $Metadata, [parameter(Mandatory = $false)] [UpdatePolicy] $UpdatePolicy, [parameter(Mandatory = $false)] [string] $Condition ) Process { $obj = [WAFv2WebACLAssociation]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'New-VSWAFv2WebACLAssociation' |