Class CfnFleet

Creates a fleet.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnFleet

Implements

IInspectable

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AwsDeadline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFleet : CfnResource, IInspectable, ITaggableV2

Syntax (vb)

Public Class CfnFleet Inherits CfnResource Implements IInspectable, ITaggableV2

Remarks

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

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Aws_deadline;

             var cfnFleet = new CfnFleet(this, "MyCfnFleet", new CfnFleetProps {
                 Configuration = new FleetConfigurationProperty {
                     CustomerManaged = new CustomerManagedFleetConfigurationProperty {
                         Mode = "mode",
                         WorkerCapabilities = new CustomerManagedWorkerCapabilitiesProperty {
                             CpuArchitectureType = "cpuArchitectureType",
                             MemoryMiB = new MemoryMiBRangeProperty {
                                 Min = 123,

                                 // the properties below are optional
                                 Max = 123
                             },
                             OsFamily = "osFamily",
                             VCpuCount = new VCpuCountRangeProperty {
                                 Min = 123,

                                 // the properties below are optional
                                 Max = 123
                             },

                             // the properties below are optional
                             AcceleratorCount = new AcceleratorCountRangeProperty {
                                 Min = 123,

                                 // the properties below are optional
                                 Max = 123
                             },
                             AcceleratorTotalMemoryMiB = new AcceleratorTotalMemoryMiBRangeProperty {
                                 Min = 123,

                                 // the properties below are optional
                                 Max = 123
                             },
                             AcceleratorTypes = new [] { "acceleratorTypes" },
                             CustomAmounts = new [] { new FleetAmountCapabilityProperty {
                                 Min = 123,
                                 Name = "name",

                                 // the properties below are optional
                                 Max = 123
                             } },
                             CustomAttributes = new [] { new FleetAttributeCapabilityProperty {
                                 Name = "name",
                                 Values = new [] { "values" }
                             } }
                         },

                         // the properties below are optional
                         StorageProfileId = "storageProfileId",
                         TagPropagationMode = "tagPropagationMode"
                     },
                     ServiceManagedEc2 = new ServiceManagedEc2FleetConfigurationProperty {
                         InstanceCapabilities = new ServiceManagedEc2InstanceCapabilitiesProperty {
                             CpuArchitectureType = "cpuArchitectureType",
                             MemoryMiB = new MemoryMiBRangeProperty {
                                 Min = 123,

                                 // the properties below are optional
                                 Max = 123
                             },
                             OsFamily = "osFamily",
                             VCpuCount = new VCpuCountRangeProperty {
                                 Min = 123,

                                 // the properties below are optional
                                 Max = 123
                             },

                             // the properties below are optional
                             AcceleratorCapabilities = new AcceleratorCapabilitiesProperty {
                                 Selections = new [] { new AcceleratorSelectionProperty {
                                     Name = "name",

                                     // the properties below are optional
                                     Runtime = "runtime"
                                 } },

                                 // the properties below are optional
                                 Count = new AcceleratorCountRangeProperty {
                                     Min = 123,

                                     // the properties below are optional
                                     Max = 123
                                 }
                             },
                             AllowedInstanceTypes = new [] { "allowedInstanceTypes" },
                             CustomAmounts = new [] { new FleetAmountCapabilityProperty {
                                 Min = 123,
                                 Name = "name",

                                 // the properties below are optional
                                 Max = 123
                             } },
                             CustomAttributes = new [] { new FleetAttributeCapabilityProperty {
                                 Name = "name",
                                 Values = new [] { "values" }
                             } },
                             ExcludedInstanceTypes = new [] { "excludedInstanceTypes" },
                             RootEbsVolume = new Ec2EbsVolumeProperty {
                                 Iops = 123,
                                 SizeGiB = 123,
                                 ThroughputMiB = 123
                             }
                         },
                         InstanceMarketOptions = new ServiceManagedEc2InstanceMarketOptionsProperty {
                             Type = "type"
                         },

                         // the properties below are optional
                         StorageProfileId = "storageProfileId"
                     }
                 },
                 DisplayName = "displayName",
                 FarmId = "farmId",
                 MaxWorkerCount = 123,
                 RoleArn = "roleArn",

                 // the properties below are optional
                 Description = "description",
                 HostConfiguration = new HostConfigurationProperty {
                     ScriptBody = "scriptBody",

                     // the properties below are optional
                     ScriptTimeoutSeconds = 123
                 },
                 MinWorkerCount = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnFleet(Construct, string, ICfnFleetProps)

Creates a fleet.

Properties

AttrArn	The Amazon Resource Name (ARN) assigned to the fleet.
AttrCapabilities	Creates a fleet.
AttrFleetId	The fleet ID.
AttrStatus	The status of the fleet.
AttrWorkerCount	The number of workers in the fleet summary.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Creates a fleet.
Configuration	The configuration details for the fleet.
Description	A description that helps identify what the fleet is used for.
DisplayName	The display name of the fleet summary to update.
FarmId	The farm ID.
HostConfiguration	Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
MaxWorkerCount	The maximum number of workers specified in the fleet.
MinWorkerCount	The minimum number of workers in the fleet.
RoleArn	The IAM role that workers in the fleet use when processing jobs.
Tags	The tags to add to your fleet.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Creates a fleet.

Constructors

CfnFleet(Construct, string, ICfnFleetProps)

Creates a fleet.

public CfnFleet(Construct scope, string id, ICfnFleetProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnFleetProps

Resource properties.

Remarks

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

Properties

AttrArn

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

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCapabilities

Creates a fleet.

public virtual IResolvable AttrCapabilities { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: Capabilities

AttrFleetId

The fleet ID.

public virtual string AttrFleetId { get; }

Property Value

string

Remarks

CloudformationAttribute: FleetId

AttrStatus

The status of the fleet.

public virtual string AttrStatus { get; }

Property Value

string

Remarks

CloudformationAttribute: Status

AttrWorkerCount

The number of workers in the fleet summary.

public virtual double AttrWorkerCount { get; }

Property Value

double

Remarks

CloudformationAttribute: WorkerCount

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

CfnProperties

Creates a fleet.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

Configuration

The configuration details for the fleet.

public virtual object Configuration { get; set; }

Property Value

object

Remarks

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

Description

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

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

DisplayName

The display name of the fleet summary to update.

public virtual string DisplayName { get; set; }

Property Value

string

Remarks

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

FarmId

The farm ID.

public virtual string FarmId { get; set; }

Property Value

string

Remarks

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

HostConfiguration

Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

public virtual object? HostConfiguration { get; set; }

Property Value

object

Remarks

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

MaxWorkerCount

The maximum number of workers specified in the fleet.

public virtual double MaxWorkerCount { get; set; }

Property Value

double

Remarks

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

MinWorkerCount

The minimum number of workers in the fleet.

public virtual double? MinWorkerCount { get; set; }

Property Value

double?

Remarks

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

RoleArn

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

public virtual string RoleArn { get; set; }

Property Value

string

Remarks

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

Tags

The tags to add to your fleet.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

RenderProperties(IDictionary<string, object>)

Creates a fleet.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

Implements

IInspectable

ITaggableV2