Class CfnCluster
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
AWS::EMR::Cluster
resource specifies an Amazon EMR cluster.
This cluster is a collection of Amazon EC2 instances that run open source big data frameworks and applications to process and analyze vast amounts of data. For more information, see the Amazon EMR Management Guide .
Amazon EMR now supports launching task instance groups and task instance fleets as part of the AWS::EMR::Cluster
resource. This can be done by using the JobFlowInstancesConfig
property type's TaskInstanceGroups
and TaskInstanceFleets
subproperties. Using these subproperties reduces delays in provisioning task nodes compared to specifying task nodes with the AWS::EMR::InstanceGroupConfig
and AWS::EMR::InstanceFleetConfig
resources. Please refer to the examples at the bottom of this page to learn how to use these subproperties.
Example:
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Application
is a property ofAWS::EMR::Cluster
.static interface
AutoScalingPolicy
is a subproperty ofInstanceGroupConfig
.static interface
An auto-termination policy for an Amazon EMR cluster.static interface
BootstrapActionConfig
is a property ofAWS::EMR::Cluster
that can be used to run bootstrap actions on EMR clusters.static final class
A fluent builder forCfnCluster
.static interface
CloudWatchAlarmDefinition
is a subproperty of theScalingTrigger
property, which determines when to trigger an automatic scaling activity.static interface
The Amazon EC2 unit limits for a managed scaling policy.static interface
static interface
EbsBlockDeviceConfig
is a subproperty of theEbsConfiguration
property type.static interface
EbsConfiguration
is a subproperty ofInstanceFleetConfig
orInstanceGroupConfig
.static interface
TheHadoopJarStepConfig
property type specifies a job flow step consisting of a JAR file whose main function will be executed.static interface
UseInstanceFleetConfig
to define instance fleets for an EMR cluster.static interface
InstanceFleetProvisioningSpecification
is a subproperty ofInstanceFleetConfig
.static interface
The resize specification for On-Demand and Spot Instances in the fleet.static interface
UseInstanceGroupConfig
to define instance groups for an EMR cluster.static interface
static interface
JobFlowInstancesConfig
is a property of theAWS::EMR::Cluster
resource.static interface
KerberosAttributes
is a property of theAWS::EMR::Cluster
resource.static interface
KeyValue
is a subproperty of theHadoopJarStepConfig
property type.static interface
Managed scaling policy for an Amazon EMR cluster.static interface
MetricDimension
is a subproperty of theCloudWatchAlarmDefinition
property type.static interface
Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.static interface
The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.static interface
The resize specification for On-Demand Instances in the instance fleet, which contains the resize timeout period.static interface
Placement group configuration for an Amazon EMR cluster.static interface
PlacementType
is a property of theAWS::EMR::Cluster
resource.static interface
ScalingAction
is a subproperty of theScalingRule
property type.static interface
ScalingConstraints
is a subproperty of theAutoScalingPolicy
property type.static interface
ScalingRule
is a subproperty of theAutoScalingPolicy
property type.static interface
ScalingTrigger
is a subproperty of theScalingRule
property type.static interface
ScriptBootstrapActionConfig
is a subproperty of theBootstrapActionConfig
property type.static interface
SimpleScalingPolicyConfiguration
is a subproperty of theScalingAction
property type.static interface
SpotProvisioningSpecification
is a subproperty of theInstanceFleetProvisioningSpecifications
property type.static interface
The resize specification for Spot Instances in the instance fleet, which contains the resize timeout period.static interface
StepConfig
is a property of theAWS::EMR::Cluster
resource.static interface
VolumeSpecification
is a subproperty of theEbsBlockDeviceConfig
property type.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnCluster
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnCluster
(software.amazon.jsii.JsiiObjectRef objRef) CfnCluster
(software.constructs.Construct scope, String id, CfnClusterProps props) -
Method Summary
Modifier and TypeMethodDescriptionA JSON string for selecting additional features.The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.The unique identifier for the cluster.The public DNS name of the master node (instance), such asec2-12-123-123-123.us-west-2.compute.amazonaws.com
.An IAM role for automatic scaling policies.An auto-termination policy for an Amazon EMR cluster.A list of bootstrap actions to run before Hadoop starts on the cluster nodes.Applies only to Amazon EMR releases 4.x and later.Available only in Amazon EMR releases 5.7.0 and later.The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.A specification of the number and type of Amazon EC2 instances.Also called instance profile and Amazon EC2 role.Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.The AWS KMS key used for encrypting log files.The path to the Amazon S3 location where logs for this cluster are stored.Creates or updates a managed scaling policy for an Amazon EMR cluster.getName()
The name of the cluster.The Amazon Linux release specified in a cluster launch RunJobFlow request.The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.The name of the security configuration applied to the cluster.The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.Specifies the number of steps that can be executed concurrently.getSteps()
A list of steps to run.getTags()
Tag Manager which manages the tags for this resource.A list of tags associated with a cluster.Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAdditionalInfo
(Object value) A JSON string for selecting additional features.void
setApplications
(List<Object> value) The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.void
setApplications
(IResolvable value) The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.void
setAutoScalingRole
(String value) An IAM role for automatic scaling policies.void
An auto-termination policy for an Amazon EMR cluster.void
An auto-termination policy for an Amazon EMR cluster.void
setBootstrapActions
(List<Object> value) A list of bootstrap actions to run before Hadoop starts on the cluster nodes.void
setBootstrapActions
(IResolvable value) A list of bootstrap actions to run before Hadoop starts on the cluster nodes.void
setConfigurations
(List<Object> value) Applies only to Amazon EMR releases 4.x and later.void
setConfigurations
(IResolvable value) Applies only to Amazon EMR releases 4.x and later.void
setCustomAmiId
(String value) Available only in Amazon EMR releases 5.7.0 and later.void
setEbsRootVolumeIops
(Number value) The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.void
setEbsRootVolumeSize
(Number value) The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.void
setEbsRootVolumeThroughput
(Number value) The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.void
setInstances
(IResolvable value) A specification of the number and type of Amazon EC2 instances.void
A specification of the number and type of Amazon EC2 instances.void
setJobFlowRole
(String value) Also called instance profile and Amazon EC2 role.void
setKerberosAttributes
(IResolvable value) Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.void
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.void
setLogEncryptionKmsKeyId
(String value) The AWS KMS key used for encrypting log files.void
The path to the Amazon S3 location where logs for this cluster are stored.void
Creates or updates a managed scaling policy for an Amazon EMR cluster.void
Creates or updates a managed scaling policy for an Amazon EMR cluster.void
The name of the cluster.void
setOsReleaseLabel
(String value) The Amazon Linux release specified in a cluster launch RunJobFlow request.void
setPlacementGroupConfigs
(List<Object> value) void
void
setReleaseLabel
(String value) The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.void
setScaleDownBehavior
(String value) The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.void
setSecurityConfiguration
(String value) The name of the security configuration applied to the cluster.void
setServiceRole
(String value) The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.void
setStepConcurrencyLevel
(Number value) Specifies the number of steps that can be executed concurrently.void
A list of steps to run.void
setSteps
(IResolvable value) A list of steps to run.void
setTagsRaw
(List<CfnTag> value) A list of tags associated with a cluster.void
setVisibleToAllUsers
(Boolean value) Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.void
setVisibleToAllUsers
(IResolvable value) Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnCluster
protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef) -
CfnCluster
protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnCluster
@Stability(Stable) public CfnCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnClusterProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The unique identifier for the cluster. -
getAttrMasterPublicDns
The public DNS name of the master node (instance), such asec2-12-123-123-123.us-west-2.compute.amazonaws.com
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getInstances
A specification of the number and type of Amazon EC2 instances. -
setInstances
A specification of the number and type of Amazon EC2 instances. -
setInstances
@Stability(Stable) public void setInstances(@NotNull CfnCluster.JobFlowInstancesConfigProperty value) A specification of the number and type of Amazon EC2 instances. -
getJobFlowRole
Also called instance profile and Amazon EC2 role. -
setJobFlowRole
Also called instance profile and Amazon EC2 role. -
getName
The name of the cluster. -
setName
The name of the cluster. -
getServiceRole
The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf. -
setServiceRole
The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf. -
getAdditionalInfo
A JSON string for selecting additional features. -
setAdditionalInfo
A JSON string for selecting additional features. -
getApplications
The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on. -
setApplications
The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on. -
setApplications
The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on. -
getAutoScalingRole
An IAM role for automatic scaling policies. -
setAutoScalingRole
An IAM role for automatic scaling policies. -
getAutoTerminationPolicy
An auto-termination policy for an Amazon EMR cluster. -
setAutoTerminationPolicy
An auto-termination policy for an Amazon EMR cluster. -
setAutoTerminationPolicy
@Stability(Stable) public void setAutoTerminationPolicy(@Nullable CfnCluster.AutoTerminationPolicyProperty value) An auto-termination policy for an Amazon EMR cluster. -
getBootstrapActions
A list of bootstrap actions to run before Hadoop starts on the cluster nodes. -
setBootstrapActions
A list of bootstrap actions to run before Hadoop starts on the cluster nodes. -
setBootstrapActions
A list of bootstrap actions to run before Hadoop starts on the cluster nodes. -
getConfigurations
Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster. -
setConfigurations
Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster. -
setConfigurations
Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster. -
getCustomAmiId
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI. -
setCustomAmiId
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI. -
getEbsRootVolumeIops
The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. -
setEbsRootVolumeIops
The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. -
getEbsRootVolumeSize
The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. -
setEbsRootVolumeSize
The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. -
getEbsRootVolumeThroughput
The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. -
setEbsRootVolumeThroughput
The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. -
getKerberosAttributes
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. -
setKerberosAttributes
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. -
setKerberosAttributes
@Stability(Stable) public void setKerberosAttributes(@Nullable CfnCluster.KerberosAttributesProperty value) Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. -
getLogEncryptionKmsKeyId
The AWS KMS key used for encrypting log files. -
setLogEncryptionKmsKeyId
The AWS KMS key used for encrypting log files. -
getLogUri
The path to the Amazon S3 location where logs for this cluster are stored. -
setLogUri
The path to the Amazon S3 location where logs for this cluster are stored. -
getManagedScalingPolicy
Creates or updates a managed scaling policy for an Amazon EMR cluster. -
setManagedScalingPolicy
Creates or updates a managed scaling policy for an Amazon EMR cluster. -
setManagedScalingPolicy
@Stability(Stable) public void setManagedScalingPolicy(@Nullable CfnCluster.ManagedScalingPolicyProperty value) Creates or updates a managed scaling policy for an Amazon EMR cluster. -
getOsReleaseLabel
The Amazon Linux release specified in a cluster launch RunJobFlow request. -
setOsReleaseLabel
The Amazon Linux release specified in a cluster launch RunJobFlow request. -
getPlacementGroupConfigs
-
setPlacementGroupConfigs
-
setPlacementGroupConfigs
-
getReleaseLabel
The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. -
setReleaseLabel
The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. -
getScaleDownBehavior
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. -
setScaleDownBehavior
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. -
getSecurityConfiguration
The name of the security configuration applied to the cluster. -
setSecurityConfiguration
The name of the security configuration applied to the cluster. -
getStepConcurrencyLevel
Specifies the number of steps that can be executed concurrently. -
setStepConcurrencyLevel
Specifies the number of steps that can be executed concurrently. -
getSteps
A list of steps to run. -
setSteps
A list of steps to run. -
setSteps
A list of steps to run. -
getTagsRaw
A list of tags associated with a cluster. -
setTagsRaw
A list of tags associated with a cluster. -
getVisibleToAllUsers
Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. -
setVisibleToAllUsers
Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. -
setVisibleToAllUsers
Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.
-