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 AWSDeadlineCloud UpdateFleet API operation.

Syntax

Update-ADCFleet
-WorkerCapabilities_AcceleratorType <String[]>
-InstanceCapabilities_AllowedInstanceType <String[]>
-WorkerCapabilities_CpuArchitectureType <CpuArchitectureType>
-InstanceCapabilities_CpuArchitectureType <CpuArchitectureType>
-WorkerCapabilities_CustomAmount <FleetAmountCapability[]>
-InstanceCapabilities_CustomAmount <FleetAmountCapability[]>
-WorkerCapabilities_CustomAttribute <FleetAttributeCapability[]>
-InstanceCapabilities_CustomAttribute <FleetAttributeCapability[]>
-Description <String>
-DisplayName <String>
-InstanceCapabilities_ExcludedInstanceType <String[]>
-FarmId <String>
-FleetId <String>
-RootEbsVolume_Iops <Int32>
-AcceleratorCount_Max <Int32>
-AcceleratorTotalMemoryMiB_Max <Int32>
-Configuration_CustomerManaged_WorkerCapabilities_MemoryMiB_Max <Int32>
-Configuration_CustomerManaged_WorkerCapabilities_VCpuCount_Max <Int32>
-Count_Max <Int32>
-Configuration_ServiceManagedEc2_InstanceCapabilities_MemoryMiB_Max <Int32>
-Configuration_ServiceManagedEc2_InstanceCapabilities_VCpuCount_Max <Int32>
-MaxWorkerCount <Int32>
-AcceleratorCount_Min <Int32>
-AcceleratorTotalMemoryMiB_Min <Int32>
-Configuration_CustomerManaged_WorkerCapabilities_MemoryMiB_Min <Int32>
-Configuration_CustomerManaged_WorkerCapabilities_VCpuCount_Min <Int32>
-Count_Min <Int32>
-Configuration_ServiceManagedEc2_InstanceCapabilities_MemoryMiB_Min <Int32>
-Configuration_ServiceManagedEc2_InstanceCapabilities_VCpuCount_Min <Int32>
-MinWorkerCount <Int32>
-CustomerManaged_Mode <AutoScalingMode>
-WorkerCapabilities_OsFamily <CustomerManagedFleetOperatingSystemFamily>
-InstanceCapabilities_OsFamily <ServiceManagedFleetOperatingSystemFamily>
-VpcConfiguration_ResourceConfigurationArn <String[]>
-RoleArn <String>
-HostConfiguration_ScriptBody <String>
-HostConfiguration_ScriptTimeoutSecond <Int32>
-AcceleratorCapabilities_Selection <AcceleratorSelection[]>
-RootEbsVolume_SizeGiB <Int32>
-CustomerManaged_StorageProfileId <String>
-ServiceManagedEc2_StorageProfileId <String>
-CustomerManaged_TagPropagationMode <TagPropagationMode>
-RootEbsVolume_ThroughputMiB <Int32>
-InstanceMarketOptions_Type <Ec2MarketType>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonDeadlineConfig>

Description

Updates a fleet.

Parameters

