AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . deadline ]

create-fleet

Description

Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.

See also: AWS API Documentation

Synopsis

  create-fleet
[--client-token <value>]
--configuration <value>
[--description <value>]
--display-name <value>
--farm-id <value>
--max-worker-count <value>
[--min-worker-count <value>]
--role-arn <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--client-token (string)

The unique token which the server uses to recognize retries of the same request.

--configuration (tagged union structure)

The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: customerManaged, serviceManagedEc2.

customerManaged -> (structure)

The customer managed fleets within a fleet configuration.

mode -> (string)

The Auto Scaling mode for the customer managed fleet configuration.

storageProfileId -> (string)

The storage profile ID.

workerCapabilities -> (structure)

The worker capabilities for a customer managed fleet configuration.

acceleratorCount -> (structure)

The range of the accelerator.

max -> (integer)

The maximum GPU for the accelerator.

min -> (integer)

The minimum GPU for the accelerator.

acceleratorTotalMemoryMiB -> (structure)

The total memory (MiB) for the customer managed worker capabilities.

max -> (integer)

The maximum amount of memory to use for the accelerator, measured in MiB.

min -> (integer)

The minimum amount of memory to use for the accelerator, measured in MiB.

acceleratorTypes -> (list)

The accelerator types for the customer managed worker capabilities.

(string)

cpuArchitectureType -> (string)

The CPU architecture type for the customer managed worker capabilities.

customAmounts -> (list)

Custom requirement ranges for customer managed worker capabilities.

(structure)

The fleet amount and attribute capabilities.

max -> (float)

The maximum amount of the fleet worker capability.

min -> (float)

The minimum amount of fleet worker capability.

name -> (string)

The name of the fleet capability.

customAttributes -> (list)

Custom attributes for the customer manged worker capabilities.

(structure)

Defines the fleet's capability name, minimum, and maximum.

name -> (string)

The name of the fleet attribute capability for the worker.

values -> (list)

The number of fleet attribute capabilities.

(string)

memoryMiB -> (structure)

The memory (MiB).

max -> (integer)

The maximum amount of memory (in MiB).

min -> (integer)

The minimum amount of memory (in MiB).

osFamily -> (string)

The operating system (OS) family.

vCpuCount -> (structure)

The vCPU count for the customer manged worker capabilities.

max -> (integer)

The maximum amount of vCPU.

min -> (integer)

The minimum amount of vCPU.

serviceManagedEc2 -> (structure)

The service managed Amazon EC2 instances for a fleet configuration.

instanceCapabilities -> (structure)

The Amazon EC2 instance capabilities.

allowedInstanceTypes -> (list)

The allowable Amazon EC2 instance types.

(string)

cpuArchitectureType -> (string)

The CPU architecture type.

customAmounts -> (list)

The custom capability amounts to require for instances in this fleet.

(structure)

The fleet amount and attribute capabilities.

max -> (float)

The maximum amount of the fleet worker capability.

min -> (float)

The minimum amount of fleet worker capability.

name -> (string)

The name of the fleet capability.

customAttributes -> (list)

The custom capability attributes to require for instances in this fleet.

(structure)

Defines the fleet's capability name, minimum, and maximum.

name -> (string)

The name of the fleet attribute capability for the worker.

values -> (list)

The number of fleet attribute capabilities.

(string)

excludedInstanceTypes -> (list)

The instance types to exclude from the fleet.

(string)

memoryMiB -> (structure)

The memory, as MiB, for the Amazon EC2 instance type.

max -> (integer)

The maximum amount of memory (in MiB).

min -> (integer)

The minimum amount of memory (in MiB).

osFamily -> (string)

The operating system (OS) family.

rootEbsVolume -> (structure)

The root EBS volume.

iops -> (integer)

The IOPS per volume.

sizeGiB -> (integer)

The EBS volume size in GiB.

throughputMiB -> (integer)

The throughput per volume in MiB.

vCpuCount -> (structure)

The amount of vCPU to require for instances in this fleet.

max -> (integer)

The maximum amount of vCPU.

min -> (integer)

The minimum amount of vCPU.

instanceMarketOptions -> (structure)

The Amazon EC2 market type.

type -> (string)

The Amazon EC2 instance type.

JSON Syntax:

{
  "customerManaged": {
    "mode": "NO_SCALING"|"EVENT_BASED_AUTO_SCALING",
    "storageProfileId": "string",
    "workerCapabilities": {
      "acceleratorCount": {
        "max": integer,
        "min": integer
      },
      "acceleratorTotalMemoryMiB": {
        "max": integer,
        "min": integer
      },
      "acceleratorTypes": ["gpu", ...],
      "cpuArchitectureType": "x86_64"|"arm64",
      "customAmounts": [
        {
          "max": float,
          "min": float,
          "name": "string"
        }
        ...
      ],
      "customAttributes": [
        {
          "name": "string",
          "values": ["string", ...]
        }
        ...
      ],
      "memoryMiB": {
        "max": integer,
        "min": integer
      },
      "osFamily": "WINDOWS"|"LINUX"|"MACOS",
      "vCpuCount": {
        "max": integer,
        "min": integer
      }
    }
  },
  "serviceManagedEc2": {
    "instanceCapabilities": {
      "allowedInstanceTypes": ["string", ...],
      "cpuArchitectureType": "x86_64"|"arm64",
      "customAmounts": [
        {
          "max": float,
          "min": float,
          "name": "string"
        }
        ...
      ],
      "customAttributes": [
        {
          "name": "string",
          "values": ["string", ...]
        }
        ...
      ],
      "excludedInstanceTypes": ["string", ...],
      "memoryMiB": {
        "max": integer,
        "min": integer
      },
      "osFamily": "WINDOWS"|"LINUX",
      "rootEbsVolume": {
        "iops": integer,
        "sizeGiB": integer,
        "throughputMiB": integer
      },
      "vCpuCount": {
        "max": integer,
        "min": integer
      }
    },
    "instanceMarketOptions": {
      "type": "on-demand"|"spot"
    }
  }
}

--description (string)

The description of the fleet.

--display-name (string)

The display name of the fleet.

--farm-id (string)

The farm ID of the farm to connect to the fleet.

--max-worker-count (integer)

The maximum number of workers for the fleet.

--min-worker-count (integer)

The minimum number of workers for the fleet.

--role-arn (string)

The IAM role ARN for the role that the fleet's workers will use.

--tags (map)

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

fleetId -> (string)

The fleet ID.