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

Syntax

Update-ECSCluster
-Cluster <String>
-LogConfiguration_CloudWatchEncryptionEnabled <Boolean>
-LogConfiguration_CloudWatchLogGroupName <String>
-ManagedStorageConfiguration_FargateEphemeralStorageKmsKeyId <String>
-ExecuteCommandConfiguration_KmsKeyId <String>
-ManagedStorageConfiguration_KmsKeyId <String>
-ExecuteCommandConfiguration_Logging <ExecuteCommandLogging>
-ServiceConnectDefaults_Namespace <String>
-LogConfiguration_S3BucketName <String>
-LogConfiguration_S3EncryptionEnabled <Boolean>
-LogConfiguration_S3KeyPrefix <String>
-Setting <ClusterSetting[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonECSConfig>

Description

Updates the cluster.

Parameters

-ClientConfig <AmazonECSConfig>
Amazon.PowerShell.Cmdlets.ECS.AmazonECSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Cluster <String>
The name of the cluster to modify the settings for.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ExecuteCommandConfiguration_KmsKeyId <String>
Specify an Key Management Service key ID to encrypt the data between the local client and the container.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ExecuteCommandConfiguration_KmsKeyId
-ExecuteCommandConfiguration_Logging <ExecuteCommandLogging>
The log setting to use for redirecting logs for your execute command results. The following log settings are available.
  • NONE: The execute command session is not logged.
  • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
  • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ExecuteCommandConfiguration_Logging
-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)
-LogConfiguration_CloudWatchEncryptionEnabled <Boolean>
Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ExecuteCommandConfiguration_LogConfiguration_CloudWatchEncryptionEnabled
-LogConfiguration_CloudWatchLogGroupName <String>
The name of the CloudWatch log group to send logs to.The CloudWatch log group must already be created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ExecuteCommandConfiguration_LogConfiguration_CloudWatchLogGroupName
-LogConfiguration_S3BucketName <String>
The name of the S3 bucket to send logs to.The S3 bucket must already be created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ExecuteCommandConfiguration_LogConfiguration_S3BucketName
-LogConfiguration_S3EncryptionEnabled <Boolean>
Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ExecuteCommandConfiguration_LogConfiguration_S3EncryptionEnabled
-LogConfiguration_S3KeyPrefix <String>
An optional folder in the S3 bucket to place logs in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ExecuteCommandConfiguration_LogConfiguration_S3KeyPrefix
-ManagedStorageConfiguration_FargateEphemeralStorageKmsKeyId <String>
Specify the Key Management Service key ID for Fargate ephemeral storage.When you specify a fargateEphemeralStorageKmsKeyId, Amazon Web Services Fargate uses the key to encrypt data at rest in ephemeral storage. For more information about Fargate ephemeral storage encryption, see Customer managed keys for Amazon Web Services Fargate ephemeral storage for Amazon ECS in the Amazon Elastic Container Service Developer Guide.The key must be a single Region key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ManagedStorageConfiguration_FargateEphemeralStorageKmsKeyId
-ManagedStorageConfiguration_KmsKeyId <String>
Specify a Key Management Service key ID to encrypt Amazon ECS managed storage. When you specify a kmsKeyId, Amazon ECS uses the key to encrypt data volumes managed by Amazon ECS that are attached to tasks in the cluster. The following data volumes are managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes attached to Amazon ECS tasks, see Encrypt data stored in Amazon EBS volumes for Amazon ECS in the Amazon Elastic Container Service Developer Guide.The key must be a single Region key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ManagedStorageConfiguration_KmsKeyId
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECS.Model.UpdateClusterResponse). Specifying the name of a property of type Amazon.ECS.Model.UpdateClusterResponse 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)
-ServiceConnectDefaults_Namespace <String>
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include greater than (>), less than (<), double quotation marks ("), or slash (/).If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.If you update the cluster with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Setting <ClusterSetting[]>
The cluster settings for your cluster. 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)
AliasesSettings

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.Cluster or Amazon.ECS.Model.UpdateClusterResponse
This cmdlet returns an Amazon.ECS.Model.Cluster object. The service call response (type Amazon.ECS.Model.UpdateClusterResponse) 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