2.233.0

interface CfnFleetMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Deadline.Mixins.CfnFleetMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdeadline/mixins#CfnFleetMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.deadline.mixins.CfnFleetMixinProps
Pythonaws_cdk.mixins_preview.aws_deadline.mixins.CfnFleetMixinProps
TypeScript @aws-cdk/mixins-preview » aws_deadline » mixins » CfnFleetMixinProps

Properties for CfnFleetPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as deadline_mixins } from '@aws-cdk/mixins-preview/aws-deadline';
const cfnFleetMixinProps: deadline_mixins.CfnFleetMixinProps = {
  configuration: {
    customerManaged: {
      mode: 'mode',
      storageProfileId: 'storageProfileId',
      tagPropagationMode: 'tagPropagationMode',
      workerCapabilities: {
        acceleratorCount: {
          max: 123,
          min: 123,
        },
        acceleratorTotalMemoryMiB: {
          max: 123,
          min: 123,
        },
        acceleratorTypes: ['acceleratorTypes'],
        cpuArchitectureType: 'cpuArchitectureType',
        customAmounts: [{
          max: 123,
          min: 123,
          name: 'name',
        }],
        customAttributes: [{
          name: 'name',
          values: ['values'],
        }],
        memoryMiB: {
          max: 123,
          min: 123,
        },
        osFamily: 'osFamily',
        vCpuCount: {
          max: 123,
          min: 123,
        },
      },
    },
    serviceManagedEc2: {
      instanceCapabilities: {
        acceleratorCapabilities: {
          count: {
            max: 123,
            min: 123,
          },
          selections: [{
            name: 'name',
            runtime: 'runtime',
          }],
        },
        allowedInstanceTypes: ['allowedInstanceTypes'],
        cpuArchitectureType: 'cpuArchitectureType',
        customAmounts: [{
          max: 123,
          min: 123,
          name: 'name',
        }],
        customAttributes: [{
          name: 'name',
          values: ['values'],
        }],
        excludedInstanceTypes: ['excludedInstanceTypes'],
        memoryMiB: {
          max: 123,
          min: 123,
        },
        osFamily: 'osFamily',
        rootEbsVolume: {
          iops: 123,
          sizeGiB: 123,
          throughputMiB: 123,
        },
        vCpuCount: {
          max: 123,
          min: 123,
        },
      },
      instanceMarketOptions: {
        type: 'type',
      },
      storageProfileId: 'storageProfileId',
      vpcConfiguration: {
        resourceConfigurationArns: ['resourceConfigurationArns'],
      },
    },
  },
  description: 'description',
  displayName: 'displayName',
  farmId: 'farmId',
  hostConfiguration: {
    scriptBody: 'scriptBody',
    scriptTimeoutSeconds: 123,
  },
  maxWorkerCount: 123,
  minWorkerCount: 123,
  roleArn: 'roleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
configuration?IResolvable | FleetConfigurationPropertyThe configuration details for the fleet.
description?stringA description that helps identify what the fleet is used for.
displayName?stringThe display name of the fleet summary to update.
farmId?stringThe farm ID.
hostConfiguration?IResolvable | HostConfigurationPropertyProvides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
maxWorkerCount?numberThe maximum number of workers specified in the fleet.
minWorkerCount?numberThe minimum number of workers in the fleet.
roleArn?stringThe IAM role that workers in the fleet use when processing jobs.
tags?CfnTag[]The tags to add to your fleet.

configuration?

Type: IResolvable | FleetConfigurationProperty (optional)

The configuration details for the fleet.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-configuration

description?

Type: string (optional, default: "")

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-description

displayName?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-displayname

farmId?

Type: string (optional)

The farm ID.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-farmid

hostConfiguration?

Type: IResolvable | HostConfigurationProperty (optional)

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 hostConfiguration scriptBody parameter set to an empty string ("").

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-hostconfiguration

maxWorkerCount?

Type: number (optional)

The maximum number of workers specified in the fleet.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-maxworkercount

minWorkerCount?

Type: number (optional, default: 0)

The minimum number of workers in the fleet.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-minworkercount

roleArn?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-rolearn

tags?

Type: CfnTag[] (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-tags

← PreviousNext →