Skip to content
v2.278.0

InstancesConfigProperty Struct ​

A specification of the number and type of Amazon EC2 instances.

See the RunJobFlow API for complete documentation on input parameters

Example ​

ts
new tasks.EmrCreateCluster(this, 'PrioritizedAllocation', {
  instances: {
    instanceFleets: [{
      instanceFleetType: tasks.EmrCreateCluster.InstanceRoleType.CORE,
      instanceTypeConfigs: [{
        instanceType: 'm5.large',
        priority: 0, // Highest priority
      }, {
        instanceType: 'm5.xlarge',
        priority: 1, // Lower priority
      }],
      launchSpecifications: {
        onDemandSpecification: {
          allocationStrategy: tasks.EmrCreateCluster.OnDemandAllocationStrategy.PRIORITIZED,
        },
      },
      targetOnDemandCapacity: 2,
    }],
  },
  name: 'PrioritizedCluster',
  integrationPattern: sfn.IntegrationPattern.RUN_JOB,
});
python
tasks.EmrCreateCluster(self, "PrioritizedAllocation",
    instances=tasks.EmrCreateCluster.InstancesConfigProperty(
        instance_fleets=[tasks.EmrCreateCluster.InstanceFleetConfigProperty(
            instance_fleet_type=tasks.EmrCreateCluster.InstanceRoleType.CORE,
            instance_type_configs=[tasks.EmrCreateCluster.InstanceTypeConfigProperty(
                instance_type="m5.large",
                priority=0
            ), tasks.EmrCreateCluster.InstanceTypeConfigProperty(
                instance_type="m5.xlarge",
                priority=1
            )],
            launch_specifications=tasks.EmrCreateCluster.InstanceFleetProvisioningSpecificationsProperty(
                on_demand_specification=tasks.EmrCreateCluster.OnDemandProvisioningSpecificationProperty(
                    allocation_strategy=tasks.EmrCreateCluster.OnDemandAllocationStrategy.PRIORITIZED
                )
            ),
            target_on_demand_capacity=2
        )]
    ),
    name="PrioritizedCluster",
    integration_pattern=sfn.IntegrationPattern.RUN_JOB
)
java
EmrCreateCluster.Builder.create(this, "PrioritizedAllocation")
        .instances(InstancesConfigProperty.builder()
                .instanceFleets(List.of(InstanceFleetConfigProperty.builder()
                        .instanceFleetType(EmrCreateCluster.getInstanceRoleType().CORE)
                        .instanceTypeConfigs(List.of(InstanceTypeConfigProperty.builder()
                                .instanceType("m5.large")
                                .priority(0)
                                .build(), InstanceTypeConfigProperty.builder()
                                .instanceType("m5.xlarge")
                                .priority(1)
                                .build()))
                        .launchSpecifications(InstanceFleetProvisioningSpecificationsProperty.builder()
                                .onDemandSpecification(OnDemandProvisioningSpecificationProperty.builder()
                                        .allocationStrategy(EmrCreateCluster.getOnDemandAllocationStrategy().PRIORITIZED)
                                        .build())
                                .build())
                        .targetOnDemandCapacity(2)
                        .build()))
                .build())
        .name("PrioritizedCluster")
        .integrationPattern(IntegrationPattern.RUN_JOB)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
