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 UpdateExpressGatewayService API operation.

Syntax

Update-ECSExpressGatewayService
-ServiceArn <String>
-ScalingTarget_AutoScalingMetric <ExpressGatewayServiceScalingMetric>
-ScalingTarget_AutoScalingTargetValue <Int32>
-PrimaryContainer_Command <String[]>
-PrimaryContainer_ContainerPort <Int32>
-Cpu <String>
-RepositoryCredentials_CredentialsParameter <String>
-PrimaryContainer_Environment <KeyValuePair[]>
-ExecutionRoleArn <String>
-HealthCheckPath <String>
-PrimaryContainer_Image <String>
-AwsLogsConfiguration_LogGroup <String>
-AwsLogsConfiguration_LogStreamPrefix <String>
-ScalingTarget_MaxTaskCount <Int32>
-Memory <String>
-ScalingTarget_MinTaskCount <Int32>
-PrimaryContainer_Secret <Secret[]>
-NetworkConfiguration_SecurityGroup <String[]>
-NetworkConfiguration_Subnet <String[]>
-TaskDefinitionArn <String>
-TaskRoleArn <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonECSConfig>

Description

Updates an existing Express service configuration. Modifies container settings, resource allocation, auto-scaling configuration, and other service parameters without recreating the service. Amazon ECS creates a new service revision with updated configuration and performs a rolling deployment to replace existing tasks. The service remains available during updates, ensuring zero-downtime deployments. Some parameters like the infrastructure role cannot be modified after service creation and require creating a new service.

Parameters

-AwsLogsConfiguration_LogGroup <String>
The name of the CloudWatch Logs log group to send container logs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPrimaryContainer_AwsLogsConfiguration_LogGroup
-AwsLogsConfiguration_LogStreamPrefix <String>
The prefix for the CloudWatch Logs log stream names. The default for an Express service is ecs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPrimaryContainer_AwsLogsConfiguration_LogStreamPrefix
-ClientConfig <AmazonECSConfig>
Amazon.PowerShell.Cmdlets.ECS.AmazonECSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Cpu <String>
The number of CPU units used by the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionRoleArn <String>
The Amazon Resource Name (ARN) of the task execution role for the Express service.
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)
-HealthCheckPath <String>
The path on the container for Application Load Balancer health checks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Memory <String>
The amount of memory (in MiB) used by the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkConfiguration_SecurityGroup <String[]>
The IDs of the security groups associated with the Express service. 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)
AliasesNetworkConfiguration_SecurityGroups
-NetworkConfiguration_Subnet <String[]>
The IDs of the subnets associated with the Express service. 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)
AliasesNetworkConfiguration_Subnets
-PrimaryContainer_Command <String[]>
The command that is passed to the container. 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)
-PrimaryContainer_ContainerPort <Int32>
The port number on the container that receives traffic from the load balancer. Default is 80.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PrimaryContainer_Environment <KeyValuePair[]>
The environment variables to pass to the container. 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)
-PrimaryContainer_Image <String>
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest.For Express services, the image typically contains a web application that listens on the specified container port. The image can be stored in Amazon ECR, Docker Hub, or any other container registry accessible to your execution role.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PrimaryContainer_Secret <Secret[]>
The secrets to pass to the container. 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)
AliasesPrimaryContainer_Secrets
-RepositoryCredentials_CredentialsParameter <String>
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPrimaryContainer_RepositoryCredentials_CredentialsParameter
-ScalingTarget_AutoScalingMetric <ExpressGatewayServiceScalingMetric>
The metric used for auto-scaling decisions. The default metric used for an Express service is CPUUtilization.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingTarget_AutoScalingTargetValue <Int32>
The target value for the auto-scaling metric. The default value for an Express service is 60.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingTarget_MaxTaskCount <Int32>
The maximum number of tasks to run in the Express service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingTarget_MinTaskCount <Int32>
The minimum number of tasks to run in the Express service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Service'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECS.Model.UpdateExpressGatewayServiceResponse). Specifying the name of a property of type Amazon.ECS.Model.UpdateExpressGatewayServiceResponse 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)
-ServiceArn <String>
The Amazon Resource Name (ARN) of the Express service to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-TaskDefinitionArn <String>
The Amazon Resource Name (ARN) of a task definition to use to update the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers.The task definition must have a container named Main with a single TCP port mapping that includes a container port and port name. The task definition must also have FARGATE compatibility.If you provide a task definition ARN, you cannot also specify primaryContainer, executionRoleArn, taskRoleArn, cpu, or memory.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TaskRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role for containers in this task.
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

Amazon.ECS.Model.UpdatedExpressGatewayService or Amazon.ECS.Model.UpdateExpressGatewayServiceResponse
This cmdlet returns an Amazon.ECS.Model.UpdatedExpressGatewayService object. The service call response (type Amazon.ECS.Model.UpdateExpressGatewayServiceResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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