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 VPC Lattice CreateTargetGroup API operation.

Syntax

New-VPCLTargetGroup
-HealthCheck_Enabled <Boolean>
-HealthCheck_HealthCheckIntervalSecond <Int32>
-HealthCheck_HealthCheckTimeoutSecond <Int32>
-HealthCheck_HealthyThresholdCount <Int32>
-Matcher_HttpCode <String>
-Config_IpAddressType <IpAddressType>
-Config_LambdaEventStructureVersion <LambdaEventStructureVersion>
-Name <String>
-HealthCheck_Path <String>
-HealthCheck_Port <Int32>
-Config_Port <Int32>
-HealthCheck_Protocol <TargetGroupProtocol>
-Config_Protocol <TargetGroupProtocol>
-HealthCheck_ProtocolVersion <HealthCheckProtocolVersion>
-Config_ProtocolVersion <TargetGroupProtocolVersion>
-Tag <Hashtable>
-Type <TargetGroupType>
-HealthCheck_UnhealthyThresholdCount <Int32>
-Config_VpcIdentifier <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonVPCLatticeConfig>

Description

Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service. For more information, see Target groups in the Amazon VPC Lattice User Guide.

Parameters

-ClientConfig <AmazonVPCLatticeConfig>
Amazon.PowerShell.Cmdlets.VPCL.AmazonVPCLatticeClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Config_IpAddressType <IpAddressType>
The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Config_LambdaEventStructureVersion <LambdaEventStructureVersion>
The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Config_Port <Int32>
The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Config_Protocol <TargetGroupProtocol>
The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Config_ProtocolVersion <TargetGroupProtocolVersion>
The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Config_VpcIdentifier <String>
The ID of the VPC. Not supported if the target group type is LAMBDA.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-HealthCheck_Enabled <Boolean>
Indicates whether health checking is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfig_HealthCheck_Enabled
-HealthCheck_HealthCheckIntervalSecond <Int32>
The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfig_HealthCheck_HealthCheckIntervalSeconds
-HealthCheck_HealthCheckTimeoutSecond <Int32>
The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfig_HealthCheck_HealthCheckTimeoutSeconds
-HealthCheck_HealthyThresholdCount <Int32>
The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfig_HealthCheck_HealthyThresholdCount
-HealthCheck_Path <String>
The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfig_HealthCheck_Path
-HealthCheck_Port <Int32>
The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfig_HealthCheck_Port
-HealthCheck_Protocol <TargetGroupProtocol>
The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfig_HealthCheck_Protocol
-HealthCheck_ProtocolVersion <HealthCheckProtocolVersion>
The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfig_HealthCheck_ProtocolVersion
-HealthCheck_UnhealthyThresholdCount <Int32>
The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfig_HealthCheck_UnhealthyThresholdCount
-Matcher_HttpCode <String>
The HTTP code to use when checking for a successful response from a target.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfig_HealthCheck_Matcher_HttpCode
-Name <String>
The name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VPCLattice.Model.CreateTargetGroupResponse). Specifying the name of a property of type Amazon.VPCLattice.Model.CreateTargetGroupResponse 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)
-Tag <Hashtable>
The tags for the target group. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Type <TargetGroupType>
The type of target group.
Required?True
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

Amazon.VPCLattice.Model.CreateTargetGroupResponse
This cmdlet returns an Amazon.VPCLattice.Model.CreateTargetGroupResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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