CfnFleet
- class aws_cdk.aws_deadline.CfnFleet(scope, id, *, configuration, display_name, farm_id, max_worker_count, role_arn, description=None, min_worker_count=None, tags=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 accelerator_capabilities=deadline.CfnFleet.AcceleratorCapabilitiesProperty( selections=[deadline.CfnFleet.AcceleratorSelectionProperty( name="name", # the properties below are optional runtime="runtime" )], # the properties below are optional count=deadline.CfnFleet.AcceleratorCountRangeProperty( min=123, # the properties below are optional max=123 ) ), 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", farm_id="farmId", max_worker_count=123, role_arn="roleArn", # the properties below are optional description="description", min_worker_count=123, tags=[CfnTag( key="key", value="value" )] )
- 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. .. epigraph:: 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.farm_id (
str
) – The farm ID.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: - “”min_worker_count (
Union
[int
,float
,None
]) – The minimum number of workers in the fleet. Default: - 0tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags to add to your fleet. 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.
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
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 prefixpath
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 toaddOverride
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: truedefault (
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:
- 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:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
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:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- 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
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- 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).
- tags
The tags to add to your fleet.
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 detectConstruct
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 classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, 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 extendsConstruct
.
AcceleratorCapabilitiesProperty
- class CfnFleet.AcceleratorCapabilitiesProperty(*, selections, count=None)
Bases:
object
Provides information about the GPU accelerators used for jobs processed by a fleet.
- Parameters:
selections (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AcceleratorSelectionProperty
,Dict
[str
,Any
]]]]) – 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.count (
Union
[IResolvable
,AcceleratorCountRangeProperty
,Dict
[str
,Any
],None
]) – The number of GPU accelerators specified for worker hosts in this fleet.
- See:
- 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_capabilities_property = deadline.CfnFleet.AcceleratorCapabilitiesProperty( selections=[deadline.CfnFleet.AcceleratorSelectionProperty( name="name", # the properties below are optional runtime="runtime" )], # the properties below are optional count=deadline.CfnFleet.AcceleratorCountRangeProperty( min=123, # the properties below are optional max=123 ) )
Attributes
- count
The number of GPU accelerators specified for worker hosts in this fleet.
- selections
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.
AcceleratorCountRangeProperty
- class CfnFleet.AcceleratorCountRangeProperty(*, min, max=None)
Bases:
object
Defines the maximum and minimum number of GPU accelerators required for a worker instance..
- Parameters:
min (
Union
[int
,float
]) – The minimum number of GPU accelerators in the worker host.max (
Union
[int
,float
,None
]) – The maximum number of GPU accelerators in the worker host.
- See:
- 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 number of GPU accelerators in the worker host.
- min
The minimum number of GPU accelerators in the worker host.
AcceleratorSelectionProperty
- class CfnFleet.AcceleratorSelectionProperty(*, name, runtime=None)
Bases:
object
Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host.
- Parameters:
name (
str
) – The name of the chip used by the GPU accelerator. If you specifyl4
as the name of the accelerator, you must specifylatest
orgrid:r550
as the runtime. The available GPU accelerators are: -t4
- NVIDIA T4 Tensor Core GPU -a10g
- NVIDIA A10G Tensor Core GPU -l4
- NVIDIA L4 Tensor Core GPU -l40s
- NVIDIA L40S Tensor Core GPUruntime (
Optional
[str
]) – Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs. You can choose from the following runtimes: -latest
- Use the latest runtime available for the chip. If you specifylatest
and a new version of the runtime is released, the new version of the runtime is used. -grid:r550
- NVIDIA vGPU software 17 -grid:r535
- NVIDIA vGPU software 16 If you don’t specify a runtime, Deadline Cloud useslatest
as the default. However, if you have multiple accelerators and specifylatest
for some and leave others blank, Deadline Cloud raises an exception.
- See:
- 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_selection_property = deadline.CfnFleet.AcceleratorSelectionProperty( name="name", # the properties below are optional runtime="runtime" )
Attributes
- name
The name of the chip used by the GPU accelerator.
If you specify
l4
as the name of the accelerator, you must specifylatest
orgrid:r550
as the runtime.The available GPU accelerators are:
t4
- NVIDIA T4 Tensor Core GPUa10g
- NVIDIA A10G Tensor Core GPUl4
- NVIDIA L4 Tensor Core GPUl40s
- NVIDIA L40S Tensor Core GPU
- runtime
Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs.
You can choose from the following runtimes:
latest
- Use the latest runtime available for the chip. If you specifylatest
and a new version of the runtime is released, the new version of the runtime is used.grid:r550
- NVIDIA vGPU software 17grid:r535
- NVIDIA vGPU software 16
If you don’t specify a runtime, Deadline Cloud uses
latest
as the default. However, if you have multiple accelerators and specifylatest
for some and leave others blank, Deadline Cloud raises an exception.
AcceleratorTotalMemoryMiBRangeProperty
- class CfnFleet.AcceleratorTotalMemoryMiBRangeProperty(*, min, max=None)
Bases:
object
Defines the maximum and minimum amount of 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:
- 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.
- min
The minimum amount of memory to use for the accelerator, measured in MiB.
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:
- 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.
- storage_profile_id
The storage profile ID.
- worker_capabilities
The worker capabilities for a customer managed fleet configuration.
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:
cpu_architecture_type (
str
) – The CPU architecture type for the customer managed worker capabilities.memory_mib (
Union
[IResolvable
,MemoryMiBRangeProperty
,Dict
[str
,Any
]]) – The memory (MiB).os_family (
str
) – The operating system (OS) family.v_cpu_count (
Union
[IResolvable
,VCpuCountRangeProperty
,Dict
[str
,Any
]]) – The vCPU count for the customer manged worker capabilities.accelerator_count (
Union
[IResolvable
,AcceleratorCountRangeProperty
,Dict
[str
,Any
],None
]) – The range of the accelerator.accelerator_total_memory_mib (
Union
[IResolvable
,AcceleratorTotalMemoryMiBRangeProperty
,Dict
[str
,Any
],None
]) – The total memory (MiB) for the customer managed worker capabilities.accelerator_types (
Optional
[Sequence
[str
]]) – The accelerator types for the customer managed worker capabilities.custom_amounts (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,FleetAmountCapabilityProperty
,Dict
[str
,Any
]]],None
]) – Custom requirement ranges for customer managed worker capabilities.custom_attributes (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,FleetAttributeCapabilityProperty
,Dict
[str
,Any
]]],None
]) – Custom attributes for the customer manged worker capabilities.
- See:
- 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.
- accelerator_total_memory_mib
The total memory (MiB) for the customer managed worker capabilities.
- accelerator_types
The accelerator types for the customer managed worker capabilities.
- cpu_architecture_type
The CPU architecture type for the customer managed worker capabilities.
- custom_amounts
Custom requirement ranges for customer managed worker capabilities.
- custom_attributes
Custom attributes for the customer manged worker capabilities.
- memory_mib
The memory (MiB).
- os_family
The operating system (OS) family.
- v_cpu_count
The vCPU count for the customer manged worker capabilities.
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: - 3000size_gib (
Union
[int
,float
,None
]) – The EBS volume size in GiB. Default: - 250throughput_mib (
Union
[int
,float
,None
]) – The throughput per volume in MiB. Default: - 125
- See:
- 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.
- size_gib
The EBS volume size in GiB.
- throughput_mib
The throughput per volume in MiB.
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:
- 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.
- min
The minimum amount of fleet worker capability.
- name
The name of the fleet capability.
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:
- 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.
- values
The number of fleet attribute capabilities.
FleetCapabilitiesProperty
- class CfnFleet.FleetCapabilitiesProperty(*, amounts=None, attributes=None)
Bases:
object
The amounts and attributes of fleets.
- Parameters:
amounts (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,FleetAmountCapabilityProperty
,Dict
[str
,Any
]]],None
]) – Amount capabilities of the fleet.attributes (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,FleetAttributeCapabilityProperty
,Dict
[str
,Any
]]],None
]) – Attribute capabilities of the fleet.
- See:
- 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.
- attributes
Attribute capabilities of the fleet.
FleetConfigurationProperty
- class CfnFleet.FleetConfigurationProperty(*, customer_managed=None, service_managed_ec2=None)
Bases:
object
Fleet configuration details.
- Parameters:
customer_managed (
Union
[IResolvable
,CustomerManagedFleetConfigurationProperty
,Dict
[str
,Any
],None
]) – The customer managed fleets within a fleet configuration.service_managed_ec2 (
Union
[IResolvable
,ServiceManagedEc2FleetConfigurationProperty
,Dict
[str
,Any
],None
]) – The service managed Amazon EC2 instances for a fleet configuration.
- See:
- 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 accelerator_capabilities=deadline.CfnFleet.AcceleratorCapabilitiesProperty( selections=[deadline.CfnFleet.AcceleratorSelectionProperty( name="name", # the properties below are optional runtime="runtime" )], # the properties below are optional count=deadline.CfnFleet.AcceleratorCountRangeProperty( min=123, # the properties below are optional max=123 ) ), 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.
- service_managed_ec2
The service managed Amazon EC2 instances for a fleet configuration.
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:
- 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).
- min
The minimum amount of memory (in MiB).
ServiceManagedEc2FleetConfigurationProperty
- class CfnFleet.ServiceManagedEc2FleetConfigurationProperty(*, instance_capabilities, instance_market_options)
Bases:
object
The configuration details for a service managed Amazon EC2 fleet.
- Parameters:
instance_capabilities (
Union
[IResolvable
,ServiceManagedEc2InstanceCapabilitiesProperty
,Dict
[str
,Any
]]) – The Amazon EC2 instance capabilities.instance_market_options (
Union
[IResolvable
,ServiceManagedEc2InstanceMarketOptionsProperty
,Dict
[str
,Any
]]) – The Amazon EC2 market type.
- See:
- 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 accelerator_capabilities=deadline.CfnFleet.AcceleratorCapabilitiesProperty( selections=[deadline.CfnFleet.AcceleratorSelectionProperty( name="name", # the properties below are optional runtime="runtime" )], # the properties below are optional count=deadline.CfnFleet.AcceleratorCountRangeProperty( min=123, # the properties below are optional max=123 ) ), 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.
- instance_market_options
The Amazon EC2 market type.
ServiceManagedEc2InstanceCapabilitiesProperty
- class CfnFleet.ServiceManagedEc2InstanceCapabilitiesProperty(*, cpu_architecture_type, memory_mib, os_family, v_cpu_count, accelerator_capabilities=None, 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.accelerator_capabilities (
Union
[IResolvable
,AcceleratorCapabilitiesProperty
,Dict
[str
,Any
],None
]) – Describes the GPU accelerator capabilities required for worker host 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:
- 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 accelerator_capabilities=deadline.CfnFleet.AcceleratorCapabilitiesProperty( selections=[deadline.CfnFleet.AcceleratorSelectionProperty( name="name", # the properties below are optional runtime="runtime" )], # the properties below are optional count=deadline.CfnFleet.AcceleratorCountRangeProperty( min=123, # the properties below are optional max=123 ) ), 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
- accelerator_capabilities
Describes the GPU accelerator capabilities required for worker host instances in this fleet.
- allowed_instance_types
The allowable Amazon EC2 instance types.
- cpu_architecture_type
The CPU architecture type.
- custom_amounts
The custom capability amounts to require for instances in this fleet.
- custom_attributes
The custom capability attributes to require for instances in this fleet.
- excluded_instance_types
The instance types to exclude from the fleet.
- memory_mib
The memory, as MiB, for the Amazon EC2 instance type.
- os_family
The operating system (OS) family.
- root_ebs_volume
The root EBS volume.
- v_cpu_count
The amount of vCPU to require for instances in this fleet.
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:
- 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
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:
- 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.