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 AWS Global Accelerator CreateEndpointGroup API operation.

Syntax

New-GACLEndpointGroup
-ListenerArn <String>
-EndpointConfiguration <EndpointConfiguration[]>
-EndpointGroupRegion <String>
-HealthCheckIntervalSecond <Int32>
-HealthCheckPath <String>
-HealthCheckPort <Int32>
-HealthCheckProtocol <HealthCheckProtocol>
-IdempotencyToken <String>
-ThresholdCount <Int32>
-TrafficDialPercentage <Single>
-Force <SwitchParameter>

Description

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.

Parameters

-EndpointConfiguration <EndpointConfiguration[]>
The list of endpoint objects.
Required?False
Position?Named
Accept pipeline input?False
AliasesEndpointConfigurations
-EndpointGroupRegion <String>
The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
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?False
-HealthCheckIntervalSecond <Int32>
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
Required?False
Position?Named
Accept pipeline input?False
AliasesHealthCheckIntervalSeconds
-HealthCheckPath <String>
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckPort <Int32>
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckProtocol <HealthCheckProtocol>
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
Required?False
Position?Named
Accept pipeline input?False
-IdempotencyToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
Required?False
Position?Named
Accept pipeline input?False
-ListenerArn <String>
The Amazon Resource Name (ARN) of the listener.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ThresholdCount <Int32>
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
Required?False
Position?Named
Accept pipeline input?False
-TrafficDialPercentage <Single>
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.The default value is 100.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the ListenerArn parameter.

Outputs

This cmdlet returns a Amazon.GlobalAccelerator.Model.EndpointGroup object. The service call response (type Amazon.GlobalAccelerator.Model.CreateEndpointGroupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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