-AcceleratorCapabilities_Selection <AcceleratorSelection[]>
A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed. 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_ServiceManagedEc2_InstanceCapabilities_AcceleratorCapabilities_Selections
-AcceleratorCount_Max <Int32>
The maximum number of GPU accelerators in the worker host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerManaged_WorkerCapabilities_AcceleratorCount_Max
-AcceleratorCount_Min <Int32>
The minimum number of GPU accelerators in the worker host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerManaged_WorkerCapabilities_AcceleratorCount_Min
-AcceleratorTotalMemoryMiB_Max <Int32>
The maximum amount of memory to use for the accelerator, measured in MiB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerManaged_WorkerCapabilities_AcceleratorTotalMemoryMiB_Max
-AcceleratorTotalMemoryMiB_Min <Int32>
The minimum amount of memory to use for the accelerator, measured in MiB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerManaged_WorkerCapabilities_AcceleratorTotalMemoryMiB_Min
-ClientConfig <AmazonDeadlineConfig>
Amazon.PowerShell.Cmdlets.ADC.AmazonDeadlineClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
The unique token which the server uses to recognize retries of the same request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_CustomerManaged_WorkerCapabilities_MemoryMiB_Max <Int32>
The maximum amount of memory (in MiB).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkerCapabilities_MemoryMiB_Max
-Configuration_CustomerManaged_WorkerCapabilities_MemoryMiB_Min <Int32>
The minimum amount of memory (in MiB).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkerCapabilities_MemoryMiB_Min
-Configuration_CustomerManaged_WorkerCapabilities_VCpuCount_Max <Int32>
The maximum amount of vCPU.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkerCapabilities_VCpuCount_Max
-Configuration_CustomerManaged_WorkerCapabilities_VCpuCount_Min <Int32>
The minimum amount of vCPU.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkerCapabilities_VCpuCount_Min
-Configuration_ServiceManagedEc2_InstanceCapabilities_MemoryMiB_Max <Int32>
The maximum amount of memory (in MiB).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceCapabilities_MemoryMiB_Max
-Configuration_ServiceManagedEc2_InstanceCapabilities_MemoryMiB_Min <Int32>
The minimum amount of memory (in MiB).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceCapabilities_MemoryMiB_Min
-Configuration_ServiceManagedEc2_InstanceCapabilities_VCpuCount_Max <Int32>
The maximum amount of vCPU.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceCapabilities_VCpuCount_Max
-Configuration_ServiceManagedEc2_InstanceCapabilities_VCpuCount_Min <Int32>
The minimum amount of vCPU.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceCapabilities_VCpuCount_Min
-Count_Max <Int32>
The maximum number of GPU accelerators in the worker host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ServiceManagedEc2_InstanceCapabilities_AcceleratorCapabilities_Count_Max
-Count_Min <Int32>
The minimum number of GPU accelerators in the worker host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ServiceManagedEc2_InstanceCapabilities_AcceleratorCapabilities_Count_Min
-CustomerManaged_Mode <AutoScalingMode>
The Auto Scaling mode for the customer managed fleet configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerManaged_Mode
-CustomerManaged_StorageProfileId <String>
The storage profile ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerManaged_StorageProfileId
-CustomerManaged_TagPropagationMode <TagPropagationMode>
Specifies whether tags associated with a fleet are attached to workers when the worker is launched. When the tagPropagationMode is set to PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers do not change.If you don't specify tagPropagationMode, the default is NO_PROPAGATION.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerManaged_TagPropagationMode
-Description <String>
The description of the fleet to update.This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisplayName <String>
The display name of the fleet to update.This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FarmId <String>
The farm ID to update.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FleetId <String>
The fleet ID to update.
Required?True
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)
-HostConfiguration_ScriptBody <String>
The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide. The script runs as an administrative user (sudo root on Linux, as an Administrator on Windows).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HostConfiguration_ScriptTimeoutSecond <Int32>
The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.The default is 300 seconds (5 minutes).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHostConfiguration_ScriptTimeoutSeconds
-InstanceCapabilities_AllowedInstanceType <String[]>
The allowable Amazon EC2 instance types. 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_ServiceManagedEc2_InstanceCapabilities_AllowedInstanceTypes
-InstanceCapabilities_CpuArchitectureType <CpuArchitectureType>
The CPU architecture type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ServiceManagedEc2_InstanceCapabilities_CpuArchitectureType
-InstanceCapabilities_CustomAmount <FleetAmountCapability[]>
The custom capability amounts to require for instances in this fleet. 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_ServiceManagedEc2_InstanceCapabilities_CustomAmounts
-InstanceCapabilities_CustomAttribute <FleetAttributeCapability[]>
The custom capability attributes to require for instances in this fleet. 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_ServiceManagedEc2_InstanceCapabilities_CustomAttributes
-InstanceCapabilities_ExcludedInstanceType <String[]>
The instance types to exclude from the fleet. 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_ServiceManagedEc2_InstanceCapabilities_ExcludedInstanceTypes
-InstanceCapabilities_OsFamily <ServiceManagedFleetOperatingSystemFamily>
The operating system (OS) family.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ServiceManagedEc2_InstanceCapabilities_OsFamily
-InstanceMarketOptions_Type <Ec2MarketType>
The Amazon EC2 instance type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ServiceManagedEc2_InstanceMarketOptions_Type
-MaxWorkerCount <Int32>
The maximum number of workers in the fleet.Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MinWorkerCount <Int32>
The minimum number of workers in the fleet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The IAM role ARN that the fleet's workers assume while running jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RootEbsVolume_Iops <Int32>
The IOPS per volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ServiceManagedEc2_InstanceCapabilities_RootEbsVolume_Iops
-RootEbsVolume_SizeGiB <Int32>
The EBS volume size in GiB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ServiceManagedEc2_InstanceCapabilities_RootEbsVolume_SizeGiB
-RootEbsVolume_ThroughputMiB <Int32>
The throughput per volume in MiB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ServiceManagedEc2_InstanceCapabilities_RootEbsVolume_ThroughputMiB
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Deadline.Model.UpdateFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceManagedEc2_StorageProfileId <String>
The storage profile ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ServiceManagedEc2_StorageProfileId
-VpcConfiguration_ResourceConfigurationArn <String[]>
The ARNs of the VPC Lattice resource configurations attached to the fleet. 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_ServiceManagedEc2_VpcConfiguration_ResourceConfigurationArns
-WorkerCapabilities_AcceleratorType <String[]>
The accelerator types for the customer managed worker capabilities. 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_CustomerManaged_WorkerCapabilities_AcceleratorTypes
-WorkerCapabilities_CpuArchitectureType <CpuArchitectureType>
The CPU architecture type for the customer managed worker capabilities.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerManaged_WorkerCapabilities_CpuArchitectureType
-WorkerCapabilities_CustomAmount <FleetAmountCapability[]>
Custom requirement ranges for customer managed worker capabilities. 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_CustomerManaged_WorkerCapabilities_CustomAmounts
-WorkerCapabilities_CustomAttribute <FleetAttributeCapability[]>
Custom attributes for the customer manged worker capabilities. 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_CustomerManaged_WorkerCapabilities_CustomAttributes
-WorkerCapabilities_OsFamily <CustomerManagedFleetOperatingSystemFamily>
The operating system (OS) family.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerManaged_WorkerCapabilities_OsFamily

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

None or Amazon.Deadline.Model.UpdateFleetResponse
This cmdlet does not generate any output.The service response (type Amazon.Deadline.Model.UpdateFleetResponse) be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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