new EmrCreateCluster(this, "PrioritizedAllocation", new EmrCreateClusterProps {
    Instances = new InstancesConfigProperty {
        InstanceFleets = new [] { new InstanceFleetConfigProperty {
            InstanceFleetType = EmrCreateCluster.InstanceRoleType.CORE,
            InstanceTypeConfigs = new [] { new InstanceTypeConfigProperty {
                InstanceType = "m5.large",
                Priority = 0
            }, new InstanceTypeConfigProperty {
                InstanceType = "m5.xlarge",
                Priority = 1
            } },
            LaunchSpecifications = new InstanceFleetProvisioningSpecificationsProperty {
                OnDemandSpecification = new OnDemandProvisioningSpecificationProperty {
                    AllocationStrategy = EmrCreateCluster.OnDemandAllocationStrategy.PRIORITIZED
                }
            },
            TargetOnDemandCapacity = 2
        } }
    },
    Name = "PrioritizedCluster",
    IntegrationPattern = IntegrationPattern.RUN_JOB
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
tasks.NewEmrCreateCluster(this, jsii.String("PrioritizedAllocation"), &EmrCreateClusterProps{
	Instances: &InstancesConfigProperty{
		InstanceFleets: []InstanceFleetConfigProperty{
			&InstanceFleetConfigProperty{
				InstanceFleetType: tasks.EmrCreateCluster.InstanceRoleType_CORE,
				InstanceTypeConfigs: []InstanceTypeConfigProperty{
					&InstanceTypeConfigProperty{
						InstanceType: jsii.String("m5.large"),
						Priority: jsii.Number(0),
					},
					&InstanceTypeConfigProperty{
						InstanceType: jsii.String("m5.xlarge"),
						Priority: jsii.Number(1),
					},
				},
				LaunchSpecifications: &InstanceFleetProvisioningSpecificationsProperty{
					OnDemandSpecification: &OnDemandProvisioningSpecificationProperty{
						AllocationStrategy: tasks.EmrCreateCluster.OnDemandAllocationStrategy_PRIORITIZED,
					},
				},
				TargetOnDemandCapacity: jsii.Number(2),
			},
		},
	},
	Name: jsii.String("PrioritizedCluster"),
	IntegrationPattern: sfn.IntegrationPattern_RUN_JOB,
})

Properties ​

additionalMasterSecurityGroupsoptionalstring[]additional_master_security_groupsoptionaltyping.List[str]additionalMasterSecurityGroupsoptionalList<String>AdditionalMasterSecurityGroupsoptionalstring[]AdditionalMasterSecurityGroupsoptional*[]*string = None #
A list of additional Amazon EC2 security group IDs for the master node.
additionalSlaveSecurityGroupsoptionalstring[]additional_slave_security_groupsoptionaltyping.List[str]additionalSlaveSecurityGroupsoptionalList<String>AdditionalSlaveSecurityGroupsoptionalstring[]AdditionalSlaveSecurityGroupsoptional*[]*string = None #
A list of additional Amazon EC2 security group IDs for the core and task nodes.
ec2KeyNameoptionalstringec2_key_nameoptionalstrec2KeyNameoptionalStringEc2KeyNameoptionalstringEc2KeyNameoptional*string = None #
The name of the EC2 key pair that can be used to ssh to the master node as the user called "hadoop.".
ec2SubnetIdoptionalstringec2_subnet_idoptionalstrec2SubnetIdoptionalStringEc2SubnetIdoptionalstringEc2SubnetIdoptional*string #
Applies to clusters that use the uniform instance group configuration.

Default: EMR selected default

To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch.

ec2SubnetIdsoptionalstring[]ec2_subnet_idsoptionaltyping.List[str]ec2SubnetIdsoptionalList<String>Ec2SubnetIdsoptionalstring[]Ec2SubnetIdsoptional*[]*string #
Applies to clusters that use the instance fleet configuration.

Default: EMR selected default

When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.

emrManagedMasterSecurityGroupoptionalstringemr_managed_master_security_groupoptionalstremrManagedMasterSecurityGroupoptionalStringEmrManagedMasterSecurityGroupoptionalstringEmrManagedMasterSecurityGroupoptional*string = None #
The identifier of the Amazon EC2 security group for the master node.
emrManagedSlaveSecurityGroupoptionalstringemr_managed_slave_security_groupoptionalstremrManagedSlaveSecurityGroupoptionalStringEmrManagedSlaveSecurityGroupoptionalstringEmrManagedSlaveSecurityGroupoptional*string = None #
The identifier of the Amazon EC2 security group for the core and task nodes.
hadoopVersionoptionalstringhadoop_versionoptionalstrhadoopVersionoptionalStringHadoopVersionoptionalstringHadoopVersionoptional*string #
Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster.

Default: 0.18 if the AmiVersion parameter is not set. If AmiVersion is set, the version of Hadoop for that AMI version is used.

instanceCountoptionalnumberinstance_countoptionalint | floatinstanceCountoptionalNumberInstanceCountoptionaldoubleInstanceCountoptional*float64 = 0 #
The number of EC2 instances in the cluster.
instanceFleetsoptionalEmrCreateCluster.InstanceFleetConfigProperty[]instance_fleetsoptionaltyping.List[InstanceFleetConfigProperty]instanceFleetsoptionalList<InstanceFleetConfigProperty>InstanceFleetsoptionalInstanceFleetConfigProperty[]InstanceFleetsoptional*[]InstanceFleetConfigProperty = None #
Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

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

instanceGroupsoptionalEmrCreateCluster.InstanceGroupConfigProperty[]instance_groupsoptionaltyping.List[InstanceGroupConfigProperty]instanceGroupsoptionalList<InstanceGroupConfigProperty>InstanceGroupsoptionalInstanceGroupConfigProperty[]InstanceGroupsoptional*[]InstanceGroupConfigProperty = None #
Configuration for the instance groups in a cluster.
masterInstanceTypeoptionalstringmaster_instance_typeoptionalstrmasterInstanceTypeoptionalStringMasterInstanceTypeoptionalstringMasterInstanceTypeoptional*string = None #
The EC2 instance type of the master node.
placementoptionalEmrCreateCluster.PlacementTypePropertyplacementoptionalPlacementTypePropertyplacementoptionalPlacementTypePropertyPlacementoptionalPlacementTypePropertyPlacementoptionalPlacementTypeProperty #
The Availability Zone in which the cluster runs.

Default: EMR selected default

serviceAccessSecurityGroupoptionalstringservice_access_security_groupoptionalstrserviceAccessSecurityGroupoptionalStringServiceAccessSecurityGroupoptionalstringServiceAccessSecurityGroupoptional*string = None #
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
slaveInstanceTypeoptionalstringslave_instance_typeoptionalstrslaveInstanceTypeoptionalStringSlaveInstanceTypeoptionalstringSlaveInstanceTypeoptional*string = None #
The EC2 instance type of the core and task nodes.
terminationProtectedoptionalbooleantermination_protectedoptionalboolterminationProtectedoptionalBooleanTerminationProtectedoptionalboolTerminationProtectedoptional*bool = false #
Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.