DeadlineCloud / Client / create_fleet

create_fleet#

DeadlineCloud.Client.create_fleet(**kwargs)#

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.

Request Syntax

response = client.create_fleet(
    clientToken='string',
    configuration={
        'customerManaged': {
            'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING',
            'storageProfileId': 'string',
            'workerCapabilities': {
                'acceleratorCount': {
                    'max': 123,
                    'min': 123
                },
                'acceleratorTotalMemoryMiB': {
                    'max': 123,
                    'min': 123
                },
                'acceleratorTypes': [
                    'gpu',
                ],
                'cpuArchitectureType': 'x86_64'|'arm64',
                'customAmounts': [
                    {
                        'max': ...,
                        'min': ...,
                        'name': 'string'
                    },
                ],
                'customAttributes': [
                    {
                        'name': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ],
                'memoryMiB': {
                    'max': 123,
                    'min': 123
                },
                'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
                'vCpuCount': {
                    'max': 123,
                    'min': 123
                }
            }
        },
        'serviceManagedEc2': {
            'instanceCapabilities': {
                'allowedInstanceTypes': [
                    'string',
                ],
                'cpuArchitectureType': 'x86_64'|'arm64',
                'customAmounts': [
                    {
                        'max': ...,
                        'min': ...,
                        'name': 'string'
                    },
                ],
                'customAttributes': [
                    {
                        'name': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ],
                'excludedInstanceTypes': [
                    'string',
                ],
                'memoryMiB': {
                    'max': 123,
                    'min': 123
                },
                'osFamily': 'WINDOWS'|'LINUX',
                'rootEbsVolume': {
                    'iops': 123,
                    'sizeGiB': 123,
                    'throughputMiB': 123
                },
                'vCpuCount': {
                    'max': 123,
                    'min': 123
                }
            },
            'instanceMarketOptions': {
                'type': 'on-demand'|'spot'
            }
        }
    },
    description='string',
    displayName='string',
    farmId='string',
    maxWorkerCount=123,
    minWorkerCount=123,
    roleArn='string',
    tags={
        'string': 'string'
    }
)

Parameters:

clientToken (string) –
The unique token which the server uses to recognize retries of the same request.

This field is autopopulated if not provided.
configuration (dict) –
[REQUIRED]

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 (dict) –
  
  The customer managed fleets within a fleet configuration.
  - mode (string) – [REQUIRED]
    
    The Auto Scaling mode for the customer managed fleet configuration.
  - storageProfileId (string) –
    
    The storage profile ID.
  - workerCapabilities (dict) – [REQUIRED]
    
    The worker capabilities for a customer managed fleet configuration.
    - acceleratorCount (dict) –
      
      The range of the accelerator.
      - max (integer) –
        
        The maximum GPU for the accelerator.
      - min (integer) – [REQUIRED]
        
        The minimum GPU for the accelerator.
    - acceleratorTotalMemoryMiB (dict) –
      
      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) – [REQUIRED]
        
        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) – [REQUIRED]
      
      The CPU architecture type for the customer managed worker capabilities.
    - customAmounts (list) –
      
      Custom requirement ranges for customer managed worker capabilities.
      - (dict) –
        
        The fleet amount and attribute capabilities.
        
        max (float) –
        
        The maximum amount of the fleet worker capability.
        
        min (float) – [REQUIRED]
        
        The minimum amount of fleet worker capability.
        
        name (string) – [REQUIRED]
        
        The name of the fleet capability.
    - customAttributes (list) –
      
      Custom attributes for the customer manged worker capabilities.
      - (dict) –
        
        Defines the fleet’s capability name, minimum, and maximum.
        
        name (string) – [REQUIRED]
        
        The name of the fleet attribute capability for the worker.
        
        values (list) – [REQUIRED]
        
        The number of fleet attribute capabilities.
        
        (string) –
    - memoryMiB (dict) – [REQUIRED]
      
      The memory (MiB).
      - max (integer) –
        
        The maximum amount of memory (in MiB).
      - min (integer) – [REQUIRED]
        
        The minimum amount of memory (in MiB).
    - osFamily (string) – [REQUIRED]
      
      The operating system (OS) family.
    - vCpuCount (dict) – [REQUIRED]
      
      The vCPU count for the customer manged worker capabilities.
      - max (integer) –
        
        The maximum amount of vCPU.
      - min (integer) – [REQUIRED]
        
        The minimum amount of vCPU.
- serviceManagedEc2 (dict) –
  
  The service managed Amazon EC2 instances for a fleet configuration.
  - instanceCapabilities (dict) – [REQUIRED]
    
    The Amazon EC2 instance capabilities.
    - allowedInstanceTypes (list) –
      
      The allowable Amazon EC2 instance types.
      - (string) –
    - cpuArchitectureType (string) – [REQUIRED]
      
      The CPU architecture type.
    - customAmounts (list) –
      
      The custom capability amounts to require for instances in this fleet.
      - (dict) –
        
        The fleet amount and attribute capabilities.
        
        max (float) –
        
        The maximum amount of the fleet worker capability.
        
        min (float) – [REQUIRED]
        
        The minimum amount of fleet worker capability.
        
        name (string) – [REQUIRED]
        
        The name of the fleet capability.
    - customAttributes (list) –
      
      The custom capability attributes to require for instances in this fleet.
      - (dict) –
        
        Defines the fleet’s capability name, minimum, and maximum.
        
        name (string) – [REQUIRED]
        
        The name of the fleet attribute capability for the worker.
        
        values (list) – [REQUIRED]
        
        The number of fleet attribute capabilities.
        
        (string) –
    - excludedInstanceTypes (list) –
      
      The instance types to exclude from the fleet.
      - (string) –
    - memoryMiB (dict) – [REQUIRED]
      
      The memory, as MiB, for the Amazon EC2 instance type.
      - max (integer) –
        
        The maximum amount of memory (in MiB).
      - min (integer) – [REQUIRED]
        
        The minimum amount of memory (in MiB).
    - osFamily (string) – [REQUIRED]
      
      The operating system (OS) family.
    - rootEbsVolume (dict) –
      
      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 (dict) – [REQUIRED]
      
      The amount of vCPU to require for instances in this fleet.
      - max (integer) –
        
        The maximum amount of vCPU.
      - min (integer) – [REQUIRED]
        
        The minimum amount of vCPU.
  - instanceMarketOptions (dict) – [REQUIRED]
    
    The Amazon EC2 market type.
    - type (string) – [REQUIRED]
      
      The Amazon EC2 instance type.
description (string) – The description of the fleet.
displayName (string) –
[REQUIRED]

The display name of the fleet.
farmId (string) –
[REQUIRED]

The farm ID of the farm to connect to the fleet.
maxWorkerCount (integer) –
[REQUIRED]

The maximum number of workers for the fleet.
minWorkerCount (integer) – The minimum number of workers for the fleet.
roleArn (string) –
[REQUIRED]

The IAM role ARN for the role that the fleet’s workers will use.
tags (dict) –
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.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'fleetId': 'string'
}

Response Structure

(dict) –
- fleetId (string) –
  
  The fleet ID.

create_fleet#

Request Syntax

Note

Response Syntax

Response Structure

Exceptions