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

Syntax

New-ECSCluster
-ClusterName <String>
-CapacityProvider <String[]>
-LogConfiguration_CloudWatchEncryptionEnabled <Boolean>
-LogConfiguration_CloudWatchLogGroupName <String>
-DefaultCapacityProviderStrategy <CapacityProviderStrategyItem[]>
-ExecuteCommandConfiguration_KmsKeyId <String>
-ExecuteCommandConfiguration_Logging <ExecuteCommandLogging>
-LogConfiguration_S3BucketName <String>
-LogConfiguration_S3EncryptionEnabled <Boolean>
-LogConfiguration_S3KeyPrefix <String>
-Setting <ClusterSetting[]>
-Tag <Tag[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action. When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Parameters

-CapacityProvider <String[]>
The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacityProviders
-ClusterName <String>
The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DefaultCapacityProviderStrategy <CapacityProviderStrategyItem[]>
The capacity provider strategy to set as the default for the cluster. When a default capacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecuteCommandConfiguration_KmsKeyId <String>
Specify an AWS 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
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>
Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
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>
Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
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
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.CreateClusterResponse). Specifying the name of a property of type Amazon.ECS.Model.CreateClusterResponse 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)
-Setting <ClusterSetting[]>
The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings
-Tag <Tag[]>
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.The following basic restrictions apply to tags:
  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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

This cmdlet returns an Amazon.ECS.Model.Cluster object. The service call response (type Amazon.ECS.Model.CreateClusterResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

New-ECSCluster -ClusterName "LAB-ECS-CL" -Setting @{Name="containerInsights"; Value="enabled"}

ActiveServicesCount : 0
Attachments : {}
AttachmentsStatus :
CapacityProviders : {}
ClusterArn : arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS-CL
ClusterName : LAB-ECS-CL
DefaultCapacityProviderStrategy : {}
PendingTasksCount : 0
RegisteredContainerInstancesCount : 0
RunningTasksCount : 0
Settings : {containerInsights}
Statistics : {}
Status : ACTIVE
Tags : {}
This cmdlet creates a new Amazon ECS cluster.

Supported Version

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