VaporShell.ElasticLoadBalancingV2.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-VSElasticLoadBalancingV2ListenerAction { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::Listener.Action resource property to the template. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.Action resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html .PARAMETER Order Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-order UpdateType: Mutable PrimitiveType: Integer .PARAMETER TargetGroupArn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-targetgrouparn UpdateType: Mutable PrimitiveType: String .PARAMETER FixedResponseConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-fixedresponseconfig UpdateType: Mutable Type: FixedResponseConfig .PARAMETER AuthenticateCognitoConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-authenticatecognitoconfig UpdateType: Mutable Type: AuthenticateCognitoConfig .PARAMETER Type Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-type UpdateType: Mutable PrimitiveType: String .PARAMETER RedirectConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-redirectconfig UpdateType: Mutable Type: RedirectConfig .PARAMETER ForwardConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-forwardconfig UpdateType: Mutable Type: ForwardConfig .PARAMETER AuthenticateOidcConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-authenticateoidcconfig UpdateType: Mutable Type: AuthenticateOidcConfig .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerAction])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Order, [parameter(Mandatory = $false)] [object] $TargetGroupArn, [parameter(Mandatory = $false)] $FixedResponseConfig, [parameter(Mandatory = $false)] $AuthenticateCognitoConfig, [parameter(Mandatory = $true)] [object] $Type, [parameter(Mandatory = $false)] $RedirectConfig, [parameter(Mandatory = $false)] $ForwardConfig, [parameter(Mandatory = $false)] $AuthenticateOidcConfig ) Process { $obj = [ElasticLoadBalancingV2ListenerAction]::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-VSElasticLoadBalancingV2ListenerAction' function Add-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig resource property to the template. Specifies information required when integrating with Amazon Cognito to authenticate users. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig resource property to the template. Specifies information required when integrating with Amazon Cognito to authenticate users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html .PARAMETER OnUnauthenticatedRequest The behavior if the user is not authenticated. The following are possible values: + deny - Return an HTTP 401 Unauthorized error. + allow - Allow the request to be forwarded to the target. + authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-onunauthenticatedrequest UpdateType: Mutable PrimitiveType: String .PARAMETER UserPoolClientId The ID of the Amazon Cognito user pool client. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolclientid UpdateType: Mutable PrimitiveType: String .PARAMETER UserPoolDomain The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpooldomain UpdateType: Mutable PrimitiveType: String .PARAMETER SessionTimeout The maximum duration of the authentication session, in seconds. The default is 604800 seconds 7 days. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessiontimeout UpdateType: Mutable PrimitiveType: String .PARAMETER Scope The set of user claims to be requested from the IdP. The default is openid. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-scope UpdateType: Mutable PrimitiveType: String .PARAMETER SessionCookieName The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessioncookiename UpdateType: Mutable PrimitiveType: String .PARAMETER UserPoolArn The Amazon Resource Name ARN of the Amazon Cognito user pool. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolarn UpdateType: Mutable PrimitiveType: String .PARAMETER AuthenticationRequestExtraParams The query parameters up to 10 to include in the redirect request to the authorization endpoint. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-authenticationrequestextraparams UpdateType: Mutable Type: Map PrimitiveItemType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerAuthenticateCognitoConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $OnUnauthenticatedRequest, [parameter(Mandatory = $true)] [object] $UserPoolClientId, [parameter(Mandatory = $true)] [object] $UserPoolDomain, [parameter(Mandatory = $false)] [object] $SessionTimeout, [parameter(Mandatory = $false)] [object] $Scope, [parameter(Mandatory = $false)] [object] $SessionCookieName, [parameter(Mandatory = $true)] [object] $UserPoolArn, [parameter(Mandatory = $false)] [IDictionary] $AuthenticationRequestExtraParams ) Process { $obj = [ElasticLoadBalancingV2ListenerAuthenticateCognitoConfig]::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-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig' function Add-VSElasticLoadBalancingV2ListenerAuthenticateOidcConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateOidcConfig resource property to the template. Specifies information required using an identity provide (IdP that is compliant with OpenID Connect (OIDC to authenticate users. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateOidcConfig resource property to the template. Specifies information required using an identity provide (IdP that is compliant with OpenID Connect (OIDC to authenticate users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html .PARAMETER OnUnauthenticatedRequest The behavior if the user is not authenticated. The following are possible values: + deny - Return an HTTP 401 Unauthorized error. + allow - Allow the request to be forwarded to the target. + authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-onunauthenticatedrequest UpdateType: Mutable PrimitiveType: String .PARAMETER TokenEndpoint The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-tokenendpoint UpdateType: Mutable PrimitiveType: String .PARAMETER SessionTimeout The maximum duration of the authentication session, in seconds. The default is 604800 seconds 7 days. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-sessiontimeout UpdateType: Mutable PrimitiveType: String .PARAMETER Scope The set of user claims to be requested from the IdP. The default is openid. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-scope UpdateType: Mutable PrimitiveType: String .PARAMETER Issuer The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-issuer UpdateType: Mutable PrimitiveType: String .PARAMETER ClientSecret The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-clientsecret UpdateType: Mutable PrimitiveType: String .PARAMETER UserInfoEndpoint The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-userinfoendpoint UpdateType: Mutable PrimitiveType: String .PARAMETER ClientId The OAuth 2.0 client identifier. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-clientid UpdateType: Mutable PrimitiveType: String .PARAMETER AuthorizationEndpoint The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authorizationendpoint UpdateType: Mutable PrimitiveType: String .PARAMETER SessionCookieName The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-sessioncookiename UpdateType: Mutable PrimitiveType: String .PARAMETER AuthenticationRequestExtraParams The query parameters up to 10 to include in the redirect request to the authorization endpoint. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authenticationrequestextraparams UpdateType: Mutable Type: Map PrimitiveItemType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerAuthenticateOidcConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $OnUnauthenticatedRequest, [parameter(Mandatory = $true)] [object] $TokenEndpoint, [parameter(Mandatory = $false)] [object] $SessionTimeout, [parameter(Mandatory = $false)] [object] $Scope, [parameter(Mandatory = $true)] [object] $Issuer, [parameter(Mandatory = $true)] [object] $ClientSecret, [parameter(Mandatory = $true)] [object] $UserInfoEndpoint, [parameter(Mandatory = $true)] [object] $ClientId, [parameter(Mandatory = $true)] [object] $AuthorizationEndpoint, [parameter(Mandatory = $false)] [object] $SessionCookieName, [parameter(Mandatory = $false)] [IDictionary] $AuthenticationRequestExtraParams ) Process { $obj = [ElasticLoadBalancingV2ListenerAuthenticateOidcConfig]::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-VSElasticLoadBalancingV2ListenerAuthenticateOidcConfig' function Add-VSElasticLoadBalancingV2ListenerCertificate { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::Listener.Certificate resource property to the template. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.Certificate resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificate.html .PARAMETER CertificateArn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificate.html#cfn-elasticloadbalancingv2-listener-certificate-certificatearn UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerCertificate])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $CertificateArn ) Process { $obj = [ElasticLoadBalancingV2ListenerCertificate]::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-VSElasticLoadBalancingV2ListenerCertificate' function Add-VSElasticLoadBalancingV2ListenerCertificateCertificate { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate resource property to the template. Specifies an SSL server certificate for the certificate list of a secure listener. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate resource property to the template. Specifies an SSL server certificate for the certificate list of a secure listener. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html .PARAMETER CertificateArn The Amazon Resource Name ARN of the certificate. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html#cfn-elasticloadbalancingv2-listener-certificates-certificatearn PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerCertificateCertificate])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $CertificateArn ) Process { $obj = [ElasticLoadBalancingV2ListenerCertificateCertificate]::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-VSElasticLoadBalancingV2ListenerCertificateCertificate' function Add-VSElasticLoadBalancingV2ListenerFixedResponseConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::Listener.FixedResponseConfig resource property to the template. Specifies information required when returning a custom HTTP response. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.FixedResponseConfig resource property to the template. Specifies information required when returning a custom HTTP response. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html .PARAMETER ContentType The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-contenttype UpdateType: Mutable PrimitiveType: String .PARAMETER StatusCode The HTTP response code 2XX, 4XX, or 5XX. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-statuscode UpdateType: Mutable PrimitiveType: String .PARAMETER MessageBody The message. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-messagebody UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerFixedResponseConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContentType, [parameter(Mandatory = $true)] [object] $StatusCode, [parameter(Mandatory = $false)] [object] $MessageBody ) Process { $obj = [ElasticLoadBalancingV2ListenerFixedResponseConfig]::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-VSElasticLoadBalancingV2ListenerFixedResponseConfig' function Add-VSElasticLoadBalancingV2ListenerForwardConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::Listener.ForwardConfig resource property to the template. Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.ForwardConfig resource property to the template. Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html .PARAMETER TargetGroupStickinessConfig Information about the target group stickiness for a rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html#cfn-elasticloadbalancingv2-listener-forwardconfig-targetgroupstickinessconfig UpdateType: Mutable Type: TargetGroupStickinessConfig .PARAMETER TargetGroups Information about how traffic will be distributed between multiple target groups in a forward rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html#cfn-elasticloadbalancingv2-listener-forwardconfig-targetgroups UpdateType: Mutable Type: List ItemType: TargetGroupTuple DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerForwardConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $TargetGroupStickinessConfig, [parameter(Mandatory = $false)] [object] $TargetGroups ) Process { $obj = [ElasticLoadBalancingV2ListenerForwardConfig]::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-VSElasticLoadBalancingV2ListenerForwardConfig' function Add-VSElasticLoadBalancingV2ListenerRedirectConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::Listener.RedirectConfig resource property to the template. Information about a redirect action. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.RedirectConfig resource property to the template. Information about a redirect action. A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values. You can reuse URI components using the following reserved keywords: + #{protocol} + #{host} + #{port} + #{path} (the leading "/" is removed + #{query} For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz". .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html .PARAMETER Path The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-path UpdateType: Mutable PrimitiveType: String .PARAMETER Query The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-query UpdateType: Mutable PrimitiveType: String .PARAMETER Port The port. You can specify a value from 1 to 65535 or #{port}. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-port UpdateType: Mutable PrimitiveType: String .PARAMETER Host The hostname. This component is not percent-encoded. The hostname can contain #{host}. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-host UpdateType: Mutable PrimitiveType: String .PARAMETER Protocol The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-protocol UpdateType: Mutable PrimitiveType: String .PARAMETER StatusCode The HTTP redirect code. The redirect is either permanent HTTP 301 or temporary HTTP 302. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-statuscode UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRedirectConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Path, [parameter(Mandatory = $false)] [object] $Query, [parameter(Mandatory = $false)] [object] $Port, [parameter(Mandatory = $false)] [object] $Host, [parameter(Mandatory = $false)] [object] $Protocol, [parameter(Mandatory = $true)] [object] $StatusCode ) Process { $obj = [ElasticLoadBalancingV2ListenerRedirectConfig]::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-VSElasticLoadBalancingV2ListenerRedirectConfig' function Add-VSElasticLoadBalancingV2ListenerRuleAction { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.Action resource property to the template. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.Action resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html .PARAMETER Order Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-order UpdateType: Mutable PrimitiveType: Integer .PARAMETER TargetGroupArn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-targetgrouparn UpdateType: Mutable PrimitiveType: String .PARAMETER FixedResponseConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-fixedresponseconfig UpdateType: Mutable Type: FixedResponseConfig .PARAMETER AuthenticateCognitoConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-authenticatecognitoconfig UpdateType: Mutable Type: AuthenticateCognitoConfig .PARAMETER Type Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-type UpdateType: Mutable PrimitiveType: String .PARAMETER RedirectConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-redirectconfig UpdateType: Mutable Type: RedirectConfig .PARAMETER ForwardConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-forwardconfig UpdateType: Mutable Type: ForwardConfig .PARAMETER AuthenticateOidcConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-authenticateoidcconfig UpdateType: Mutable Type: AuthenticateOidcConfig .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleAction])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Order, [parameter(Mandatory = $false)] [object] $TargetGroupArn, [parameter(Mandatory = $false)] $FixedResponseConfig, [parameter(Mandatory = $false)] $AuthenticateCognitoConfig, [parameter(Mandatory = $true)] [object] $Type, [parameter(Mandatory = $false)] $RedirectConfig, [parameter(Mandatory = $false)] $ForwardConfig, [parameter(Mandatory = $false)] $AuthenticateOidcConfig ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleAction]::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-VSElasticLoadBalancingV2ListenerRuleAction' function Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateCognitoConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateCognitoConfig resource property to the template. Specifies information required when integrating with Amazon Cognito to authenticate users. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateCognitoConfig resource property to the template. Specifies information required when integrating with Amazon Cognito to authenticate users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html .PARAMETER OnUnauthenticatedRequest The behavior if the user is not authenticated. The following are possible values: + deny - Return an HTTP 401 Unauthorized error. + allow - Allow the request to be forwarded to the target. + authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-onunauthenticatedrequest UpdateType: Mutable PrimitiveType: String .PARAMETER UserPoolClientId The ID of the Amazon Cognito user pool client. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpoolclientid UpdateType: Mutable PrimitiveType: String .PARAMETER UserPoolDomain The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpooldomain UpdateType: Mutable PrimitiveType: String .PARAMETER SessionTimeout The maximum duration of the authentication session, in seconds. The default is 604800 seconds 7 days. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-sessiontimeout UpdateType: Mutable PrimitiveType: Integer .PARAMETER Scope The set of user claims to be requested from the IdP. The default is openid. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-scope UpdateType: Mutable PrimitiveType: String .PARAMETER SessionCookieName The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-sessioncookiename UpdateType: Mutable PrimitiveType: String .PARAMETER UserPoolArn The Amazon Resource Name ARN of the Amazon Cognito user pool. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpoolarn UpdateType: Mutable PrimitiveType: String .PARAMETER AuthenticationRequestExtraParams The query parameters up to 10 to include in the redirect request to the authorization endpoint. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-authenticationrequestextraparams UpdateType: Mutable Type: Map PrimitiveItemType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleAuthenticateCognitoConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $OnUnauthenticatedRequest, [parameter(Mandatory = $true)] [object] $UserPoolClientId, [parameter(Mandatory = $true)] [object] $UserPoolDomain, [parameter(Mandatory = $false)] [object] $SessionTimeout, [parameter(Mandatory = $false)] [object] $Scope, [parameter(Mandatory = $false)] [object] $SessionCookieName, [parameter(Mandatory = $true)] [object] $UserPoolArn, [parameter(Mandatory = $false)] [IDictionary] $AuthenticationRequestExtraParams ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleAuthenticateCognitoConfig]::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-VSElasticLoadBalancingV2ListenerRuleAuthenticateCognitoConfig' function Add-VSElasticLoadBalancingV2ListenerRuleAuthenticateOidcConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateOidcConfig resource property to the template. Specifies information required using an identity provide (IdP that is compliant with OpenID Connect (OIDC to authenticate users. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateOidcConfig resource property to the template. Specifies information required using an identity provide (IdP that is compliant with OpenID Connect (OIDC to authenticate users. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html .PARAMETER OnUnauthenticatedRequest The behavior if the user is not authenticated. The following are possible values: + deny - Return an HTTP 401 Unauthorized error. + allow - Allow the request to be forwarded to the target. + authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-onunauthenticatedrequest UpdateType: Mutable PrimitiveType: String .PARAMETER TokenEndpoint The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-tokenendpoint UpdateType: Mutable PrimitiveType: String .PARAMETER SessionTimeout The maximum duration of the authentication session, in seconds. The default is 604800 seconds 7 days. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-sessiontimeout UpdateType: Mutable PrimitiveType: Integer .PARAMETER Scope The set of user claims to be requested from the IdP. The default is openid. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-scope UpdateType: Mutable PrimitiveType: String .PARAMETER Issuer The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-issuer UpdateType: Mutable PrimitiveType: String .PARAMETER ClientSecret The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-clientsecret UpdateType: Mutable PrimitiveType: String .PARAMETER UserInfoEndpoint The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-userinfoendpoint UpdateType: Mutable PrimitiveType: String .PARAMETER ClientId The OAuth 2.0 client identifier. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-clientid UpdateType: Mutable PrimitiveType: String .PARAMETER AuthorizationEndpoint The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-authorizationendpoint UpdateType: Mutable PrimitiveType: String .PARAMETER SessionCookieName The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-sessioncookiename UpdateType: Mutable PrimitiveType: String .PARAMETER UseExistingClientSecret *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-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-useexistingclientsecret UpdateType: Mutable PrimitiveType: Boolean .PARAMETER AuthenticationRequestExtraParams The query parameters up to 10 to include in the redirect request to the authorization endpoint. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-authenticationrequestextraparams UpdateType: Mutable Type: Map PrimitiveItemType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleAuthenticateOidcConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $OnUnauthenticatedRequest, [parameter(Mandatory = $true)] [object] $TokenEndpoint, [parameter(Mandatory = $false)] [object] $SessionTimeout, [parameter(Mandatory = $false)] [object] $Scope, [parameter(Mandatory = $true)] [object] $Issuer, [parameter(Mandatory = $true)] [object] $ClientSecret, [parameter(Mandatory = $true)] [object] $UserInfoEndpoint, [parameter(Mandatory = $true)] [object] $ClientId, [parameter(Mandatory = $true)] [object] $AuthorizationEndpoint, [parameter(Mandatory = $false)] [object] $SessionCookieName, [parameter(Mandatory = $false)] [object] $UseExistingClientSecret, [parameter(Mandatory = $false)] [IDictionary] $AuthenticationRequestExtraParams ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleAuthenticateOidcConfig]::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-VSElasticLoadBalancingV2ListenerRuleAuthenticateOidcConfig' function Add-VSElasticLoadBalancingV2ListenerRuleFixedResponseConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.FixedResponseConfig resource property to the template. Specifies information required when returning a custom HTTP response. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.FixedResponseConfig resource property to the template. Specifies information required when returning a custom HTTP response. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html .PARAMETER ContentType The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-contenttype UpdateType: Mutable PrimitiveType: String .PARAMETER StatusCode The HTTP response code 2XX, 4XX, or 5XX. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-statuscode UpdateType: Mutable PrimitiveType: String .PARAMETER MessageBody The message. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-messagebody UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleFixedResponseConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContentType, [parameter(Mandatory = $true)] [object] $StatusCode, [parameter(Mandatory = $false)] [object] $MessageBody ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleFixedResponseConfig]::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-VSElasticLoadBalancingV2ListenerRuleFixedResponseConfig' function Add-VSElasticLoadBalancingV2ListenerRuleForwardConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.ForwardConfig resource property to the template. Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.ForwardConfig resource property to the template. Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-forwardconfig.html .PARAMETER TargetGroupStickinessConfig Information about the target group stickiness for a rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-forwardconfig.html#cfn-elasticloadbalancingv2-listenerrule-forwardconfig-targetgroupstickinessconfig UpdateType: Mutable Type: TargetGroupStickinessConfig .PARAMETER TargetGroups Information about how traffic will be distributed between multiple target groups in a forward rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-forwardconfig.html#cfn-elasticloadbalancingv2-listenerrule-forwardconfig-targetgroups UpdateType: Mutable Type: List ItemType: TargetGroupTuple DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleForwardConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $TargetGroupStickinessConfig, [parameter(Mandatory = $false)] [object] $TargetGroups ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleForwardConfig]::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-VSElasticLoadBalancingV2ListenerRuleForwardConfig' function Add-VSElasticLoadBalancingV2ListenerRuleHostHeaderConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HostHeaderConfig resource property to the template. Information about a host header condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HostHeaderConfig resource property to the template. Information about a host header condition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-hostheaderconfig.html .PARAMETER Values One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * matches 0 or more characters and ? matches exactly 1 character. If you specify multiple strings, the condition is satisfied if one of the strings matches the host name. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-hostheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-hostheaderconfig-values UpdateType: Mutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleHostHeaderConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Values ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleHostHeaderConfig]::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-VSElasticLoadBalancingV2ListenerRuleHostHeaderConfig' function Add-VSElasticLoadBalancingV2ListenerRuleHttpHeaderConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HttpHeaderConfig resource property to the template. Information about an HTTP header condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HttpHeaderConfig resource property to the template. Information about an HTTP header condition. There is a set of standard HTTP header fields. You can also define custom HTTP header fields. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html .PARAMETER Values One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * matches 0 or more characters and ? matches exactly 1 character. If the same header appears multiple times in the request, we search them in order until a match is found. If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-httpheaderconfig-values UpdateType: Mutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .PARAMETER HttpHeaderName The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-httpheaderconfig-httpheadername UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleHttpHeaderConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Values, [parameter(Mandatory = $false)] [object] $HttpHeaderName ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleHttpHeaderConfig]::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-VSElasticLoadBalancingV2ListenerRuleHttpHeaderConfig' function Add-VSElasticLoadBalancingV2ListenerRuleHttpRequestMethodConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HttpRequestMethodConfig resource property to the template. Information about an HTTP method condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.HttpRequestMethodConfig resource property to the template. Information about an HTTP method condition. HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the HTTP Method Registry: https://www.iana.org/assignments/http-methods/http-methods.xhtml. You can also define custom HTTP methods. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httprequestmethodconfig.html .PARAMETER Values The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen -, and underscore _. The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match. If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httprequestmethodconfig.html#cfn-elasticloadbalancingv2-listenerrule-httprequestmethodconfig-values UpdateType: Mutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleHttpRequestMethodConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Values ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleHttpRequestMethodConfig]::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-VSElasticLoadBalancingV2ListenerRuleHttpRequestMethodConfig' function Add-VSElasticLoadBalancingV2ListenerRulePathPatternConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.PathPatternConfig resource property to the template. Information about a path pattern condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.PathPatternConfig resource property to the template. Information about a path pattern condition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-pathpatternconfig.html .PARAMETER Values One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * matches 0 or more characters and ? matches exactly 1 character. If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-pathpatternconfig.html#cfn-elasticloadbalancingv2-listenerrule-pathpatternconfig-values UpdateType: Mutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRulePathPatternConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Values ) Process { $obj = [ElasticLoadBalancingV2ListenerRulePathPatternConfig]::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-VSElasticLoadBalancingV2ListenerRulePathPatternConfig' function Add-VSElasticLoadBalancingV2ListenerRuleQueryStringConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringConfig resource property to the template. Information about a query string condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringConfig resource property to the template. Information about a query string condition. The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringconfig.html .PARAMETER Values One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * matches 0 or more characters and ? matches exactly 1 character. To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '' character. If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringconfig.html#cfn-elasticloadbalancingv2-listenerrule-querystringconfig-values UpdateType: Mutable Type: List ItemType: QueryStringKeyValue DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleQueryStringConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Values ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleQueryStringConfig]::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-VSElasticLoadBalancingV2ListenerRuleQueryStringConfig' function Add-VSElasticLoadBalancingV2ListenerRuleQueryStringKeyValue { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue resource property to the template. Information about a key/value pair. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue resource property to the template. Information about a key/value pair. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html .PARAMETER Value The value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html#cfn-elasticloadbalancingv2-listenerrule-querystringkeyvalue-value UpdateType: Mutable PrimitiveType: String .PARAMETER Key The key. You can omit the key. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html#cfn-elasticloadbalancingv2-listenerrule-querystringkeyvalue-key UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleQueryStringKeyValue])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Value, [parameter(Mandatory = $false)] [object] $Key ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleQueryStringKeyValue]::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-VSElasticLoadBalancingV2ListenerRuleQueryStringKeyValue' function Add-VSElasticLoadBalancingV2ListenerRuleRedirectConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.RedirectConfig resource property to the template. Information about a redirect action. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.RedirectConfig resource property to the template. Information about a redirect action. A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values. You can reuse URI components using the following reserved keywords: + #{protocol} + #{host} + #{port} + #{path} (the leading "/" is removed + #{query} For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz". .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html .PARAMETER Path The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-path UpdateType: Mutable PrimitiveType: String .PARAMETER Query The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-query UpdateType: Mutable PrimitiveType: String .PARAMETER Port The port. You can specify a value from 1 to 65535 or #{port}. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-port UpdateType: Mutable PrimitiveType: String .PARAMETER Host The hostname. This component is not percent-encoded. The hostname can contain #{host}. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-host UpdateType: Mutable PrimitiveType: String .PARAMETER Protocol The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-protocol UpdateType: Mutable PrimitiveType: String .PARAMETER StatusCode The HTTP redirect code. The redirect is either permanent HTTP 301 or temporary HTTP 302. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-statuscode UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleRedirectConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Path, [parameter(Mandatory = $false)] [object] $Query, [parameter(Mandatory = $false)] [object] $Port, [parameter(Mandatory = $false)] [object] $Host, [parameter(Mandatory = $false)] [object] $Protocol, [parameter(Mandatory = $true)] [object] $StatusCode ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleRedirectConfig]::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-VSElasticLoadBalancingV2ListenerRuleRedirectConfig' function Add-VSElasticLoadBalancingV2ListenerRuleRuleCondition { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.RuleCondition resource property to the template. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.RuleCondition resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html .PARAMETER Field Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-field UpdateType: Mutable PrimitiveType: String .PARAMETER Values Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-values UpdateType: Mutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .PARAMETER HttpRequestMethodConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-httprequestmethodconfig UpdateType: Mutable Type: HttpRequestMethodConfig .PARAMETER PathPatternConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-pathpatternconfig UpdateType: Mutable Type: PathPatternConfig .PARAMETER HttpHeaderConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-httpheaderconfig UpdateType: Mutable Type: HttpHeaderConfig .PARAMETER SourceIpConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-sourceipconfig UpdateType: Mutable Type: SourceIpConfig .PARAMETER HostHeaderConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-hostheaderconfig UpdateType: Mutable Type: HostHeaderConfig .PARAMETER QueryStringConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-querystringconfig UpdateType: Mutable Type: QueryStringConfig .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleRuleCondition])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Field, [parameter(Mandatory = $false)] $Values, [parameter(Mandatory = $false)] $HttpRequestMethodConfig, [parameter(Mandatory = $false)] $PathPatternConfig, [parameter(Mandatory = $false)] $HttpHeaderConfig, [parameter(Mandatory = $false)] $SourceIpConfig, [parameter(Mandatory = $false)] $HostHeaderConfig, [parameter(Mandatory = $false)] $QueryStringConfig ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleRuleCondition]::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-VSElasticLoadBalancingV2ListenerRuleRuleCondition' function Add-VSElasticLoadBalancingV2ListenerRuleSourceIpConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.SourceIpConfig resource property to the template. Information about a source IP condition. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.SourceIpConfig resource property to the template. Information about a source IP condition. You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-sourceipconfig.html .PARAMETER Values One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-sourceipconfig.html#cfn-elasticloadbalancingv2-listenerrule-sourceipconfig-values UpdateType: Mutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleSourceIpConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Values ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleSourceIpConfig]::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-VSElasticLoadBalancingV2ListenerRuleSourceIpConfig' function Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupStickinessConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupStickinessConfig resource property to the template. Information about the target group stickiness for a rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupStickinessConfig resource property to the template. Information about the target group stickiness for a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig.html .PARAMETER Enabled Indicates whether target group stickiness is enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig-enabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER DurationSeconds The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds 7 days. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig-durationseconds UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleTargetGroupStickinessConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Enabled, [parameter(Mandatory = $false)] [object] $DurationSeconds ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleTargetGroupStickinessConfig]::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-VSElasticLoadBalancingV2ListenerRuleTargetGroupStickinessConfig' function Add-VSElasticLoadBalancingV2ListenerRuleTargetGroupTuple { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupTuple resource property to the template. Information about how traffic will be distributed between multiple target groups in a forward rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupTuple resource property to the template. Information about how traffic will be distributed between multiple target groups in a forward rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgrouptuple.html .PARAMETER TargetGroupArn The Amazon Resource Name ARN of the target group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgrouptuple.html#cfn-elasticloadbalancingv2-listenerrule-targetgrouptuple-targetgrouparn UpdateType: Mutable PrimitiveType: String .PARAMETER Weight The weight. The range is 0 to 999. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgrouptuple.html#cfn-elasticloadbalancingv2-listenerrule-targetgrouptuple-weight UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerRuleTargetGroupTuple])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $TargetGroupArn, [parameter(Mandatory = $false)] [object] $Weight ) Process { $obj = [ElasticLoadBalancingV2ListenerRuleTargetGroupTuple]::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-VSElasticLoadBalancingV2ListenerRuleTargetGroupTuple' function Add-VSElasticLoadBalancingV2ListenerTargetGroupStickinessConfig { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::Listener.TargetGroupStickinessConfig resource property to the template. Information about the target group stickiness for a rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.TargetGroupStickinessConfig resource property to the template. Information about the target group stickiness for a rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html .PARAMETER Enabled Indicates whether target group stickiness is enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listener-targetgroupstickinessconfig-enabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER DurationSeconds The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds 7 days. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listener-targetgroupstickinessconfig-durationseconds UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerTargetGroupStickinessConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Enabled, [parameter(Mandatory = $false)] [object] $DurationSeconds ) Process { $obj = [ElasticLoadBalancingV2ListenerTargetGroupStickinessConfig]::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-VSElasticLoadBalancingV2ListenerTargetGroupStickinessConfig' function Add-VSElasticLoadBalancingV2ListenerTargetGroupTuple { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::Listener.TargetGroupTuple resource property to the template. Information about how traffic will be distributed between multiple target groups in a forward rule. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener.TargetGroupTuple resource property to the template. Information about how traffic will be distributed between multiple target groups in a forward rule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html .PARAMETER TargetGroupArn The Amazon Resource Name ARN of the target group. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html#cfn-elasticloadbalancingv2-listener-targetgrouptuple-targetgrouparn UpdateType: Mutable PrimitiveType: String .PARAMETER Weight The weight. The range is 0 to 999. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html#cfn-elasticloadbalancingv2-listener-targetgrouptuple-weight UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2ListenerTargetGroupTuple])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $TargetGroupArn, [parameter(Mandatory = $false)] [object] $Weight ) Process { $obj = [ElasticLoadBalancingV2ListenerTargetGroupTuple]::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-VSElasticLoadBalancingV2ListenerTargetGroupTuple' function Add-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttribute resource property to the template. Specifies an attribute for an Application Load Balancer or a Network Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttribute resource property to the template. Specifies an attribute for an Application Load Balancer or a Network Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html .PARAMETER Key The name of the attribute. The following attributes are supported by both Application Load Balancers and Network Load Balancers: + access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false. + access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs. + deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false. The following attributes are supported by only Application Load Balancers: + idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer true or routed to targets false. The default is false. + routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. The following attributes are supported by only Network Load Balancers: + load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The value is true or false. The default is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value The value of the attribute. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes-value PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Key, [parameter(Mandatory = $false)] [object] $Value ) Process { $obj = [ElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute]::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-VSElasticLoadBalancingV2LoadBalancerLoadBalancerAttribute' function Add-VSElasticLoadBalancingV2LoadBalancerSubnetMapping { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMapping resource property to the template. Specifies a subnet to attach to an Application Load Balancer or a Network Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMapping resource property to the template. Specifies a subnet to attach to an Application Load Balancer or a Network Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html .PARAMETER AllocationId Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-allocationid PrimitiveType: String UpdateType: Mutable .PARAMETER IPv6Address *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-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-ipv6address PrimitiveType: String UpdateType: Mutable .PARAMETER PrivateIPv4Address *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-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-privateipv4address PrimitiveType: String UpdateType: Mutable .PARAMETER SubnetId The ID of the subnet. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-subnetid PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2LoadBalancerSubnetMapping])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $AllocationId, [parameter(Mandatory = $false)] [object] $IPv6Address, [parameter(Mandatory = $false)] [object] $PrivateIPv4Address, [parameter(Mandatory = $true)] [object] $SubnetId ) Process { $obj = [ElasticLoadBalancingV2LoadBalancerSubnetMapping]::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-VSElasticLoadBalancingV2LoadBalancerSubnetMapping' function Add-VSElasticLoadBalancingV2TargetGroupMatcher { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::TargetGroup.Matcher resource property to the template. Specifies the HTTP codes that healthy targets must use when responding to an HTTP health check. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::TargetGroup.Matcher resource property to the template. Specifies the HTTP codes that healthy targets must use when responding to an HTTP health check. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html .PARAMETER HttpCode The HTTP codes. For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values for example, "200,202" or a range of values for example, "200-299". For Network Load Balancers, this is 200–399. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html#cfn-elasticloadbalancingv2-targetgroup-matcher-httpcode PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2TargetGroupMatcher])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $HttpCode ) Process { $obj = [ElasticLoadBalancingV2TargetGroupMatcher]::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-VSElasticLoadBalancingV2TargetGroupMatcher' function Add-VSElasticLoadBalancingV2TargetGroupTargetDescription { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::TargetGroup.TargetDescription resource property to the template. Specifies a target to add to a target group. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::TargetGroup.TargetDescription resource property to the template. Specifies a target to add to a target group. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html .PARAMETER AvailabilityZone An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. This parameter is not supported if the target type of the target group is instance. If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required. With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all. If the target type is lambda, this parameter is optional and the only supported value is all. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-availabilityzone PrimitiveType: String UpdateType: Mutable .PARAMETER Id The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-id PrimitiveType: String UpdateType: Mutable .PARAMETER Port The port on which the target is listening. Not used if the target is a Lambda function. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-port PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2TargetGroupTargetDescription])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $AvailabilityZone, [parameter(Mandatory = $true)] [object] $Id, [parameter(Mandatory = $false)] [object] $Port ) Process { $obj = [ElasticLoadBalancingV2TargetGroupTargetDescription]::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-VSElasticLoadBalancingV2TargetGroupTargetDescription' function Add-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttribute resource property to the template. Specifies a target group attribute. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttribute resource property to the template. Specifies a target group attribute. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html .PARAMETER Key The name of the attribute. The following attributes are supported by both Application Load Balancers and Network Load Balancers: + deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported. + stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false. + stickiness.type - The type of sticky sessions. The possible values are lb_cookie for Application Load Balancers or source_ip for Network Load Balancers. The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: + load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin or least_outstanding_requests. The default is round_robin. + slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds 15 minutes. Slow start mode is disabled by default. + stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week 604800 seconds. The default value is 1 day 86400 seconds. The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: + lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client. The following attribute is supported only by Network Load Balancers: + proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattribute-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value The value of the attribute. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattribute-value PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticLoadBalancingV2TargetGroupTargetGroupAttribute])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Key, [parameter(Mandatory = $false)] [object] $Value ) Process { $obj = [ElasticLoadBalancingV2TargetGroupTargetGroupAttribute]::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-VSElasticLoadBalancingV2TargetGroupTargetGroupAttribute' function New-VSElasticLoadBalancingV2Listener { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::Listener resource to the template. Specifies a listener for an Application Load Balancer or Network Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::Listener resource to the template. Specifies a listener for an Application Load Balancer or Network Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.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 SslPolicy HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. The following are the possible values: + ELBSecurityPolicy-2016-08 + ELBSecurityPolicy-TLS-1-0-2015-04 + ELBSecurityPolicy-TLS-1-1-2017-01 + ELBSecurityPolicy-TLS-1-2-2017-01 + ELBSecurityPolicy-TLS-1-2-Ext-2018-06 + ELBSecurityPolicy-FS-2018-06 + ELBSecurityPolicy-FS-1-1-2019-08 + ELBSecurityPolicy-FS-1-2-2019-08 + ELBSecurityPolicy-FS-1-2-Res-2019-08 For more information, see Security Policies: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies in the *Application Load Balancers Guide* and Security Policies: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies in the *Network Load Balancers Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-sslpolicy UpdateType: Mutable PrimitiveType: String .PARAMETER LoadBalancerArn The Amazon Resource Name ARN of the load balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-loadbalancerarn UpdateType: Immutable PrimitiveType: String .PARAMETER DefaultActions The actions for the default rule. You cannot define a condition for a default rule. To create additional rules for an Application Load Balancer, use AWS::ElasticLoadBalancingV2::ListenerRule: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-defaultactions UpdateType: Mutable Type: List ItemType: Action DuplicatesAllowed: False .PARAMETER Port The port on which the load balancer is listening. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-port UpdateType: Mutable PrimitiveType: Integer .PARAMETER Certificates The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. To create a certificate list for a secure listener, use AWS::ElasticLoadBalancingV2::ListenerCertificate: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-certificates UpdateType: Mutable Type: List ItemType: Certificate DuplicatesAllowed: False .PARAMETER Protocol The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-protocol UpdateType: Mutable PrimitiveType: String .PARAMETER AlpnPolicy + Listeners: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-listeners.html in the *User Guide for Network Load Balancers* Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-alpnpolicy UpdateType: Mutable Type: List PrimitiveItemType: 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([ElasticLoadBalancingV2Listener])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [object] $SslPolicy, [parameter(Mandatory = $true)] [object] $LoadBalancerArn, [parameter(Mandatory = $true)] [object] $DefaultActions, [parameter(Mandatory = $false)] [object] $Port, [parameter(Mandatory = $false)] [object] $Certificates, [parameter(Mandatory = $false)] [object] $Protocol, [parameter(Mandatory = $false)] $AlpnPolicy, [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 = [ElasticLoadBalancingV2Listener]::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-VSElasticLoadBalancingV2Listener' function New-VSElasticLoadBalancingV2ListenerCertificate { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate resource to the template. Specifies an SSL server certificate to add to the certificate list for an HTTPS or TLS listener. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerCertificate resource to the template. Specifies an SSL server certificate to add to the certificate list for an HTTPS or TLS listener. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.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 Certificates The certificate. You can specify one certificate per resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html#cfn-elasticloadbalancingv2-listenercertificate-certificates DuplicatesAllowed: False ItemType: Certificate Type: List UpdateType: Immutable .PARAMETER ListenerArn The Amazon Resource Name ARN of the listener. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html#cfn-elasticloadbalancingv2-listenercertificate-listenerarn PrimitiveType: String UpdateType: Immutable .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([ElasticLoadBalancingV2ListenerCertificate])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $Certificates, [parameter(Mandatory = $true)] [object] $ListenerArn, [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 = [ElasticLoadBalancingV2ListenerCertificate]::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-VSElasticLoadBalancingV2ListenerCertificate' function New-VSElasticLoadBalancingV2ListenerRule { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::ListenerRule resource to the template. Specifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::ListenerRule resource to the template. Specifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.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 ListenerArn The Amazon Resource Name ARN of the listener. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-listenerarn UpdateType: Immutable PrimitiveType: String .PARAMETER Actions The actions. The rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-actions UpdateType: Mutable Type: List ItemType: Action DuplicatesAllowed: False .PARAMETER Priority The rule priority. A listener can't have multiple rules with the same priority. If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-priority UpdateType: Mutable PrimitiveType: Integer .PARAMETER Conditions The conditions. The rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. A rule can also optionally include one or more of each of the following conditions: http-header and query-string. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-conditions UpdateType: Mutable Type: List ItemType: RuleCondition DuplicatesAllowed: False .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([ElasticLoadBalancingV2ListenerRule])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $ListenerArn, [parameter(Mandatory = $true)] [object] $Actions, [parameter(Mandatory = $true)] [object] $Priority, [parameter(Mandatory = $true)] [object] $Conditions, [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 = [ElasticLoadBalancingV2ListenerRule]::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-VSElasticLoadBalancingV2ListenerRule' function New-VSElasticLoadBalancingV2LoadBalancer { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::LoadBalancer resource to the template. Specifies an Application Load Balancer or a Network Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::LoadBalancer resource to the template. Specifies an Application Load Balancer or a Network Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.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 IpAddressType The IP address type. The possible values are ipv4 for IPv4 addresses and dualstack for IPv4 and IPv6 addresses. Internal load balancers must use ipv4. Network Load Balancers must use ipv4. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-ipaddresstype PrimitiveType: String UpdateType: Mutable .PARAMETER LoadBalancerAttributes The load balancer attributes. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes DuplicatesAllowed: False ItemType: LoadBalancerAttribute Type: List UpdateType: Mutable .PARAMETER Name The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-". If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-name PrimitiveType: String UpdateType: Immutable .PARAMETER Scheme The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-scheme PrimitiveType: String UpdateType: Immutable .PARAMETER SecurityGroups Application Load Balancers] The IDs of the security groups for the load balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-securitygroups DuplicatesAllowed: False PrimitiveItemType: String Type: List UpdateType: Mutable .PARAMETER SubnetMappings The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmappings DuplicatesAllowed: False ItemType: SubnetMapping Type: List UpdateType: Mutable .PARAMETER Subnets The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. Application Load Balancers] You must specify subnets from at least two Availability Zones. When you specify subnets for an existing Application Load Balancer, they replace the previously enabled subnets. Network Load Balancers] You can specify subnets from one or more Availability Zones when you create the load balancer. You can't change the subnets for an existing Network Load Balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnets DuplicatesAllowed: False PrimitiveItemType: String Type: List UpdateType: Mutable .PARAMETER Tags One or more tags to assign to the load balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-tags DuplicatesAllowed: True ItemType: Tag Type: List UpdateType: Mutable .PARAMETER Type The type of load balancer. The default is application. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-type PrimitiveType: String UpdateType: Immutable .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([ElasticLoadBalancingV2LoadBalancer])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [object] $IpAddressType, [parameter(Mandatory = $false)] [object] $LoadBalancerAttributes, [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $false)] [object] $Scheme, [parameter(Mandatory = $false)] $SecurityGroups, [parameter(Mandatory = $false)] [object] $SubnetMappings, [parameter(Mandatory = $false)] $Subnets, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter(Mandatory = $false)] [object] $Type, [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 = [ElasticLoadBalancingV2LoadBalancer]::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-VSElasticLoadBalancingV2LoadBalancer' function New-VSElasticLoadBalancingV2TargetGroup { <# .SYNOPSIS Adds an AWS::ElasticLoadBalancingV2::TargetGroup resource to the template. Specifies a target group for an Application Load Balancer or Network Load Balancer. .DESCRIPTION Adds an AWS::ElasticLoadBalancingV2::TargetGroup resource to the template. Specifies a target group for an Application Load Balancer or Network Load Balancer. Before you register a Lambda function as a target, you must create a AWS::Lambda::Permission resource that grants the Elastic Load Balancing service principal permission to invoke the Lambda function. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.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 HealthCheckEnabled Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance or ip, health checks are always enabled and cannot be disabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER HealthCheckIntervalSeconds The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckintervalseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER HealthCheckPath HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckpath PrimitiveType: String UpdateType: Mutable .PARAMETER HealthCheckPort The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckport PrimitiveType: String UpdateType: Mutable .PARAMETER HealthCheckProtocol The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckprotocol PrimitiveType: String UpdateType: Mutable .PARAMETER HealthCheckTimeoutSeconds The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthchecktimeoutseconds PrimitiveType: Integer UpdateType: Mutable .PARAMETER HealthyThresholdCount The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or TLS, the default is 3. If the target type is lambda, the default is 5. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthythresholdcount PrimitiveType: Integer UpdateType: Mutable .PARAMETER Matcher HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-matcher Type: Matcher UpdateType: Mutable .PARAMETER Name The name of the target group. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-name PrimitiveType: String UpdateType: Immutable .PARAMETER Port The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-port PrimitiveType: Integer UpdateType: Immutable .PARAMETER Protocol The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocol PrimitiveType: String UpdateType: Immutable .PARAMETER Tags The tags. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-tags DuplicatesAllowed: True ItemType: Tag Type: List UpdateType: Mutable .PARAMETER TargetGroupAttributes The attributes. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattributes DuplicatesAllowed: False ItemType: TargetGroupAttribute Type: List UpdateType: Mutable .PARAMETER TargetType The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. + instance - Targets are specified by instance ID. This is the default value. If the target group protocol is UDP or TCP_UDP, the target type must be instance. + ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud VPC for the target group, the RFC 1918 range 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16, and the RFC 6598 range 100.64.0.0/10. You can't specify publicly routable IP addresses. + lambda - The target groups contains a single Lambda function. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targettype PrimitiveType: String UpdateType: Immutable .PARAMETER Targets The targets. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targets DuplicatesAllowed: False ItemType: TargetDescription Type: List UpdateType: Mutable .PARAMETER UnhealthyThresholdCount The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is lambda, the default is 2. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-unhealthythresholdcount PrimitiveType: Integer UpdateType: Mutable .PARAMETER VpcId The identifier of the virtual private cloud VPC. If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-vpcid PrimitiveType: String UpdateType: Immutable .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([ElasticLoadBalancingV2TargetGroup])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [object] $HealthCheckEnabled, [parameter(Mandatory = $false)] [object] $HealthCheckIntervalSeconds, [parameter(Mandatory = $false)] [object] $HealthCheckPath, [parameter(Mandatory = $false)] [object] $HealthCheckPort, [parameter(Mandatory = $false)] [object] $HealthCheckProtocol, [parameter(Mandatory = $false)] [object] $HealthCheckTimeoutSeconds, [parameter(Mandatory = $false)] [object] $HealthyThresholdCount, [parameter(Mandatory = $false)] $Matcher, [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $false)] [object] $Port, [parameter(Mandatory = $false)] [object] $Protocol, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter(Mandatory = $false)] [object] $TargetGroupAttributes, [parameter(Mandatory = $false)] [object] $TargetType, [parameter(Mandatory = $false)] [object] $Targets, [parameter(Mandatory = $false)] [object] $UnhealthyThresholdCount, [parameter(Mandatory = $false)] [object] $VpcId, [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 = [ElasticLoadBalancingV2TargetGroup]::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-VSElasticLoadBalancingV2TargetGroup' |