CfnFleet

class aws_cdk.aws_deadline.CfnFleet(scope, id, *, configuration, display_name, max_worker_count, role_arn, description=None, farm_id=None, min_worker_count=None)

Bases: CfnResource

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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html

CloudformationResource:

AWS::Deadline::Fleet

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

cfn_fleet = deadline.CfnFleet(self, "MyCfnFleet",
    configuration=deadline.CfnFleet.FleetConfigurationProperty(
        customer_managed=deadline.CfnFleet.CustomerManagedFleetConfigurationProperty(
            mode="mode",
            worker_capabilities=deadline.CfnFleet.CustomerManagedWorkerCapabilitiesProperty(
                cpu_architecture_type="cpuArchitectureType",
                memory_mi_b=deadline.CfnFleet.MemoryMiBRangeProperty(
                    min=123,

                    # the properties below are optional
                    max=123
                ),
                os_family="osFamily",
                v_cpu_count=deadline.CfnFleet.VCpuCountRangeProperty(
                    min=123,

                    # the properties below are optional
                    max=123
                ),

                # the properties below are optional
                accelerator_count=deadline.CfnFleet.AcceleratorCountRangeProperty(
                    min=123,

                    # the properties below are optional
                    max=123
                ),
                accelerator_total_memory_mi_b=deadline.CfnFleet.AcceleratorTotalMemoryMiBRangeProperty(
                    min=123,

                    # the properties below are optional
                    max=123
                ),
                accelerator_types=["acceleratorTypes"],
                custom_amounts=[deadline.CfnFleet.FleetAmountCapabilityProperty(
                    min=123,
                    name="name",

                    # the properties below are optional
                    max=123
                )],
                custom_attributes=[deadline.CfnFleet.FleetAttributeCapabilityProperty(
                    name="name",
                    values=["values"]
                )]
            ),

            # the properties below are optional
            storage_profile_id="storageProfileId"
        ),
        service_managed_ec2=deadline.CfnFleet.ServiceManagedEc2FleetConfigurationProperty(
            instance_capabilities=deadline.CfnFleet.ServiceManagedEc2InstanceCapabilitiesProperty(
                cpu_architecture_type="cpuArchitectureType",
                memory_mi_b=deadline.CfnFleet.MemoryMiBRangeProperty(
                    min=123,

                    # the properties below are optional
                    max=123
                ),
                os_family="osFamily",
                v_cpu_count=deadline.CfnFleet.VCpuCountRangeProperty(
                    min=123,

                    # the properties below are optional
                    max=123
                ),

                # the properties below are optional
                allowed_instance_types=["allowedInstanceTypes"],
                custom_amounts=[deadline.CfnFleet.FleetAmountCapabilityProperty(
                    min=123,
                    name="name",

                    # the properties below are optional
                    max=123
                )],
                custom_attributes=[deadline.CfnFleet.FleetAttributeCapabilityProperty(
                    name="name",
                    values=["values"]
                )],
                excluded_instance_types=["excludedInstanceTypes"],
                root_ebs_volume=deadline.CfnFleet.Ec2EbsVolumeProperty(
                    iops=123,
                    size_gi_b=123,
                    throughput_mi_b=123
                )
            ),
            instance_market_options=deadline.CfnFleet.ServiceManagedEc2InstanceMarketOptionsProperty(
                type="type"
            )
        )
    ),
    display_name="displayName",
    max_worker_count=123,
    role_arn="roleArn",

    # the properties below are optional
    description="description",
    farm_id="farmId",
    min_worker_count=123
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • configuration (Union[IResolvable, FleetConfigurationProperty, Dict[str, Any]]) – The configuration details for the fleet.

  • display_name (str) – The display name of the fleet summary to update.

  • max_worker_count (Union[int, float]) – The maximum number of workers specified in the fleet.

  • role_arn (str) – The IAM role that workers in the fleet use when processing jobs.

  • description (Optional[str]) – A description that helps identify what the fleet is used for. Default: - “”

  • farm_id (Optional[str]) – The farm ID.

  • min_worker_count (Union[int, float, None]) – The minimum number of workers in the fleet. Default: - 0

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Deadline::Fleet'
attr_arn

The Amazon Resource Name (ARN) assigned to the fleet.

CloudformationAttribute:

Arn

attr_capabilities

Capabilities

Type:

cloudformationAttribute

attr_fleet_id

The fleet ID.

CloudformationAttribute:

FleetId

attr_status

The status of the fleet.

CloudformationAttribute:

Status

attr_worker_count

The number of workers in the fleet summary.

CloudformationAttribute:

WorkerCount

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

configuration

The configuration details for the fleet.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

A description that helps identify what the fleet is used for.

display_name

The display name of the fleet summary to update.

farm_id

The farm ID.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

max_worker_count

The maximum number of workers specified in the fleet.

min_worker_count

The minimum number of workers in the fleet.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

role_arn

The IAM role that workers in the fleet use when processing jobs.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AcceleratorCountRangeProperty

class CfnFleet.AcceleratorCountRangeProperty(*, min, max=None)

Bases: object

The range for the GPU fleet acceleration.

Parameters:

  • min (Union[int, float]) – The minimum GPU for the accelerator.

  • max (Union[int, float, None]) – The maximum GPU for the accelerator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcountrange.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

accelerator_count_range_property = deadline.CfnFleet.AcceleratorCountRangeProperty(
    min=123,

    # the properties below are optional
    max=123
)

Attributes

max

The maximum GPU for the accelerator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcountrange.html#cfn-deadline-fleet-acceleratorcountrange-max

min

The minimum GPU for the accelerator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcountrange.html#cfn-deadline-fleet-acceleratorcountrange-min

AcceleratorTotalMemoryMiBRangeProperty

class CfnFleet.AcceleratorTotalMemoryMiBRangeProperty(*, min, max=None)

Bases: object

The range for memory, in MiB, to use for the accelerator.

Parameters:

  • min (Union[int, float]) – The minimum amount of memory to use for the accelerator, measured in MiB.

  • max (Union[int, float, None]) – The maximum amount of memory to use for the accelerator, measured in MiB.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratortotalmemorymibrange.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

accelerator_total_memory_mi_bRange_property = deadline.CfnFleet.AcceleratorTotalMemoryMiBRangeProperty(
    min=123,

    # the properties below are optional
    max=123
)

Attributes

max

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratortotalmemorymibrange.html#cfn-deadline-fleet-acceleratortotalmemorymibrange-max

min

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratortotalmemorymibrange.html#cfn-deadline-fleet-acceleratortotalmemorymibrange-min

CustomerManagedFleetConfigurationProperty

class CfnFleet.CustomerManagedFleetConfigurationProperty(*, mode, worker_capabilities, storage_profile_id=None)

Bases: object

The details of a customer managed fleet configuration.

Parameters:

  • mode (str) – The AWS Auto Scaling mode for the customer managed fleet configuration.

  • worker_capabilities (Union[IResolvable, CustomerManagedWorkerCapabilitiesProperty, Dict[str, Any]]) – The worker capabilities for a customer managed fleet configuration.

  • storage_profile_id (Optional[str]) – The storage profile ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

customer_managed_fleet_configuration_property = deadline.CfnFleet.CustomerManagedFleetConfigurationProperty(
    mode="mode",
    worker_capabilities=deadline.CfnFleet.CustomerManagedWorkerCapabilitiesProperty(
        cpu_architecture_type="cpuArchitectureType",
        memory_mi_b=deadline.CfnFleet.MemoryMiBRangeProperty(
            min=123,

            # the properties below are optional
            max=123
        ),
        os_family="osFamily",
        v_cpu_count=deadline.CfnFleet.VCpuCountRangeProperty(
            min=123,

            # the properties below are optional
            max=123
        ),

        # the properties below are optional
        accelerator_count=deadline.CfnFleet.AcceleratorCountRangeProperty(
            min=123,

            # the properties below are optional
            max=123
        ),
        accelerator_total_memory_mi_b=deadline.CfnFleet.AcceleratorTotalMemoryMiBRangeProperty(
            min=123,

            # the properties below are optional
            max=123
        ),
        accelerator_types=["acceleratorTypes"],
        custom_amounts=[deadline.CfnFleet.FleetAmountCapabilityProperty(
            min=123,
            name="name",

            # the properties below are optional
            max=123
        )],
        custom_attributes=[deadline.CfnFleet.FleetAttributeCapabilityProperty(
            name="name",
            values=["values"]
        )]
    ),

    # the properties below are optional
    storage_profile_id="storageProfileId"
)

Attributes

mode

The AWS Auto Scaling mode for the customer managed fleet configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html#cfn-deadline-fleet-customermanagedfleetconfiguration-mode

storage_profile_id

The storage profile ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html#cfn-deadline-fleet-customermanagedfleetconfiguration-storageprofileid

worker_capabilities

The worker capabilities for a customer managed fleet configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html#cfn-deadline-fleet-customermanagedfleetconfiguration-workercapabilities

CustomerManagedWorkerCapabilitiesProperty

class CfnFleet.CustomerManagedWorkerCapabilitiesProperty(*, cpu_architecture_type, memory_mib, os_family, v_cpu_count, accelerator_count=None, accelerator_total_memory_mib=None, accelerator_types=None, custom_amounts=None, custom_attributes=None)

Bases: object

The worker capabilities for a customer managed workflow.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

customer_managed_worker_capabilities_property = deadline.CfnFleet.CustomerManagedWorkerCapabilitiesProperty(
    cpu_architecture_type="cpuArchitectureType",
    memory_mi_b=deadline.CfnFleet.MemoryMiBRangeProperty(
        min=123,

        # the properties below are optional
        max=123
    ),
    os_family="osFamily",
    v_cpu_count=deadline.CfnFleet.VCpuCountRangeProperty(
        min=123,

        # the properties below are optional
        max=123
    ),

    # the properties below are optional
    accelerator_count=deadline.CfnFleet.AcceleratorCountRangeProperty(
        min=123,

        # the properties below are optional
        max=123
    ),
    accelerator_total_memory_mi_b=deadline.CfnFleet.AcceleratorTotalMemoryMiBRangeProperty(
        min=123,

        # the properties below are optional
        max=123
    ),
    accelerator_types=["acceleratorTypes"],
    custom_amounts=[deadline.CfnFleet.FleetAmountCapabilityProperty(
        min=123,
        name="name",

        # the properties below are optional
        max=123
    )],
    custom_attributes=[deadline.CfnFleet.FleetAttributeCapabilityProperty(
        name="name",
        values=["values"]
    )]
)

Attributes

accelerator_count

The range of the accelerator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-acceleratorcount

accelerator_total_memory_mib

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-acceleratortotalmemorymib

accelerator_types

The accelerator types for the customer managed worker capabilities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-acceleratortypes

cpu_architecture_type

The CPU architecture type for the customer managed worker capabilities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-cpuarchitecturetype

custom_amounts

Custom requirement ranges for customer managed worker capabilities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-customamounts

custom_attributes

Custom attributes for the customer manged worker capabilities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-customattributes

memory_mib

The memory (MiB).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-memorymib

os_family

The operating system (OS) family.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-osfamily

v_cpu_count

The vCPU count for the customer manged worker capabilities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-vcpucount

Ec2EbsVolumeProperty

class CfnFleet.Ec2EbsVolumeProperty(*, iops=None, size_gib=None, throughput_mib=None)

Bases: object

Specifies the EBS volume.

Parameters:

  • iops (Union[int, float, None]) – The IOPS per volume. Default: - 3000

  • size_gib (Union[int, float, None]) – The EBS volume size in GiB. Default: - 250

  • throughput_mib (Union[int, float, None]) – The throughput per volume in MiB. Default: - 125

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

ec2_ebs_volume_property = deadline.CfnFleet.Ec2EbsVolumeProperty(
    iops=123,
    size_gi_b=123,
    throughput_mi_b=123
)

Attributes

iops

The IOPS per volume.

Default:

  • 3000

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html#cfn-deadline-fleet-ec2ebsvolume-iops

size_gib

The EBS volume size in GiB.

Default:

  • 250

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html#cfn-deadline-fleet-ec2ebsvolume-sizegib

throughput_mib

The throughput per volume in MiB.

Default:

  • 125

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html#cfn-deadline-fleet-ec2ebsvolume-throughputmib

FleetAmountCapabilityProperty

class CfnFleet.FleetAmountCapabilityProperty(*, min, name, max=None)

Bases: object

The fleet amount and attribute capabilities.

Parameters:

  • min (Union[int, float]) – The minimum amount of fleet worker capability.

  • name (str) – The name of the fleet capability.

  • max (Union[int, float, None]) – The maximum amount of the fleet worker capability.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

fleet_amount_capability_property = deadline.CfnFleet.FleetAmountCapabilityProperty(
    min=123,
    name="name",

    # the properties below are optional
    max=123
)

Attributes

max

The maximum amount of the fleet worker capability.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html#cfn-deadline-fleet-fleetamountcapability-max

min

The minimum amount of fleet worker capability.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html#cfn-deadline-fleet-fleetamountcapability-min

name

The name of the fleet capability.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html#cfn-deadline-fleet-fleetamountcapability-name

FleetAttributeCapabilityProperty

class CfnFleet.FleetAttributeCapabilityProperty(*, name, values)

Bases: object

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

Parameters:

  • name (str) – The name of the fleet attribute capability for the worker.

  • values (Sequence[str]) – The number of fleet attribute capabilities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetattributecapability.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

fleet_attribute_capability_property = deadline.CfnFleet.FleetAttributeCapabilityProperty(
    name="name",
    values=["values"]
)

Attributes

name

The name of the fleet attribute capability for the worker.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetattributecapability.html#cfn-deadline-fleet-fleetattributecapability-name

values

The number of fleet attribute capabilities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetattributecapability.html#cfn-deadline-fleet-fleetattributecapability-values

FleetCapabilitiesProperty

class CfnFleet.FleetCapabilitiesProperty(*, amounts=None, attributes=None)

Bases: object

The amounts and attributes of fleets.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetcapabilities.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

fleet_capabilities_property = deadline.CfnFleet.FleetCapabilitiesProperty(
    amounts=[deadline.CfnFleet.FleetAmountCapabilityProperty(
        min=123,
        name="name",

        # the properties below are optional
        max=123
    )],
    attributes=[deadline.CfnFleet.FleetAttributeCapabilityProperty(
        name="name",
        values=["values"]
    )]
)

Attributes

amounts

Amount capabilities of the fleet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetcapabilities.html#cfn-deadline-fleet-fleetcapabilities-amounts

attributes

Attribute capabilities of the fleet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetcapabilities.html#cfn-deadline-fleet-fleetcapabilities-attributes

FleetConfigurationProperty

class CfnFleet.FleetConfigurationProperty(*, customer_managed=None, service_managed_ec2=None)

Bases: object

Fleet configuration details.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

fleet_configuration_property = deadline.CfnFleet.FleetConfigurationProperty(
    customer_managed=deadline.CfnFleet.CustomerManagedFleetConfigurationProperty(
        mode="mode",
        worker_capabilities=deadline.CfnFleet.CustomerManagedWorkerCapabilitiesProperty(
            cpu_architecture_type="cpuArchitectureType",
            memory_mi_b=deadline.CfnFleet.MemoryMiBRangeProperty(
                min=123,

                # the properties below are optional
                max=123
            ),
            os_family="osFamily",
            v_cpu_count=deadline.CfnFleet.VCpuCountRangeProperty(
                min=123,

                # the properties below are optional
                max=123
            ),

            # the properties below are optional
            accelerator_count=deadline.CfnFleet.AcceleratorCountRangeProperty(
                min=123,

                # the properties below are optional
                max=123
            ),
            accelerator_total_memory_mi_b=deadline.CfnFleet.AcceleratorTotalMemoryMiBRangeProperty(
                min=123,

                # the properties below are optional
                max=123
            ),
            accelerator_types=["acceleratorTypes"],
            custom_amounts=[deadline.CfnFleet.FleetAmountCapabilityProperty(
                min=123,
                name="name",

                # the properties below are optional
                max=123
            )],
            custom_attributes=[deadline.CfnFleet.FleetAttributeCapabilityProperty(
                name="name",
                values=["values"]
            )]
        ),

        # the properties below are optional
        storage_profile_id="storageProfileId"
    ),
    service_managed_ec2=deadline.CfnFleet.ServiceManagedEc2FleetConfigurationProperty(
        instance_capabilities=deadline.CfnFleet.ServiceManagedEc2InstanceCapabilitiesProperty(
            cpu_architecture_type="cpuArchitectureType",
            memory_mi_b=deadline.CfnFleet.MemoryMiBRangeProperty(
                min=123,

                # the properties below are optional
                max=123
            ),
            os_family="osFamily",
            v_cpu_count=deadline.CfnFleet.VCpuCountRangeProperty(
                min=123,

                # the properties below are optional
                max=123
            ),

            # the properties below are optional
            allowed_instance_types=["allowedInstanceTypes"],
            custom_amounts=[deadline.CfnFleet.FleetAmountCapabilityProperty(
                min=123,
                name="name",

                # the properties below are optional
                max=123
            )],
            custom_attributes=[deadline.CfnFleet.FleetAttributeCapabilityProperty(
                name="name",
                values=["values"]
            )],
            excluded_instance_types=["excludedInstanceTypes"],
            root_ebs_volume=deadline.CfnFleet.Ec2EbsVolumeProperty(
                iops=123,
                size_gi_b=123,
                throughput_mi_b=123
            )
        ),
        instance_market_options=deadline.CfnFleet.ServiceManagedEc2InstanceMarketOptionsProperty(
            type="type"
        )
    )
)

Attributes

customer_managed

The customer managed fleets within a fleet configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetconfiguration.html#cfn-deadline-fleet-fleetconfiguration-customermanaged

service_managed_ec2

The service managed Amazon EC2 instances for a fleet configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetconfiguration.html#cfn-deadline-fleet-fleetconfiguration-servicemanagedec2

MemoryMiBRangeProperty

class CfnFleet.MemoryMiBRangeProperty(*, min, max=None)

Bases: object

The range of memory in MiB.

Parameters:

  • min (Union[int, float]) – The minimum amount of memory (in MiB).

  • max (Union[int, float, None]) – The maximum amount of memory (in MiB).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-memorymibrange.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

memory_mi_bRange_property = deadline.CfnFleet.MemoryMiBRangeProperty(
    min=123,

    # the properties below are optional
    max=123
)

Attributes

max

The maximum amount of memory (in MiB).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-memorymibrange.html#cfn-deadline-fleet-memorymibrange-max

min

The minimum amount of memory (in MiB).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-memorymibrange.html#cfn-deadline-fleet-memorymibrange-min

ServiceManagedEc2FleetConfigurationProperty

class CfnFleet.ServiceManagedEc2FleetConfigurationProperty(*, instance_capabilities, instance_market_options)

Bases: object

The configuration details for a service managed Amazon EC2 fleet.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

service_managed_ec2_fleet_configuration_property = deadline.CfnFleet.ServiceManagedEc2FleetConfigurationProperty(
    instance_capabilities=deadline.CfnFleet.ServiceManagedEc2InstanceCapabilitiesProperty(
        cpu_architecture_type="cpuArchitectureType",
        memory_mi_b=deadline.CfnFleet.MemoryMiBRangeProperty(
            min=123,

            # the properties below are optional
            max=123
        ),
        os_family="osFamily",
        v_cpu_count=deadline.CfnFleet.VCpuCountRangeProperty(
            min=123,

            # the properties below are optional
            max=123
        ),

        # the properties below are optional
        allowed_instance_types=["allowedInstanceTypes"],
        custom_amounts=[deadline.CfnFleet.FleetAmountCapabilityProperty(
            min=123,
            name="name",

            # the properties below are optional
            max=123
        )],
        custom_attributes=[deadline.CfnFleet.FleetAttributeCapabilityProperty(
            name="name",
            values=["values"]
        )],
        excluded_instance_types=["excludedInstanceTypes"],
        root_ebs_volume=deadline.CfnFleet.Ec2EbsVolumeProperty(
            iops=123,
            size_gi_b=123,
            throughput_mi_b=123
        )
    ),
    instance_market_options=deadline.CfnFleet.ServiceManagedEc2InstanceMarketOptionsProperty(
        type="type"
    )
)

Attributes

instance_capabilities

The Amazon EC2 instance capabilities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html#cfn-deadline-fleet-servicemanagedec2fleetconfiguration-instancecapabilities

instance_market_options

The Amazon EC2 market type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html#cfn-deadline-fleet-servicemanagedec2fleetconfiguration-instancemarketoptions

ServiceManagedEc2InstanceCapabilitiesProperty

class CfnFleet.ServiceManagedEc2InstanceCapabilitiesProperty(*, cpu_architecture_type, memory_mib, os_family, v_cpu_count, allowed_instance_types=None, custom_amounts=None, custom_attributes=None, excluded_instance_types=None, root_ebs_volume=None)

Bases: object

The Amazon EC2 instance capabilities.

Parameters:

  • cpu_architecture_type (str) – The CPU architecture type.

  • memory_mib (Union[IResolvable, MemoryMiBRangeProperty, Dict[str, Any]]) – The memory, as MiB, for the Amazon EC2 instance type.

  • os_family (str) – The operating system (OS) family.

  • v_cpu_count (Union[IResolvable, VCpuCountRangeProperty, Dict[str, Any]]) – The amount of vCPU to require for instances in this fleet.

  • allowed_instance_types (Optional[Sequence[str]]) – The allowable Amazon EC2 instance types.

  • custom_amounts (Union[IResolvable, Sequence[Union[IResolvable, FleetAmountCapabilityProperty, Dict[str, Any]]], None]) – The custom capability amounts to require for instances in this fleet.

  • custom_attributes (Union[IResolvable, Sequence[Union[IResolvable, FleetAttributeCapabilityProperty, Dict[str, Any]]], None]) – The custom capability attributes to require for instances in this fleet.

  • excluded_instance_types (Optional[Sequence[str]]) – The instance types to exclude from the fleet.

  • root_ebs_volume (Union[IResolvable, Ec2EbsVolumeProperty, Dict[str, Any], None]) – The root EBS volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

service_managed_ec2_instance_capabilities_property = deadline.CfnFleet.ServiceManagedEc2InstanceCapabilitiesProperty(
    cpu_architecture_type="cpuArchitectureType",
    memory_mi_b=deadline.CfnFleet.MemoryMiBRangeProperty(
        min=123,

        # the properties below are optional
        max=123
    ),
    os_family="osFamily",
    v_cpu_count=deadline.CfnFleet.VCpuCountRangeProperty(
        min=123,

        # the properties below are optional
        max=123
    ),

    # the properties below are optional
    allowed_instance_types=["allowedInstanceTypes"],
    custom_amounts=[deadline.CfnFleet.FleetAmountCapabilityProperty(
        min=123,
        name="name",

        # the properties below are optional
        max=123
    )],
    custom_attributes=[deadline.CfnFleet.FleetAttributeCapabilityProperty(
        name="name",
        values=["values"]
    )],
    excluded_instance_types=["excludedInstanceTypes"],
    root_ebs_volume=deadline.CfnFleet.Ec2EbsVolumeProperty(
        iops=123,
        size_gi_b=123,
        throughput_mi_b=123
    )
)

Attributes

allowed_instance_types

The allowable Amazon EC2 instance types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-allowedinstancetypes

cpu_architecture_type

The CPU architecture type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-cpuarchitecturetype

custom_amounts

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-customamounts

custom_attributes

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-customattributes

excluded_instance_types

The instance types to exclude from the fleet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-excludedinstancetypes

memory_mib

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-memorymib

os_family

The operating system (OS) family.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-osfamily

root_ebs_volume

The root EBS volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-rootebsvolume

v_cpu_count

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-vcpucount

ServiceManagedEc2InstanceMarketOptionsProperty

class CfnFleet.ServiceManagedEc2InstanceMarketOptionsProperty(*, type)

Bases: object

The details of the Amazon EC2 instance market options for a service managed fleet.

Parameters:

type (str) – The Amazon EC2 instance type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancemarketoptions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

service_managed_ec2_instance_market_options_property = deadline.CfnFleet.ServiceManagedEc2InstanceMarketOptionsProperty(
    type="type"
)

Attributes

type

The Amazon EC2 instance type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancemarketoptions.html#cfn-deadline-fleet-servicemanagedec2instancemarketoptions-type

VCpuCountRangeProperty

class CfnFleet.VCpuCountRangeProperty(*, min, max=None)

Bases: object

The allowable range of vCPU processing power for the fleet.

Parameters:

  • min (Union[int, float]) – The minimum amount of vCPU.

  • max (Union[int, float, None]) – The maximum amount of vCPU.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-vcpucountrange.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

v_cpu_count_range_property = deadline.CfnFleet.VCpuCountRangeProperty(
    min=123,

    # the properties below are optional
    max=123
)

Attributes

max

The maximum amount of vCPU.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-vcpucountrange.html#cfn-deadline-fleet-vcpucountrange-max

min

The minimum amount of vCPU.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-vcpucountrange.html#cfn-deadline-fleet-vcpucountrange-min