class CfnInstanceFleetConfig (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.EMR.CfnInstanceFleetConfig`
Java	`software.amazon.awscdk.services.emr.CfnInstanceFleetConfig`
Python	`aws_cdk.aws_emr.CfnInstanceFleetConfig`
TypeScript	`@aws-cdk/aws-emr` » `CfnInstanceFleetConfig`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::EMR::InstanceFleetConfig.

Use InstanceFleetConfig to define instance fleets for an EMR cluster. A cluster can not use both instance fleets and instance groups. For more information, see Configure Instance Fleets in the Amazon EMR Management Guide .

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. > You can currently only add a task instance fleet to a cluster with this resource. If you use this resource, CloudFormation waits for the cluster launch to complete before adding the task instance fleet to the cluster. In order to add a task instance fleet to the cluster as part of the cluster launch and minimize delays in provisioning task nodes, use the TaskInstanceFleets subproperty for the AWS::EMR::Cluster JobFlowInstancesConfig property instead. To use this subproperty, see AWS::EMR::Cluster for examples.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as emr from '@aws-cdk/aws-emr';

declare const configurationProperty_: emr.CfnInstanceFleetConfig.ConfigurationProperty;
const cfnInstanceFleetConfig = new emr.CfnInstanceFleetConfig(this, 'MyCfnInstanceFleetConfig', {
  clusterId: 'clusterId',
  instanceFleetType: 'instanceFleetType',

  // the properties below are optional
  instanceTypeConfigs: [{
    instanceType: 'instanceType',

    // the properties below are optional
    bidPrice: 'bidPrice',
    bidPriceAsPercentageOfOnDemandPrice: 123,
    configurations: [{
      classification: 'classification',
      configurationProperties: {
        configurationPropertiesKey: 'configurationProperties',
      },
      configurations: [configurationProperty_],
    }],
    customAmiId: 'customAmiId',
    ebsConfiguration: {
      ebsBlockDeviceConfigs: [{
        volumeSpecification: {
          sizeInGb: 123,
          volumeType: 'volumeType',

          // the properties below are optional
          iops: 123,
        },

        // the properties below are optional
        volumesPerInstance: 123,
      }],
      ebsOptimized: false,
    },
    weightedCapacity: 123,
  }],
  launchSpecifications: {
    onDemandSpecification: {
      allocationStrategy: 'allocationStrategy',
    },
    spotSpecification: {
      timeoutAction: 'timeoutAction',
      timeoutDurationMinutes: 123,

      // the properties below are optional
      allocationStrategy: 'allocationStrategy',
      blockDurationMinutes: 123,
    },
  },
  name: 'name',
  targetOnDemandCapacity: 123,
  targetSpotCapacity: 123,
});

Initializer

new CfnInstanceFleetConfig(scope: Construct, id: string, props: CfnInstanceFleetConfigProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnInstanceFleetConfigProps — - resource properties.

Create a new AWS::EMR::InstanceFleetConfig.

Construct Props

Name	Type	Description
clusterId	`string`	The unique identifier of the EMR cluster.
instanceFleetType	`string`	The node type that the instance fleet hosts.
instanceTypeConfigs?	`IResolvable` `\|` `IResolvable` `\|` `InstanceTypeConfigProperty[]`	`InstanceTypeConfigs` determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.
launchSpecifications?	`IResolvable` `\|` `InstanceFleetProvisioningSpecificationsProperty`	The launch specification for the instance fleet.
name?	`string`	The friendly name of the instance fleet.
targetOnDemandCapacity?	`number`	The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision.
targetSpotCapacity?	`number`	The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision.

clusterId

Type: string

The unique identifier of the EMR cluster.

instanceFleetType

Type: string

The node type that the instance fleet hosts.

Allowed Values : TASK

instanceTypeConfigs?

Type: IResolvable | IResolvable | InstanceTypeConfigProperty[] (optional)

InstanceTypeConfigs determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

launchSpecifications?

Type: IResolvable | InstanceFleetProvisioningSpecificationsProperty (optional)

The launch specification for the instance fleet.

name?

Type: string (optional)

The friendly name of the instance fleet.

targetOnDemandCapacity?

Type: number (optional)

The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision.

When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig . Each instance configuration has a specified WeightedCapacity . When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity . At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

targetSpotCapacity?

Type: number (optional)

The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision.

When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig . Each instance configuration has a specified WeightedCapacity . When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

Properties

Name	Type	Description
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
clusterId	`string`	The unique identifier of the EMR cluster.
creationStack	`string[]`
instanceFleetType	`string`	The node type that the instance fleet hosts.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
instanceTypeConfigs?	`IResolvable` `\|` `IResolvable` `\|` `InstanceTypeConfigProperty[]`	`InstanceTypeConfigs` determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.
launchSpecifications?	`IResolvable` `\|` `InstanceFleetProvisioningSpecificationsProperty`	The launch specification for the instance fleet.
name?	`string`	The friendly name of the instance fleet.
targetOnDemandCapacity?	`number`	The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision.
targetSpotCapacity?	`number`	The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

clusterId

Type: string

The unique identifier of the EMR cluster.

creationStack

Type: string[]

instanceFleetType

Type: string

The node type that the instance fleet hosts.

Allowed Values : TASK

logicalId

Type: string

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).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

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 }).

stack

Type: Stack

The stack in which this element is defined.

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

instanceTypeConfigs?

Type: IResolvable | IResolvable | InstanceTypeConfigProperty[] (optional)

InstanceTypeConfigs determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

launchSpecifications?

Type: IResolvable | InstanceFleetProvisioningSpecificationsProperty (optional)

The launch specification for the instance fleet.

name?

Type: string (optional)

The friendly name of the instance fleet.

targetOnDemandCapacity?

Type: number (optional)

The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision.

If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity . At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

targetSpotCapacity?

Type: number (optional)

The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision.

If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

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.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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.](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.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"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.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

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

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

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

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

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).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

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)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

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

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }