CfnClusterProps Struct
Properties for defining a CfnCluster.
Example
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.
Properties
additionalInfooptionalanyadditional_infooptionalAnyadditionalInfooptionalObjectAdditionalInfooptionalobjectAdditionalInfooptionalinterface{}#applicationsoptionalIResolvable | IResolvable | CfnCluster.ApplicationProperty[]applicationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ApplicationProperty]]]applicationsoptionalIResolvableApplicationsoptionalIResolvableApplicationsoptionalinterface{}#autoScalingRoleoptionalstringauto_scaling_roleoptionalstrautoScalingRoleoptionalStringAutoScalingRoleoptionalstringAutoScalingRoleoptional*string#The default role is EMR_AutoScaling_DefaultRole . The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.
autoTerminationPolicyoptionalIResolvable | CfnCluster.AutoTerminationPolicyPropertyauto_termination_policyoptionaltyping.Union[IResolvable, AutoTerminationPolicyProperty]autoTerminationPolicyoptionalIResolvableAutoTerminationPolicyoptionalIResolvableAutoTerminationPolicyoptionalinterface{}#notes
An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination .
bootstrapActionsoptionalIResolvable | IResolvable | CfnCluster.BootstrapActionConfigProperty[]bootstrap_actionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BootstrapActionConfigProperty]]]bootstrapActionsoptionalIResolvableBootstrapActionsoptionalIResolvableBootstrapActionsoptionalinterface{}#configurationsoptionalIResolvable | IResolvable | CfnCluster.ConfigurationProperty[]configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ConfigurationProperty]]]configurationsoptionalIResolvableConfigurationsoptionalIResolvableConfigurationsoptionalinterface{}#customAmiIdoptionalstringcustom_ami_idoptionalstrcustomAmiIdoptionalStringCustomAmiIdoptionalstringCustomAmiIdoptional*string#ebsRootVolumeIopsoptionalnumberebs_root_volume_iopsoptionalint | floatebsRootVolumeIopsoptionalNumberEbsRootVolumeIopsoptionaldoubleEbsRootVolumeIopsoptional*float64#Available in Amazon EMR releases 6.15.0 and later.
ebsRootVolumeSizeoptionalnumberebs_root_volume_sizeoptionalint | floatebsRootVolumeSizeoptionalNumberEbsRootVolumeSizeoptionaldoubleEbsRootVolumeSizeoptional*float64#Available in Amazon EMR releases 4.x and later.
ebsRootVolumeThroughputoptionalnumberebs_root_volume_throughputoptionalint | floatebsRootVolumeThroughputoptionalNumberEbsRootVolumeThroughputoptionaldoubleEbsRootVolumeThroughputoptional*float64#Available in Amazon EMR releases 6.15.0 and later.
instancesIResolvable | CfnCluster.JobFlowInstancesConfigPropertyinstancestyping.Union[IResolvable, JobFlowInstancesConfigProperty]instancesIResolvableInstancesIResolvableInstancesinterface{}required#An IAM role for an Amazon EMR cluster. The Amazon 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 AWS CLI or console.
kerberosAttributesoptionalIResolvable | CfnCluster.KerberosAttributesPropertykerberos_attributesoptionaltyping.Union[IResolvable, KerberosAttributesProperty]kerberosAttributesoptionalIResolvableKerberosAttributesoptionalIResolvableKerberosAttributesoptionalinterface{}#For more information see Use Kerberos Authentication in the Amazon EMR Management Guide .
logEncryptionKmsKeyIdoptionalstringlog_encryption_kms_key_idoptionalstrlogEncryptionKmsKeyIdoptionalStringLogEncryptionKmsKeyIdoptionalstringLogEncryptionKmsKeyIdoptional*string#This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.
logUrioptionalstringlog_urioptionalstrlogUrioptionalStringLogUrioptionalstringLogUrioptional*string#managedScalingPolicyoptionalIResolvable | CfnCluster.ManagedScalingPolicyPropertymanaged_scaling_policyoptionaltyping.Union[IResolvable, ManagedScalingPolicyProperty]managedScalingPolicyoptionalIResolvableManagedScalingPolicyoptionalIResolvableManagedScalingPolicyoptionalinterface{}#notes
The managed scaling policy defines the limits for resources, such as Amazon 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.
This parameter can't contain the characters <, >, $, |, or ` (backtick).
osReleaseLabeloptionalstringos_release_labeloptionalstrosReleaseLabeloptionalStringOsReleaseLabeloptionalstringOsReleaseLabeloptional*string#If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.
placementGroupConfigsoptionalIResolvable | IResolvable | CfnCluster.PlacementGroupConfigProperty[]placement_group_configsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PlacementGroupConfigProperty]]]placementGroupConfigsoptionalIResolvablePlacementGroupConfigsoptionalIResolvablePlacementGroupConfigsoptionalinterface{}#releaseLabeloptionalstringrelease_labeloptionalstrreleaseLabeloptionalStringReleaseLabeloptionalstringReleaseLabeloptional*string#notes
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 .
scaleDownBehavioroptionalstringscale_down_behavioroptionalstrscaleDownBehavioroptionalStringScaleDownBehavioroptionalstringScaleDownBehavioroptional*string#notes
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 releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
securityConfigurationoptionalstringsecurity_configurationoptionalstrsecurityConfigurationoptionalStringSecurityConfigurationoptionalstringSecurityConfigurationoptional*string#stepConcurrencyLeveloptionalnumberstep_concurrency_leveloptionalint | floatstepConcurrencyLeveloptionalNumberStepConcurrencyLeveloptionaldoubleStepConcurrencyLeveloptional*float64#The default value is 1 . The maximum value is 256 .
stepsoptionalIResolvable | IResolvable | CfnCluster.StepConfigProperty[]stepsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, StepConfigProperty]]]stepsoptionalIResolvableStepsoptionalIResolvableStepsoptionalinterface{}#tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#visibleToAllUsersoptionalboolean | IResolvablevisible_to_all_usersoptionaltyping.Union[bool, IResolvable]visibleToAllUsersoptionalBooleanVisibleToAllUsersoptionalboolVisibleToAllUsersoptionalinterface{}#notes
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.