CfnFleetMixinProps
- class aws_cdk.mixins_preview.aws_deadline.mixins.CfnFleetMixinProps(*, configuration=None, description=None, display_name=None, farm_id=None, host_configuration=None, max_worker_count=None, min_worker_count=None, role_arn=None, tags=None)
Bases:
objectProperties for CfnFleetPropsMixin.
- Parameters:
configuration (
Union[IResolvable,FleetConfigurationProperty,Dict[str,Any],None]) – The configuration details for the fleet.description (
Optional[str]) – A description that helps identify what the fleet is used for. .. 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. Default: - “”display_name (
Optional[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 (
Optional[str]) – The farm ID.host_configuration (
Union[IResolvable,HostConfigurationProperty,Dict[str,Any],None]) – Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. To remove a script from a fleet, use the UpdateFleet operation with thehostConfigurationscriptBodyparameter set to an empty string (“”).max_worker_count (
Union[int,float,None]) – The maximum number of workers specified in the fleet.min_worker_count (
Union[int,float,None]) – The minimum number of workers in the fleet. Default: - 0role_arn (
Optional[str]) – The IAM role that workers in the fleet use when processing jobs.tags (
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.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.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.mixins_preview.aws_deadline import mixins as deadline_mixins cfn_fleet_mixin_props = deadline_mixins.CfnFleetMixinProps( configuration=deadline_mixins.CfnFleetPropsMixin.FleetConfigurationProperty( customer_managed=deadline_mixins.CfnFleetPropsMixin.CustomerManagedFleetConfigurationProperty( mode="mode", storage_profile_id="storageProfileId", tag_propagation_mode="tagPropagationMode", worker_capabilities=deadline_mixins.CfnFleetPropsMixin.CustomerManagedWorkerCapabilitiesProperty( accelerator_count=deadline_mixins.CfnFleetPropsMixin.AcceleratorCountRangeProperty( max=123, min=123 ), accelerator_total_memory_mi_b=deadline_mixins.CfnFleetPropsMixin.AcceleratorTotalMemoryMiBRangeProperty( max=123, min=123 ), accelerator_types=["acceleratorTypes"], cpu_architecture_type="cpuArchitectureType", custom_amounts=[deadline_mixins.CfnFleetPropsMixin.FleetAmountCapabilityProperty( max=123, min=123, name="name" )], custom_attributes=[deadline_mixins.CfnFleetPropsMixin.FleetAttributeCapabilityProperty( name="name", values=["values"] )], memory_mi_b=deadline_mixins.CfnFleetPropsMixin.MemoryMiBRangeProperty( max=123, min=123 ), os_family="osFamily", v_cpu_count=deadline_mixins.CfnFleetPropsMixin.VCpuCountRangeProperty( max=123, min=123 ) ) ), service_managed_ec2=deadline_mixins.CfnFleetPropsMixin.ServiceManagedEc2FleetConfigurationProperty( instance_capabilities=deadline_mixins.CfnFleetPropsMixin.ServiceManagedEc2InstanceCapabilitiesProperty( accelerator_capabilities=deadline_mixins.CfnFleetPropsMixin.AcceleratorCapabilitiesProperty( count=deadline_mixins.CfnFleetPropsMixin.AcceleratorCountRangeProperty( max=123, min=123 ), selections=[deadline_mixins.CfnFleetPropsMixin.AcceleratorSelectionProperty( name="name", runtime="runtime" )] ), allowed_instance_types=["allowedInstanceTypes"], cpu_architecture_type="cpuArchitectureType", custom_amounts=[deadline_mixins.CfnFleetPropsMixin.FleetAmountCapabilityProperty( max=123, min=123, name="name" )], custom_attributes=[deadline_mixins.CfnFleetPropsMixin.FleetAttributeCapabilityProperty( name="name", values=["values"] )], excluded_instance_types=["excludedInstanceTypes"], memory_mi_b=deadline_mixins.CfnFleetPropsMixin.MemoryMiBRangeProperty( max=123, min=123 ), os_family="osFamily", root_ebs_volume=deadline_mixins.CfnFleetPropsMixin.Ec2EbsVolumeProperty( iops=123, size_gi_b=123, throughput_mi_b=123 ), v_cpu_count=deadline_mixins.CfnFleetPropsMixin.VCpuCountRangeProperty( max=123, min=123 ) ), instance_market_options=deadline_mixins.CfnFleetPropsMixin.ServiceManagedEc2InstanceMarketOptionsProperty( type="type" ), storage_profile_id="storageProfileId", vpc_configuration=deadline_mixins.CfnFleetPropsMixin.VpcConfigurationProperty( resource_configuration_arns=["resourceConfigurationArns"] ) ) ), description="description", display_name="displayName", farm_id="farmId", host_configuration=deadline_mixins.CfnFleetPropsMixin.HostConfigurationProperty( script_body="scriptBody", script_timeout_seconds=123 ), max_worker_count=123, min_worker_count=123, role_arn="roleArn", tags=[CfnTag( key="key", value="value" )] )
Attributes
- configuration
The configuration details for the fleet.
- description
A description that helps identify what the fleet is used for.
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.
- display_name
The display name of the fleet summary to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
- farm_id
The farm ID.
- host_configuration
Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
To remove a script from a fleet, use the UpdateFleet operation with the
hostConfigurationscriptBodyparameter set to an empty string (“”).
- max_worker_count
The maximum number of workers specified in the fleet.
- min_worker_count
The minimum number of workers in the fleet.
- role_arn
The IAM role that workers in the fleet use when processing jobs.
- tags
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.