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 Amazon EC2 Container Service CreateGateway API operation.

Syntax

New-ECSGateway
-Configuration_HostSharedAlb_AccessLogs_Destination_S3_Bucket <String>
-DeletionProtection <Boolean>
-Configuration_HostSharedAlb_HttpDesync <GatewayAlbDesyncMitigationMode>
-Configuration_HostSharedAlb_NetworkConfiguration_InboundSecurityGroup <String>
-InfrastructureRoleArn <String>
-Configuration_HostSharedAlb_NetworkConfiguration_IpAddressType <GatewayElbIpAddressType>
-Configuration_HostSharedAlb_MaxAlbCount <Int32>
-Configuration_HostSharedAlb_TestTrafficRules_Header_Name <String>
-Name <String>
-Configuration_HostSharedAlb_Port <Int32>
-Configuration_HostSharedAlb_AccessLogs_Destination_S3_Prefix <String>
-PropagateTag <PropagateGatewayTags>
-Configuration_HostSharedAlb_Protocol <GatewayAlbProtocol>
-Configuration_HostSharedAlb_Scheme <GatewayElbScheme>
-Configuration_HostSharedAlb_NetworkConfiguration_Subnet <String[]>
-Tag <Tag[]>
-Configuration_HostSharedAlb_TestTrafficRules_Header_Value <String[]>
-Configuration_HostSharedAlb_WebACLArn <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonECSConfig>

Description

Creates a gateway. A gateway defines and dynamically manages ingress paths for your Amazon ECS services, handling traffic routing and infrastructure across multiple services while optimizing infrastructure usage. CreateGateway is a synchronous operation and the gateway is returned with a status of ACTIVE. The load balancers and other infrastructure that a gateway manages aren't created until a service in an associated cluster begins using the gateway. To use this operation, you must have the iam:PassRole permission for the infrastructure role that you specify in infrastructureRoleArn.

Parameters

-ClientConfig <AmazonECSConfig>
Amazon.PowerShell.Cmdlets.ECS.AmazonECSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_AccessLogs_Destination_S3_Bucket <String>
The name of the Amazon S3 bucket where access logs are delivered.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_AccessLogs_Destination_S3_Prefix <String>
The object key prefix for the access logs in the Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_HttpDesync <GatewayAlbDesyncMitigationMode>
The desync mitigation mode for the load balancers that the gateway manages, which determines how the load balancers handle requests that might pose a security risk. The default is defensive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_MaxAlbCount <Int32>
The maximum number of Application Load Balancers that the gateway manages. The default is 10.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_NetworkConfiguration_InboundSecurityGroup <String>
The ID of a security group that you provide to control inbound traffic to the load balancers that the gateway manages. When you specify a security group, the gateway doesn't create inbound rules on the security group it manages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_NetworkConfiguration_IpAddressType <GatewayElbIpAddressType>
The IP address type for the load balancers that the gateway manages. The default is dualstack.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_NetworkConfiguration_Subnet <String[]>
The subnets for the load balancers that the gateway manages. The default is the subnets in the default VPC. 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)
AliasesConfiguration_HostSharedAlb_NetworkConfiguration_Subnets
-Configuration_HostSharedAlb_Port <Int32>
The port that the load balancer listener uses is 443. The gateway supports only HTTPS at port 443.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_Protocol <GatewayAlbProtocol>
The protocol for the load balancer listener is HTTPS. No other protocol is supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_Scheme <GatewayElbScheme>
Specifies whether the load balancers the gateway manages are internet-facing or internal. The default is internet-facing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_TestTrafficRules_Header_Name <String>
The name of the header to match for test traffic routing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_HostSharedAlb_TestTrafficRules_Header_Value <String[]>
The header values to match for test traffic routing. 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)
AliasesConfiguration_HostSharedAlb_TestTrafficRules_Header_Values
-Configuration_HostSharedAlb_WebACLArn <String>
The Amazon Resource Name (ARN) of the WAF web ACL to associate with the load balancers that the gateway manages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtection <Boolean>
Specifies whether to enable deletion protection for the gateway. When enabled, the gateway can't be deleted, and the gateway propagates this setting to the load balancers it manages. The default is true.
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)
-InfrastructureRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that the gateway assumes to create and manage infrastructure on your behalf.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name for the gateway. The name must be unique within your account and can be up to 255 characters.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PropagateTag <PropagateGatewayTags>
Specifies whether to propagate the tags from the gateway to the infrastructure that the gateway manages. The default is GATEWAY.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPropagateTags
-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.ECS.Model.CreateGatewayResponse). Specifying the name of a property of type Amazon.ECS.Model.CreateGatewayResponse 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 <Tag[]>
The metadata that you apply to the gateway to help you categorize and organize it. Each tag consists of a key and an optional value. Depending on propagateTags, these tags can be applied to the infrastructure the gateway manages. 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

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.ECS.Model.CreateGatewayResponse
This cmdlet returns an Amazon.ECS.Model.CreateGatewayResponse object containing multiple properties.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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