@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:39.175Z") @Stability(value=Stable) public class CfnCluster extends CfnResource implements IInspectable
The 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:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.emr.*;
Object additionalInfo;
ConfigurationProperty configurationProperty_;
CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
.instances(JobFlowInstancesConfigProperty.builder()
.additionalMasterSecurityGroups(List.of("additionalMasterSecurityGroups"))
.additionalSlaveSecurityGroups(List.of("additionalSlaveSecurityGroups"))
.coreInstanceFleet(InstanceFleetConfigProperty.builder()
.instanceTypeConfigs(List.of(InstanceTypeConfigProperty.builder()
.instanceType("instanceType")
// the properties below are optional
.bidPrice("bidPrice")
.bidPriceAsPercentageOfOnDemandPrice(123)
.configurations(List.of(ConfigurationProperty.builder()
.classification("classification")
.configurationProperties(Map.of(
"configurationPropertiesKey", "configurationProperties"))
.configurations(List.of(configurationProperty_))
.build()))
.customAmiId("customAmiId")
.ebsConfiguration(EbsConfigurationProperty.builder()
.ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
.volumeSpecification(VolumeSpecificationProperty.builder()
.sizeInGb(123)
.volumeType("volumeType")
// the properties below are optional
.iops(123)
.build())
// the properties below are optional
.volumesPerInstance(123)
.build()))
.ebsOptimized(false)
.build())
.weightedCapacity(123)
.build()))
.launchSpecifications(InstanceFleetProvisioningSpecificationsProperty.builder()
.onDemandSpecification(OnDemandProvisioningSpecificationProperty.builder()
.allocationStrategy("allocationStrategy")
.build())
.spotSpecification(SpotProvisioningSpecificationProperty.builder()
.timeoutAction("timeoutAction")
.timeoutDurationMinutes(123)
// the properties below are optional
.allocationStrategy("allocationStrategy")
.blockDurationMinutes(123)
.build())
.build())
.name("name")
.targetOnDemandCapacity(123)
.targetSpotCapacity(123)
.build())
.coreInstanceGroup(InstanceGroupConfigProperty.builder()
.instanceCount(123)
.instanceType("instanceType")
// the properties below are optional
.autoScalingPolicy(AutoScalingPolicyProperty.builder()
.constraints(ScalingConstraintsProperty.builder()
.maxCapacity(123)
.minCapacity(123)
.build())
.rules(List.of(ScalingRuleProperty.builder()
.action(ScalingActionProperty.builder()
.simpleScalingPolicyConfiguration(SimpleScalingPolicyConfigurationProperty.builder()
.scalingAdjustment(123)
// the properties below are optional
.adjustmentType("adjustmentType")
.coolDown(123)
.build())
// the properties below are optional
.market("market")
.build())
.name("name")
.trigger(ScalingTriggerProperty.builder()
.cloudWatchAlarmDefinition(CloudWatchAlarmDefinitionProperty.builder()
.comparisonOperator("comparisonOperator")
.metricName("metricName")
.period(123)
.threshold(123)
// the properties below are optional
.dimensions(List.of(MetricDimensionProperty.builder()
.key("key")
.value("value")
.build()))
.evaluationPeriods(123)
.namespace("namespace")
.statistic("statistic")
.unit("unit")
.build())
.build())
// the properties below are optional
.description("description")
.build()))
.build())
.bidPrice("bidPrice")
.configurations(List.of(ConfigurationProperty.builder()
.classification("classification")
.configurationProperties(Map.of(
"configurationPropertiesKey", "configurationProperties"))
.configurations(List.of(configurationProperty_))
.build()))
.customAmiId("customAmiId")
.ebsConfiguration(EbsConfigurationProperty.builder()
.ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
.volumeSpecification(VolumeSpecificationProperty.builder()
.sizeInGb(123)
.volumeType("volumeType")
// the properties below are optional
.iops(123)
.build())
// the properties below are optional
.volumesPerInstance(123)
.build()))
.ebsOptimized(false)
.build())
.market("market")
.name("name")
.build())
.ec2KeyName("ec2KeyName")
.ec2SubnetId("ec2SubnetId")
.ec2SubnetIds(List.of("ec2SubnetIds"))
.emrManagedMasterSecurityGroup("emrManagedMasterSecurityGroup")
.emrManagedSlaveSecurityGroup("emrManagedSlaveSecurityGroup")
.hadoopVersion("hadoopVersion")
.keepJobFlowAliveWhenNoSteps(false)
.masterInstanceFleet(InstanceFleetConfigProperty.builder()
.instanceTypeConfigs(List.of(InstanceTypeConfigProperty.builder()
.instanceType("instanceType")
// the properties below are optional
.bidPrice("bidPrice")
.bidPriceAsPercentageOfOnDemandPrice(123)
.configurations(List.of(ConfigurationProperty.builder()
.classification("classification")
.configurationProperties(Map.of(
"configurationPropertiesKey", "configurationProperties"))
.configurations(List.of(configurationProperty_))
.build()))
.customAmiId("customAmiId")
.ebsConfiguration(EbsConfigurationProperty.builder()
.ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
.volumeSpecification(VolumeSpecificationProperty.builder()
.sizeInGb(123)
.volumeType("volumeType")
// the properties below are optional
.iops(123)
.build())
// the properties below are optional
.volumesPerInstance(123)
.build()))
.ebsOptimized(false)
.build())
.weightedCapacity(123)
.build()))
.launchSpecifications(InstanceFleetProvisioningSpecificationsProperty.builder()
.onDemandSpecification(OnDemandProvisioningSpecificationProperty.builder()
.allocationStrategy("allocationStrategy")
.build())
.spotSpecification(SpotProvisioningSpecificationProperty.builder()
.timeoutAction("timeoutAction")
.timeoutDurationMinutes(123)
// the properties below are optional
.allocationStrategy("allocationStrategy")
.blockDurationMinutes(123)
.build())
.build())
.name("name")
.targetOnDemandCapacity(123)
.targetSpotCapacity(123)
.build())
.masterInstanceGroup(InstanceGroupConfigProperty.builder()
.instanceCount(123)
.instanceType("instanceType")
// the properties below are optional
.autoScalingPolicy(AutoScalingPolicyProperty.builder()
.constraints(ScalingConstraintsProperty.builder()
.maxCapacity(123)
.minCapacity(123)
.build())
.rules(List.of(ScalingRuleProperty.builder()
.action(ScalingActionProperty.builder()
.simpleScalingPolicyConfiguration(SimpleScalingPolicyConfigurationProperty.builder()
.scalingAdjustment(123)
// the properties below are optional
.adjustmentType("adjustmentType")
.coolDown(123)
.build())
// the properties below are optional
.market("market")
.build())
.name("name")
.trigger(ScalingTriggerProperty.builder()
.cloudWatchAlarmDefinition(CloudWatchAlarmDefinitionProperty.builder()
.comparisonOperator("comparisonOperator")
.metricName("metricName")
.period(123)
.threshold(123)
// the properties below are optional
.dimensions(List.of(MetricDimensionProperty.builder()
.key("key")
.value("value")
.build()))
.evaluationPeriods(123)
.namespace("namespace")
.statistic("statistic")
.unit("unit")
.build())
.build())
// the properties below are optional
.description("description")
.build()))
.build())
.bidPrice("bidPrice")
.configurations(List.of(ConfigurationProperty.builder()
.classification("classification")
.configurationProperties(Map.of(
"configurationPropertiesKey", "configurationProperties"))
.configurations(List.of(configurationProperty_))
.build()))
.customAmiId("customAmiId")
.ebsConfiguration(EbsConfigurationProperty.builder()
.ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
.volumeSpecification(VolumeSpecificationProperty.builder()
.sizeInGb(123)
.volumeType("volumeType")
// the properties below are optional
.iops(123)
.build())
// the properties below are optional
.volumesPerInstance(123)
.build()))
.ebsOptimized(false)
.build())
.market("market")
.name("name")
.build())
.placement(PlacementTypeProperty.builder()
.availabilityZone("availabilityZone")
.build())
.serviceAccessSecurityGroup("serviceAccessSecurityGroup")
.taskInstanceFleets(List.of(InstanceFleetConfigProperty.builder()
.instanceTypeConfigs(List.of(InstanceTypeConfigProperty.builder()
.instanceType("instanceType")
// the properties below are optional
.bidPrice("bidPrice")
.bidPriceAsPercentageOfOnDemandPrice(123)
.configurations(List.of(ConfigurationProperty.builder()
.classification("classification")
.configurationProperties(Map.of(
"configurationPropertiesKey", "configurationProperties"))
.configurations(List.of(configurationProperty_))
.build()))
.customAmiId("customAmiId")
.ebsConfiguration(EbsConfigurationProperty.builder()
.ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
.volumeSpecification(VolumeSpecificationProperty.builder()
.sizeInGb(123)
.volumeType("volumeType")
// the properties below are optional
.iops(123)
.build())
// the properties below are optional
.volumesPerInstance(123)
.build()))
.ebsOptimized(false)
.build())
.weightedCapacity(123)
.build()))
.launchSpecifications(InstanceFleetProvisioningSpecificationsProperty.builder()
.onDemandSpecification(OnDemandProvisioningSpecificationProperty.builder()
.allocationStrategy("allocationStrategy")
.build())
.spotSpecification(SpotProvisioningSpecificationProperty.builder()
.timeoutAction("timeoutAction")
.timeoutDurationMinutes(123)
// the properties below are optional
.allocationStrategy("allocationStrategy")
.blockDurationMinutes(123)
.build())
.build())
.name("name")
.targetOnDemandCapacity(123)
.targetSpotCapacity(123)
.build()))
.taskInstanceGroups(List.of(InstanceGroupConfigProperty.builder()
.instanceCount(123)
.instanceType("instanceType")
// the properties below are optional
.autoScalingPolicy(AutoScalingPolicyProperty.builder()
.constraints(ScalingConstraintsProperty.builder()
.maxCapacity(123)
.minCapacity(123)
.build())
.rules(List.of(ScalingRuleProperty.builder()
.action(ScalingActionProperty.builder()
.simpleScalingPolicyConfiguration(SimpleScalingPolicyConfigurationProperty.builder()
.scalingAdjustment(123)
// the properties below are optional
.adjustmentType("adjustmentType")
.coolDown(123)
.build())
// the properties below are optional
.market("market")
.build())
.name("name")
.trigger(ScalingTriggerProperty.builder()
.cloudWatchAlarmDefinition(CloudWatchAlarmDefinitionProperty.builder()
.comparisonOperator("comparisonOperator")
.metricName("metricName")
.period(123)
.threshold(123)
// the properties below are optional
.dimensions(List.of(MetricDimensionProperty.builder()
.key("key")
.value("value")
.build()))
.evaluationPeriods(123)
.namespace("namespace")
.statistic("statistic")
.unit("unit")
.build())
.build())
// the properties below are optional
.description("description")
.build()))
.build())
.bidPrice("bidPrice")
.configurations(List.of(ConfigurationProperty.builder()
.classification("classification")
.configurationProperties(Map.of(
"configurationPropertiesKey", "configurationProperties"))
.configurations(List.of(configurationProperty_))
.build()))
.customAmiId("customAmiId")
.ebsConfiguration(EbsConfigurationProperty.builder()
.ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
.volumeSpecification(VolumeSpecificationProperty.builder()
.sizeInGb(123)
.volumeType("volumeType")
// the properties below are optional
.iops(123)
.build())
// the properties below are optional
.volumesPerInstance(123)
.build()))
.ebsOptimized(false)
.build())
.market("market")
.name("name")
.build()))
.terminationProtected(false)
.build())
.jobFlowRole("jobFlowRole")
.name("name")
.serviceRole("serviceRole")
// the properties below are optional
.additionalInfo(additionalInfo)
.applications(List.of(ApplicationProperty.builder()
.additionalInfo(Map.of(
"additionalInfoKey", "additionalInfo"))
.args(List.of("args"))
.name("name")
.version("version")
.build()))
.autoScalingRole("autoScalingRole")
.autoTerminationPolicy(AutoTerminationPolicyProperty.builder()
.idleTimeout(123)
.build())
.bootstrapActions(List.of(BootstrapActionConfigProperty.builder()
.name("name")
.scriptBootstrapAction(ScriptBootstrapActionConfigProperty.builder()
.path("path")
// the properties below are optional
.args(List.of("args"))
.build())
.build()))
.configurations(List.of(ConfigurationProperty.builder()
.classification("classification")
.configurationProperties(Map.of(
"configurationPropertiesKey", "configurationProperties"))
.configurations(List.of(configurationProperty_))
.build()))
.customAmiId("customAmiId")
.ebsRootVolumeSize(123)
.kerberosAttributes(KerberosAttributesProperty.builder()
.kdcAdminPassword("kdcAdminPassword")
.realm("realm")
// the properties below are optional
.adDomainJoinPassword("adDomainJoinPassword")
.adDomainJoinUser("adDomainJoinUser")
.crossRealmTrustPrincipalPassword("crossRealmTrustPrincipalPassword")
.build())
.logEncryptionKmsKeyId("logEncryptionKmsKeyId")
.logUri("logUri")
.managedScalingPolicy(ManagedScalingPolicyProperty.builder()
.computeLimits(ComputeLimitsProperty.builder()
.maximumCapacityUnits(123)
.minimumCapacityUnits(123)
.unitType("unitType")
// the properties below are optional
.maximumCoreCapacityUnits(123)
.maximumOnDemandCapacityUnits(123)
.build())
.build())
.releaseLabel("releaseLabel")
.scaleDownBehavior("scaleDownBehavior")
.securityConfiguration("securityConfiguration")
.stepConcurrencyLevel(123)
.steps(List.of(StepConfigProperty.builder()
.hadoopJarStep(HadoopJarStepConfigProperty.builder()
.jar("jar")
// the properties below are optional
.args(List.of("args"))
.mainClass("mainClass")
.stepProperties(List.of(KeyValueProperty.builder()
.key("key")
.value("value")
.build()))
.build())
.name("name")
// the properties below are optional
.actionOnFailure("actionOnFailure")
.build()))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.visibleToAllUsers(false)
.build();
| Modifier and Type | Class and Description |
|---|---|
static interface |
CfnCluster.ApplicationProperty
`Application` is a property of `AWS::EMR::Cluster` .
|
static interface |
CfnCluster.AutoScalingPolicyProperty
`AutoScalingPolicy` is a subproperty of `InstanceGroupConfig` .
|
static interface |
CfnCluster.AutoTerminationPolicyProperty
Example:
|
static interface |
CfnCluster.BootstrapActionConfigProperty
`BootstrapActionConfig` is a property of `AWS::EMR::Cluster` that can be used to run bootstrap actions on EMR clusters.
|
static class |
CfnCluster.Builder
A fluent builder for
CfnCluster. |
static interface |
CfnCluster.CloudWatchAlarmDefinitionProperty
`CloudWatchAlarmDefinition` is a subproperty of the `ScalingTrigger` property, which determines when to trigger an automatic scaling activity.
|
static interface |
CfnCluster.ComputeLimitsProperty
The EC2 unit limits for a managed scaling policy.
|
static interface |
CfnCluster.ConfigurationProperty
> Used only with Amazon EMR release 4.0 and later.
|
static interface |
CfnCluster.EbsBlockDeviceConfigProperty
`EbsBlockDeviceConfig` is a subproperty of the `EbsConfiguration` property type.
|
static interface |
CfnCluster.EbsConfigurationProperty
`EbsConfiguration` is a subproperty of `InstanceFleetConfig` or `InstanceGroupConfig` .
|
static interface |
CfnCluster.HadoopJarStepConfigProperty
The `HadoopJarStepConfig` property type specifies a job flow step consisting of a JAR file whose main function will be executed.
|
static interface |
CfnCluster.InstanceFleetConfigProperty
Use `InstanceFleetConfig` to define instance fleets for an EMR cluster.
|
static interface |
CfnCluster.InstanceFleetProvisioningSpecificationsProperty
`InstanceFleetProvisioningSpecification` is a subproperty of `InstanceFleetConfig` .
|
static interface |
CfnCluster.InstanceGroupConfigProperty
Use `InstanceGroupConfig` to define instance groups for an EMR cluster.
|
static interface |
CfnCluster.InstanceTypeConfigProperty
> The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
|
static interface |
CfnCluster.JobFlowInstancesConfigProperty
`JobFlowInstancesConfig` is a property of the `AWS::EMR::Cluster` resource.
|
static interface |
CfnCluster.KerberosAttributesProperty
`KerberosAttributes` is a property of the `AWS::EMR::Cluster` resource.
|
static interface |
CfnCluster.KeyValueProperty
`KeyValue` is a subproperty of the `HadoopJarStepConfig` property type.
|
static interface |
CfnCluster.ManagedScalingPolicyProperty
Managed scaling policy for an Amazon EMR cluster.
|
static interface |
CfnCluster.MetricDimensionProperty
`MetricDimension` is a subproperty of the `CloudWatchAlarmDefinition` property type.
|
static interface |
CfnCluster.OnDemandProvisioningSpecificationProperty
The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
|
static interface |
CfnCluster.PlacementTypeProperty
`PlacementType` is a property of the `AWS::EMR::Cluster` resource.
|
static interface |
CfnCluster.ScalingActionProperty
`ScalingAction` is a subproperty of the `ScalingRule` property type.
|
static interface |
CfnCluster.ScalingConstraintsProperty
`ScalingConstraints` is a subproperty of the `AutoScalingPolicy` property type.
|
static interface |
CfnCluster.ScalingRuleProperty
`ScalingRule` is a subproperty of the `AutoScalingPolicy` property type.
|
static interface |
CfnCluster.ScalingTriggerProperty
`ScalingTrigger` is a subproperty of the `ScalingRule` property type.
|
static interface |
CfnCluster.ScriptBootstrapActionConfigProperty
`ScriptBootstrapActionConfig` is a subproperty of the `BootstrapActionConfig` property type.
|
static interface |
CfnCluster.SimpleScalingPolicyConfigurationProperty
`SimpleScalingPolicyConfiguration` is a subproperty of the `ScalingAction` property type.
|
static interface |
CfnCluster.SpotProvisioningSpecificationProperty
`SpotProvisioningSpecification` is a subproperty of the `InstanceFleetProvisioningSpecifications` property type.
|
static interface |
CfnCluster.StepConfigProperty
`StepConfig` is a property of the `AWS::EMR::Cluster` resource.
|
static interface |
CfnCluster.VolumeSpecificationProperty
`VolumeSpecification` is a subproperty of the `EbsBlockDeviceConfig` property type.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnCluster(software.constructs.Construct scope,
String id,
CfnClusterProps props)
Create a new `AWS::EMR::Cluster`.
|
protected |
CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnCluster(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
Object |
getAdditionalInfo()
A JSON string for selecting additional features.
|
Object |
getApplications()
The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.
|
String |
getAttrMasterPublicDns()
The public DNS name of the master node (instance), such as `ec2-12-123-123-123.us-west-2.compute.amazonaws.com` .
|
String |
getAutoScalingRole()
An IAM role for automatic scaling policies.
|
Object |
getAutoTerminationPolicy()
`AWS::EMR::Cluster.AutoTerminationPolicy`.
|
Object |
getBootstrapActions()
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getConfigurations()
Applies only to Amazon EMR releases 4.x and later.
|
String |
getCustomAmiId()
Available only in Amazon EMR version 5.7.0 and later.
|
Number |
getEbsRootVolumeSize()
The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance.
|
Object |
getInstances()
A specification of the number and type of Amazon EC2 instances.
|
String |
getJobFlowRole()
Also called instance profile and EC2 role.
|
Object |
getKerberosAttributes()
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
|
String |
getLogEncryptionKmsKeyId()
The AWS KMS key used for encrypting log files.
|
String |
getLogUri()
The path to the Amazon S3 location where logs for this cluster are stored.
|
Object |
getManagedScalingPolicy()
Creates or updates a managed scaling policy for an Amazon EMR cluster.
|
String |
getName()
The name of the cluster.
|
String |
getReleaseLabel()
The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
|
String |
getScaleDownBehavior()
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
|
String |
getSecurityConfiguration()
The name of the security configuration applied to the cluster.
|
String |
getServiceRole()
The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.
|
Number |
getStepConcurrencyLevel()
Specifies the number of steps that can be executed concurrently.
|
Object |
getSteps()
A list of steps to run.
|
TagManager |
getTags()
A list of tags associated with a cluster.
|
Object |
getVisibleToAllUsers()
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.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAdditionalInfo(Object value)
A JSON string for selecting additional features.
|
void |
setApplications(IResolvable value)
The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.
|
void |
setApplications(List<Object> 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 |
setAutoTerminationPolicy(CfnCluster.AutoTerminationPolicyProperty value)
`AWS::EMR::Cluster.AutoTerminationPolicy`.
|
void |
setAutoTerminationPolicy(IResolvable value)
`AWS::EMR::Cluster.AutoTerminationPolicy`.
|
void |
setBootstrapActions(IResolvable value)
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
|
void |
setBootstrapActions(List<Object> value)
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
|
void |
setConfigurations(IResolvable value)
Applies only to Amazon EMR releases 4.x and later.
|
void |
setConfigurations(List<Object> value)
Applies only to Amazon EMR releases 4.x and later.
|
void |
setCustomAmiId(String value)
Available only in Amazon EMR version 5.7.0 and later.
|
void |
setEbsRootVolumeSize(Number value)
The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance.
|
void |
setInstances(CfnCluster.JobFlowInstancesConfigProperty value)
A specification of the number and type of Amazon EC2 instances.
|
void |
setInstances(IResolvable value)
A specification of the number and type of Amazon EC2 instances.
|
void |
setJobFlowRole(String value)
Also called instance profile and EC2 role.
|
void |
setKerberosAttributes(CfnCluster.KerberosAttributesProperty value)
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
|
void |
setKerberosAttributes(IResolvable value)
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 |
setLogUri(String value)
The path to the Amazon S3 location where logs for this cluster are stored.
|
void |
setManagedScalingPolicy(CfnCluster.ManagedScalingPolicyProperty value)
Creates or updates a managed scaling policy for an Amazon EMR cluster.
|
void |
setManagedScalingPolicy(IResolvable value)
Creates or updates a managed scaling policy for an Amazon EMR cluster.
|
void |
setName(String value)
The name of the cluster.
|
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 |
setSteps(IResolvable value)
A list of steps to run.
|
void |
setSteps(List<Object> value)
A list of steps to run.
|
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnCluster(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnClusterProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrMasterPublicDns()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
@Stability(value=Stable) @NotNull public Object getAdditionalInfo()
@Stability(value=Stable)
public void setAdditionalInfo(@NotNull
Object value)
@Stability(value=Stable) @NotNull public Object getInstances()
@Stability(value=Stable)
public void setInstances(@NotNull
CfnCluster.JobFlowInstancesConfigProperty value)
@Stability(value=Stable)
public void setInstances(@NotNull
IResolvable value)
@Stability(value=Stable) @NotNull public String getJobFlowRole()
An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole . In order to use the default role, you must have already created it using the CLI or console.
@Stability(value=Stable)
public void setJobFlowRole(@NotNull
String value)
An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole . In order to use the default role, you must have already created it using the CLI or console.
@Stability(value=Stable) @NotNull public String getName()
@Stability(value=Stable)
public void setName(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getServiceRole()
@Stability(value=Stable)
public void setServiceRole(@NotNull
String value)
@Stability(value=Stable) @Nullable public Object getApplications()
@Stability(value=Stable)
public void setApplications(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setApplications(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public String getAutoScalingRole()
The default role is EMR_AutoScaling_DefaultRole . The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.
@Stability(value=Stable)
public void setAutoScalingRole(@Nullable
String value)
The default role is EMR_AutoScaling_DefaultRole . The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.
@Stability(value=Stable) @Nullable public Object getAutoTerminationPolicy()
@Stability(value=Stable)
public void setAutoTerminationPolicy(@Nullable
CfnCluster.AutoTerminationPolicyProperty value)
@Stability(value=Stable)
public void setAutoTerminationPolicy(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getBootstrapActions()
@Stability(value=Stable)
public void setBootstrapActions(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setBootstrapActions(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public Object getConfigurations()
@Stability(value=Stable)
public void setConfigurations(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setConfigurations(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public String getCustomAmiId()
@Stability(value=Stable)
public void setCustomAmiId(@Nullable
String value)
@Stability(value=Stable) @Nullable public Number getEbsRootVolumeSize()
Available in Amazon EMR version 4.x and later.
@Stability(value=Stable)
public void setEbsRootVolumeSize(@Nullable
Number value)
Available in Amazon EMR version 4.x and later.
@Stability(value=Stable) @Nullable public Object getKerberosAttributes()
For more information see Use Kerberos Authentication in the Amazon EMR Management Guide .
@Stability(value=Stable)
public void setKerberosAttributes(@Nullable
CfnCluster.KerberosAttributesProperty value)
For more information see Use Kerberos Authentication in the Amazon EMR Management Guide .
@Stability(value=Stable)
public void setKerberosAttributes(@Nullable
IResolvable value)
For more information see Use Kerberos Authentication in the Amazon EMR Management Guide .
@Stability(value=Stable) @Nullable public String getLogEncryptionKmsKeyId()
This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.
@Stability(value=Stable)
public void setLogEncryptionKmsKeyId(@Nullable
String value)
This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.
@Stability(value=Stable) @Nullable public String getLogUri()
@Stability(value=Stable)
public void setLogUri(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getManagedScalingPolicy()
The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
@Stability(value=Stable)
public void setManagedScalingPolicy(@Nullable
CfnCluster.ManagedScalingPolicyProperty value)
The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
@Stability(value=Stable)
public void setManagedScalingPolicy(@Nullable
IResolvable value)
The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
@Stability(value=Stable) @Nullable public String getReleaseLabel()
Release labels are in the form emr-x.x.x , where x.x.x is an Amazon EMR release version such as emr-5.14.0 . For more information about Amazon EMR release versions and included application versions and features, see . The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion .
@Stability(value=Stable)
public void setReleaseLabel(@Nullable
String value)
Release labels are in the form emr-x.x.x , where x.x.x is an Amazon EMR release version such as emr-5.14.0 . For more information about Amazon EMR release versions and included application versions and features, see . The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion .
@Stability(value=Stable) @Nullable public String getScaleDownBehavior()
TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
@Stability(value=Stable)
public void setScaleDownBehavior(@Nullable
String value)
TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
@Stability(value=Stable) @Nullable public String getSecurityConfiguration()
@Stability(value=Stable)
public void setSecurityConfiguration(@Nullable
String value)
@Stability(value=Stable) @Nullable public Number getStepConcurrencyLevel()
The default value is 1 . The maximum value is 256 .
@Stability(value=Stable)
public void setStepConcurrencyLevel(@Nullable
Number value)
The default value is 1 . The maximum value is 256 .
@Stability(value=Stable) @Nullable public Object getSteps()
@Stability(value=Stable)
public void setSteps(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setSteps(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public Object getVisibleToAllUsers()
If this value is set to true , all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false , only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
When you create clusters directly through the EMR console or API, this value is set to
trueby default. However, forAWS::EMR::Clusterresources in CloudFormation, the default isfalse.
@Stability(value=Stable)
public void setVisibleToAllUsers(@Nullable
Boolean value)
If this value is set to true , all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false , only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
When you create clusters directly through the EMR console or API, this value is set to
trueby default. However, forAWS::EMR::Clusterresources in CloudFormation, the default isfalse.
@Stability(value=Stable)
public void setVisibleToAllUsers(@Nullable
IResolvable value)
If this value is set to true , all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false , only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
When you create clusters directly through the EMR console or API, this value is set to
trueby default. However, forAWS::EMR::Clusterresources in CloudFormation, the default isfalse.
Copyright © 2022. All rights reserved.