Class CfnCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-10-31T19:12:58.261Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable, ITaggable
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:

 

See Also:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      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 class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier for the cluster.
    • getAttrMasterPublicDns

      @Stability(Stable) @NotNull public String getAttrMasterPublicDns()
      The public DNS name of the master node (instance), such as ec2-12-123-123-123.us-west-2.compute.amazonaws.com .
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable
    • getInstances

      @Stability(Stable) @NotNull public Object getInstances()
      A specification of the number and type of Amazon EC2 instances.
    • setInstances

      @Stability(Stable) public void setInstances(@NotNull IResolvable value)
      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

      @Stability(Stable) @NotNull public String getJobFlowRole()
      Also called instance profile and Amazon EC2 role.
    • setJobFlowRole

      @Stability(Stable) public void setJobFlowRole(@NotNull String value)
      Also called instance profile and Amazon EC2 role.
    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the cluster.
    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the cluster.
    • getServiceRole

      @Stability(Stable) @NotNull public String getServiceRole()
      The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.
    • setServiceRole

      @Stability(Stable) public void setServiceRole(@NotNull String value)
      The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.
    • getAdditionalInfo

      @Stability(Stable) @Nullable public Object getAdditionalInfo()
      A JSON string for selecting additional features.
    • setAdditionalInfo

      @Stability(Stable) public void setAdditionalInfo(@Nullable Object value)
      A JSON string for selecting additional features.
    • getApplications

      @Stability(Stable) @Nullable public Object getApplications()
      The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.
    • setApplications

      @Stability(Stable) public void setApplications(@Nullable IResolvable value)
      The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.
    • setApplications

      @Stability(Stable) public void setApplications(@Nullable List<Object> value)
      The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.
    • getAutoScalingRole

      @Stability(Stable) @Nullable public String getAutoScalingRole()
      An IAM role for automatic scaling policies.
    • setAutoScalingRole

      @Stability(Stable) public void setAutoScalingRole(@Nullable String value)
      An IAM role for automatic scaling policies.
    • getAutoTerminationPolicy

      @Stability(Stable) @Nullable public Object getAutoTerminationPolicy()
      An auto-termination policy for an Amazon EMR cluster.
    • setAutoTerminationPolicy

      @Stability(Stable) public void setAutoTerminationPolicy(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public Object getBootstrapActions()
      A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
    • setBootstrapActions

      @Stability(Stable) public void setBootstrapActions(@Nullable IResolvable value)
      A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
    • setBootstrapActions

      @Stability(Stable) public void setBootstrapActions(@Nullable List<Object> value)
      A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
    • getConfigurations

      @Stability(Stable) @Nullable public Object getConfigurations()
      Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.
    • setConfigurations

      @Stability(Stable) public void setConfigurations(@Nullable IResolvable value)
      Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.
    • setConfigurations

      @Stability(Stable) public void setConfigurations(@Nullable List<Object> value)
      Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.
    • getCustomAmiId

      @Stability(Stable) @Nullable public String 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

      @Stability(Stable) public void setCustomAmiId(@Nullable String value)
      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

      @Stability(Stable) @Nullable public Number getEbsRootVolumeIops()
      The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.
    • setEbsRootVolumeIops

      @Stability(Stable) public void setEbsRootVolumeIops(@Nullable Number value)
      The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.
    • getEbsRootVolumeSize

      @Stability(Stable) @Nullable public Number 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

      @Stability(Stable) public void setEbsRootVolumeSize(@Nullable 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.
    • getEbsRootVolumeThroughput

      @Stability(Stable) @Nullable public Number 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

      @Stability(Stable) public void setEbsRootVolumeThroughput(@Nullable 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.
    • getKerberosAttributes

      @Stability(Stable) @Nullable public Object getKerberosAttributes()
      Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
    • setKerberosAttributes

      @Stability(Stable) public void setKerberosAttributes(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public String getLogEncryptionKmsKeyId()
      The AWS KMS key used for encrypting log files.
    • setLogEncryptionKmsKeyId

      @Stability(Stable) public void setLogEncryptionKmsKeyId(@Nullable String value)
      The AWS KMS key used for encrypting log files.
    • getLogUri

      @Stability(Stable) @Nullable public String getLogUri()
      The path to the Amazon S3 location where logs for this cluster are stored.
    • setLogUri

      @Stability(Stable) public void setLogUri(@Nullable String value)
      The path to the Amazon S3 location where logs for this cluster are stored.
    • getManagedScalingPolicy

      @Stability(Stable) @Nullable public Object getManagedScalingPolicy()
      Creates or updates a managed scaling policy for an Amazon EMR cluster.
    • setManagedScalingPolicy

      @Stability(Stable) public void setManagedScalingPolicy(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public String getOsReleaseLabel()
      The Amazon Linux release specified in a cluster launch RunJobFlow request.
    • setOsReleaseLabel

      @Stability(Stable) public void setOsReleaseLabel(@Nullable String value)
      The Amazon Linux release specified in a cluster launch RunJobFlow request.
    • getPlacementGroupConfigs

      @Stability(Stable) @Nullable public Object getPlacementGroupConfigs()
    • setPlacementGroupConfigs

      @Stability(Stable) public void setPlacementGroupConfigs(@Nullable IResolvable value)
    • setPlacementGroupConfigs

      @Stability(Stable) public void setPlacementGroupConfigs(@Nullable List<Object> value)
    • getReleaseLabel

      @Stability(Stable) @Nullable public String getReleaseLabel()
      The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
    • setReleaseLabel

      @Stability(Stable) public void setReleaseLabel(@Nullable String value)
      The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
    • getScaleDownBehavior

      @Stability(Stable) @Nullable public String getScaleDownBehavior()
      The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
    • setScaleDownBehavior

      @Stability(Stable) public void setScaleDownBehavior(@Nullable String value)
      The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
    • getSecurityConfiguration

      @Stability(Stable) @Nullable public String getSecurityConfiguration()
      The name of the security configuration applied to the cluster.
    • setSecurityConfiguration

      @Stability(Stable) public void setSecurityConfiguration(@Nullable String value)
      The name of the security configuration applied to the cluster.
    • getStepConcurrencyLevel

      @Stability(Stable) @Nullable public Number getStepConcurrencyLevel()
      Specifies the number of steps that can be executed concurrently.
    • setStepConcurrencyLevel

      @Stability(Stable) public void setStepConcurrencyLevel(@Nullable Number value)
      Specifies the number of steps that can be executed concurrently.
    • getSteps

      @Stability(Stable) @Nullable public Object getSteps()
      A list of steps to run.
    • setSteps

      @Stability(Stable) public void setSteps(@Nullable IResolvable value)
      A list of steps to run.
    • setSteps

      @Stability(Stable) public void setSteps(@Nullable List<Object> value)
      A list of steps to run.
    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of tags associated with a cluster.
    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of tags associated with a cluster.
    • getVisibleToAllUsers

      @Stability(Stable) @Nullable public Object getVisibleToAllUsers()
      Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.
    • setVisibleToAllUsers

      @Stability(Stable) public void setVisibleToAllUsers(@Nullable Boolean value)
      Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.
    • setVisibleToAllUsers

      @Stability(Stable) public void setVisibleToAllUsers(@Nullable IResolvable value)
      Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.