AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Elastic Load Balancing V2 CreateLoadBalancer API operation.

Syntax

New-ELB2LoadBalancer
-CustomerOwnedIpv4Pool <String>
-IpAddressType <IpAddressType>
-Name <String>
-Scheme <LoadBalancerSchemeEnum>
-SecurityGroup <String[]>
-SubnetMapping <SubnetMapping[]>
-Subnet <String[]>
-Tag <Tag[]>
-Type <LoadBalancerTypeEnum>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonElasticLoadBalancingV2Config>

Description

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For more information, see the following: This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.

Parameters

Amazon.PowerShell.Cmdlets.ELB2.AmazonElasticLoadBalancingV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomerOwnedIpv4Pool <String>
[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IpAddressType <IpAddressType>
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
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-".
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
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.You cannot specify a scheme for a Gateway Load Balancer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroup <String[]>
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroups
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'LoadBalancers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticLoadBalancingV2.Model.CreateLoadBalancerResponse). Specifying the name of a property of type Amazon.ElasticLoadBalancingV2.Model.CreateLoadBalancerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Subnet <String[]>
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.[Application Load Balancers] You must specify subnets from at least two Availability Zones.[Application Load Balancers on Outposts] You must specify one Outpost subnet.[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.[Network Load Balancers] You can specify subnets from one or more Availability Zones.[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnets
-SubnetMapping <SubnetMapping[]>
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.[Application Load Balancers on Outposts] You must specify one Outpost subnet.[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.[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. For internet-facing load balancer, you can specify one IPv6 address per subnet.[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnetMappings
-Tag <Tag[]>
The tags to assign to the load balancer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
The type of load balancer. The default is application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a collection of Amazon.ElasticLoadBalancingV2.Model.LoadBalancer objects. The service call response (type Amazon.ElasticLoadBalancingV2.Model.CreateLoadBalancerResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

New-ELB2LoadBalancer -Type application -Scheme internet-facing -IpAddressType ipv4 -Name 'New-Test-ALB' -SecurityGroup 'sg-07c3414abb8811cbd' -subnet 'subnet-c37a67a6','subnet-fc02eea0'

AvailabilityZones : {us-east-1b, us-east-1a}
CanonicalHostedZoneId : Z35SXDOTRQ7X7K
CreatedTime : 12/28/19 2:58:03 PM
DNSName : New-Test-ALB-1391502222.us-east-1.elb.amazonaws.com
IpAddressType : ipv4
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/New-Test-ALB/dab2e4d90eb51493
LoadBalancerName : New-Test-ALB
Scheme : internet-facing
SecurityGroups : {sg-07c3414abb8811cbd}
State : Amazon.ElasticLoadBalancingV2.Model.LoadBalancerState
Type : application
VpcId : vpc-2cfd7000
This example creates new internet facing Application load balancer with two subnets.

Supported Version

AWS Tools for PowerShell: 2.x.y.z