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 AWS Parallel Computing Service CreateCluster API operation.

Syntax

New-PCSCluster
-ClusterName <String>
-SlurmConfiguration_CgroupCustomSetting <CgroupCustomSetting[]>
-Accounting_DefaultPurgeTimeInDay <Int32>
-Accounting_Mode <AccountingMode>
-SlurmRest_Mode <SlurmRestMode>
-Networking_NetworkType <NetworkType>
-SlurmConfiguration_ScaleDownIdleTimeInSecond <Int32>
-Networking_SecurityGroupId <String[]>
-Size <Size>
-SlurmConfiguration_SlurmCustomSetting <SlurmCustomSetting[]>
-SlurmConfiguration_SlurmdbdCustomSetting <SlurmdbdCustomSetting[]>
-Networking_SubnetId <String[]>
-Tag <Hashtable>
-Scheduler_Type <SchedulerType>
-Scheduler_Version <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPCSConfig>

Description

Creates a cluster in your account. PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action. It takes time for PCS to create the cluster. The cluster is in a Creating state until it is ready to use. There can only be 1 cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account. CreateCluster fails with a ServiceQuotaExceededException if there is already a cluster in a Creating state.

Parameters

-Accounting_DefaultPurgeTimeInDay <Int32>
The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.The default value for defaultPurgeTimeInDays is -1.A value of -1 means there is no purge time and records persist as long as the cluster exists.0 isn't a valid value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSlurmConfiguration_Accounting_DefaultPurgeTimeInDays
-Accounting_Mode <AccountingMode>
The default value for mode is NONE. A value of STANDARD means Slurm accounting is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSlurmConfiguration_Accounting_Mode
-ClientConfig <AmazonPCSConfig>
Amazon.PowerShell.Cmdlets.PCS.AmazonPCSClientCmdlet.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. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterName <String>
A name to identify the cluster. Example: MyCluster
Required?True
Position?1
Accept pipeline input?True (ByValue, 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)
-Networking_NetworkType <NetworkType>
The IP address version the cluster uses. The default is IPV4.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Networking_SecurityGroupId <String[]>
A list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets. 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)
AliasesNetworking_SecurityGroupIds
-Networking_SubnetId <String[]>
The list of subnet IDs where PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and PCS resources. Subnet IDs have the form subnet-0123456789abcdef0.Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.PCS currently supports only 1 subnet in this list. 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)
AliasesNetworking_SubnetIds
-Scheduler_Type <SchedulerType>
The software PCS uses to manage cluster scaling and job scheduling.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Scheduler_Version <String>
The version of the specified scheduling software that PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in PCS in the PCS User Guide.Valid Values: 24.11 | 25.05
Required?True
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.PCS.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.PCS.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)
-Size <Size>
A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).
  • SMALL: 32 compute nodes and 256 jobs
  • MEDIUM: 512 compute nodes and 8192 jobs
  • LARGE: 2048 compute nodes and 16,384 jobs
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SlurmConfiguration_CgroupCustomSetting <CgroupCustomSetting[]>
Additional Cgroup-specific configuration that directly maps to Cgroup settings. 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)
AliasesSlurmConfiguration_CgroupCustomSettings
-SlurmConfiguration_ScaleDownIdleTimeInSecond <Int32>
The time (in seconds) before an idle node is scaled down.Default: 600
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSlurmConfiguration_ScaleDownIdleTimeInSeconds
-SlurmConfiguration_SlurmCustomSetting <SlurmCustomSetting[]>
Additional Slurm-specific configuration that directly maps to Slurm settings. 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)
AliasesSlurmConfiguration_SlurmCustomSettings
-SlurmConfiguration_SlurmdbdCustomSetting <SlurmdbdCustomSetting[]>
Additional SlurmDBD-specific configuration that directly maps to SlurmDBD settings. 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)
AliasesSlurmConfiguration_SlurmdbdCustomSettings
-SlurmRest_Mode <SlurmRestMode>
The default value for mode is NONE. A value of STANDARD means the Slurm REST API is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSlurmConfiguration_SlurmRest_Mode
-Tag <Hashtable>
1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string. 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.PCS.Model.Cluster or Amazon.PCS.Model.CreateClusterResponse
This cmdlet returns an Amazon.PCS.Model.Cluster object. The service call response (type Amazon.PCS.Model.CreateClusterResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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