@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
date="2022-05-13T01:13:27.964Z")
public interface CfnClusterProps
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_;
CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
.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")
.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")
.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 | Interface and Description |
|---|---|
static class |
CfnClusterProps.Builder
A builder for
CfnClusterProps |
static class |
CfnClusterProps.Jsii$Proxy
An implementation for
CfnClusterProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnClusterProps.Builder |
builder() |
default java.lang.Object |
getAdditionalInfo()
A JSON string for selecting additional features.
|
default java.lang.Object |
getApplications()
The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.
|
default java.lang.String |
getAutoScalingRole()
An IAM role for automatic scaling policies.
|
default java.lang.Object |
getBootstrapActions()
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
|
default java.lang.Object |
getConfigurations()
Applies only to Amazon EMR releases 4.x and later.
|
default java.lang.String |
getCustomAmiId()
Available only in Amazon EMR version 5.7.0 and later.
|
default java.lang.Number |
getEbsRootVolumeSize()
The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance.
|
java.lang.Object |
getInstances()
A specification of the number and type of Amazon EC2 instances.
|
java.lang.String |
getJobFlowRole()
Also called instance profile and EC2 role.
|
default java.lang.Object |
getKerberosAttributes()
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
|
default java.lang.String |
getLogEncryptionKmsKeyId()
The AWS KMS key used for encrypting log files.
|
default java.lang.String |
getLogUri()
The path to the Amazon S3 location where logs for this cluster are stored.
|
default java.lang.Object |
getManagedScalingPolicy()
Creates or updates a managed scaling policy for an Amazon EMR cluster.
|
java.lang.String |
getName()
The name of the cluster.
|
default java.lang.String |
getReleaseLabel()
The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
|
default java.lang.String |
getScaleDownBehavior()
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
|
default java.lang.String |
getSecurityConfiguration()
The name of the security configuration applied to the cluster.
|
java.lang.String |
getServiceRole()
The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.
|
default java.lang.Number |
getStepConcurrencyLevel()
Specifies the number of steps that can be executed concurrently.
|
default java.lang.Object |
getSteps()
A list of steps to run.
|
default java.util.List<CfnTag> |
getTags()
A list of tags associated with a cluster.
|
default java.lang.Object |
getVisibleToAllUsers()
Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.
|
java.lang.Object getInstances()
java.lang.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.
java.lang.String getName()
java.lang.String getServiceRole()
default java.lang.Object getAdditionalInfo()
default java.lang.Object getApplications()
default java.lang.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.
default java.lang.Object getBootstrapActions()
default java.lang.Object getConfigurations()
default java.lang.String getCustomAmiId()
default java.lang.Number getEbsRootVolumeSize()
Available in Amazon EMR version 4.x and later.
default java.lang.Object getKerberosAttributes()
For more information see Use Kerberos Authentication in the Amazon EMR Management Guide .
default java.lang.String getLogEncryptionKmsKeyId()
This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.
default java.lang.String getLogUri()
default java.lang.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.
default java.lang.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 .
default java.lang.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.
default java.lang.String getSecurityConfiguration()
default java.lang.Number getStepConcurrencyLevel()
The default value is 1 . The maximum value is 256 .
default java.lang.Object getSteps()
default java.util.List<CfnTag> getTags()
default java.lang.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.
static CfnClusterProps.Builder builder()
CfnClusterProps.Builder of CfnClusterProps