< Back

Add-CfnElasticLoadBalancing_LoadBalancerResource

Sat Jan 11, 2020 6:57 am

NAME Add-CfnElasticLoadBalancing_LoadBalancerResource



SYNOPSIS

The AWS::ElasticLoadBalancing::LoadBalancer type creates a LoadBalancer.





SYNTAX

Add-CfnElasticLoadBalancing_LoadBalancerResource [-ResourceName] <String> [-AccessLoggingPolicy <IDictionary>]

[-AppCookieStickinessPolicy <IDictionary[]>] [-AvailabilityZones <String[]>] [-ConnectionDrainingPolicy

<IDictionary>] [-ConnectionSettings <IDictionary>] [-CrossZone <Boolean>] [-HealthCheck <IDictionary>] [-Instances

<String[]>] [-LBCookieStickinessPolicy <IDictionary[]>] [-Listeners <IDictionary[]>] [-LoadBalancerName <String>]

[-Policies <IDictionary[]>] [-Scheme <String>] [-SecurityGroups <String[]>] [-Subnets <String[]>] [-Tags

<IDictionary>] [-DeletionPolicy <String>] [-Metadata <Hashtable>] [-DependsOn <Array>] [[-PropertiesBlock]

<ScriptBlock>] [-Condition <Object>] [<CommonParameters>]





DESCRIPTION





PARAMETERS

-ResourceName <String>



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AccessLoggingPolicy <IDictionary>

Captures detailed information for all requests made to your load balancer, such as the time a request was

received, client??????s IP address, latencies, request path, and server responses.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AppCookieStickinessPolicy <IDictionary[]>

Generates one or more stickiness policies with sticky session lifetimes that follow that of an

application-generated cookie. These policies can be associated only with HTTP/HTTPS listeners.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AvailabilityZones <String[]>

The Availability Zones in which to create the load balancer. You can specify either AvailabilityZones or

Subnets, but not both.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ConnectionDrainingPolicy <IDictionary>

Whether deregistered or unhealthy instances can complete all in-flight requests.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ConnectionSettings <IDictionary>

Specifies how long front-end and back-end connections of your load balancer can remain idle.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CrossZone <Boolean>

Specifies whether cross-zone load balancing is enabled for the load balancer. With cross-zone load balancing,

your load balancer nodes route traffic to the back-end instances across all Availability Zones. By default the

CrossZone property is false.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-HealthCheck <IDictionary>

When specified, declares an application health check for the instances.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Instances <String[]>

Provides a list of EC2 instance IDs for the LoadBalancer.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-LBCookieStickinessPolicy <IDictionary[]>

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser

(user-agent), or by a specified expiration period. This policy can be associated only with HTTP/HTTPS

listeners.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Listeners <IDictionary[]>

One or more listeners for this load balancer. Each listener must be registered for a specific port, and you

can not have more than one listener for a given port.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-LoadBalancerName <String>

A name for the load balancer. If you don't specify a name, AWS CloudFormation generates a unique physical ID

and uses that ID for the load balancer. The name must be unique within your set of load balancers.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Policies <IDictionary[]>

A list of elastic load balancing policies to apply to this elastic load balancer.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Scheme <String>

For LoadBalancers attached to an Apazon VPC, this parameter can be used to specify the type of LoadBalancer to

use. Specify "internal" to create an internal LoadBalancer with a DNS name that resolves to private IP

addresses.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SecurityGroups <String[]>

Security groups assigned to your load balancer within your virtual private cloud (VPC).



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Subnets <String[]>

A list of subnet IDs in your virtual private cloud (VPC) to attach to your load balancer. You can specify

either AvailabilityZones or Subnets, but not both.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Tags <IDictionary>

The tags that you want to attach.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DeletionPolicy <String>

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Metadata <Hashtable>

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 format 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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DependsOn <Array>

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. You can use the DependsOn attribute with any resource.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PropertiesBlock <ScriptBlock>

Allows you to declare a block of one or more Property statements.



A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,

and specify Property assignments that may include CloudFormation function calls or references, or computed

values.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Condition <Object>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS

http://docs.aws.amazon.com/AWSCloudForm ... olicy.html

http://docs.aws.amazon.com/AWSCloudForm ... adata.html

http://docs.aws.amazon.com/AWSCloudForm ... ndson.html

http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html

http://docs.aws.amazon.com/search/doc-s ... lancing::L

oadBalancer