ClusterArgs class
The set of arguments for Cluster. The set of arguments for Cluster.
Constructors
-
ClusterArgs({Input<
String?> ? additionalInfo, Input<List< ? applications, Input<String> ?>ClusterAutoTerminationPolicy?> ? autoTerminationPolicy, Input<String?> ? autoscalingRole, Input<List< ? bootstrapActions, Input<ClusterBootstrapAction> ?>String?> ? configurations, Input<String?> ? configurationsJson, Input<ClusterCoreInstanceFleet?> ? coreInstanceFleet, Input<ClusterCoreInstanceGroup?> ? coreInstanceGroup, Input<String?> ? customAmiId, Input<int?> ? ebsRootVolumeSize, Input<ClusterEc2Attributes?> ? ec2Attributes, Input<bool?> ? keepJobFlowAliveWhenNoSteps, Input<ClusterKerberosAttributes?> ? kerberosAttributes, Input<List< ? listStepsStates, Input<String> ?>String?> ? logEncryptionKmsKeyId, Input<String?> ? logUri, Input<ClusterMasterInstanceFleet?> ? masterInstanceFleet, Input<ClusterMasterInstanceGroup?> ? masterInstanceGroup, Input<String?> ? name, Input<String?> ? osReleaseLabel, Input<List< ? placementGroupConfigs, Input<ClusterPlacementGroupConfig> ?>String?> ? region, required Input<String> releaseLabel, Input<String?> ? scaleDownBehavior, Input<String?> ? securityConfiguration, required Input<String> serviceRole, Input<int?> ? stepConcurrencyLevel, Input<List< ? steps, Input<ClusterStep> ?>Map< ? tags, Input<String, String> ?>bool?> ? terminationProtection, Input<bool?> ? unhealthyNodeReplacement, Input<bool?> ? visibleToAllUsers}) -
Creates a new ClusterArgs.
additionalInfoJSON string for selecting additional features such as adding proxy information. Note: Currently there is no API to retrieve the value of this argument after EMR cluster creation from provider, therefore the provider cannot detect drift from the actual EMR cluster if its value is changed outside the provider.applicationsA case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMR Release Guide.autoTerminationPolicyAn auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. See Auto Termination Policy Below.autoscalingRoleIAM role for automatic scaling policies. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.bootstrapActionsOrdered list of bootstrap actions that will be run before Hadoop is started on the cluster nodes. See below.configurationsList of configurations supplied for the EMR cluster you are creating. Supply a configuration object for applications to override their default configuration. See AWS Documentation for more information.configurationsJsonJSON string for supplying list of configurations for the EMR cluster.coreInstanceFleetConfiguration block to use an Instance Fleet for the core node type. Cannot be specified if anycoreInstanceGroupconfiguration blocks are set. Detailed below.coreInstanceGroupConfiguration block to use an Instance Group for the core node type.customAmiIdCustom Amazon Linux AMI for the cluster (instead of an EMR-owned AMI). Available in Amazon EMR version 5.7.0 and later.ebsRootVolumeSizeSize in GiB of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.ec2AttributesAttributes for the EC2 instances running the job flow. See below.keepJobFlowAliveWhenNoStepsSwitch on/off run cluster with no steps or when all steps are complete (default is on)kerberosAttributesKerberos configuration for the cluster. See below.listStepsStatesList of step states used to filter returned stepslogEncryptionKmsKeyIdAWS KMS customer master key (CMK) key ID or arn used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.logUriS3 bucket to write the log files of the job flow. If a value is not provided, logs are not created.masterInstanceFleetConfiguration block to use an Instance Fleet for the master node type. Cannot be specified if anymasterInstanceGroupconfiguration blocks are set. Detailed below.masterInstanceGroupConfiguration block to use an Instance Group for the master node type.nameName of the job flow.osReleaseLabelAmazon Linux release for all nodes in a cluster launch RunJobFlow request. If not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.placementGroupConfigsThe specified placement group configuration for an Amazon EMR cluster.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.releaseLabelRelease label for the Amazon EMR release.scaleDownBehaviorWay that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or aninstance groupis resized.securityConfigurationSecurity configuration name to attach to the EMR cluster. Only valid for EMR clusters withreleaseLabel4.8.0 or greater.serviceRoleIAM role that will be assumed by the Amazon EMR service to access AWS resources.stepConcurrencyLevelNumber of steps that can be executed concurrently. You can specify a maximum of 256 steps. Only valid for EMR clusters withreleaseLabel5.28.0 or greater (default is 1).stepsList of steps to run when creating the cluster. See below. It is highly recommended to utilize the lifecycle resource options block withignoreChangesif other steps are being managed outside of this provider.tagslist of tags to apply to the EMR Cluster. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.terminationProtectionSwitch on/off termination protection (default isfalse, except when using multiple master nodes). Before attempting to destroy the resource when termination protection is enabled, this configuration must be applied with its value set tofalse.unhealthyNodeReplacementWhether whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster. Default value isfalse.visibleToAllUsersWhether the job flow is visible to all IAM users of the AWS account associated with the job flow. Default value istrue.const -
ClusterArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
additionalInfo
→ Input<
String?> ? -
JSON string for selecting additional features such as adding proxy information. Note: Currently there is no API to retrieve the value of this argument after EMR cluster creation from provider, therefore the provider cannot detect drift from the actual EMR cluster if its value is changed outside the provider.
final
-
applications
→ Input<
List< ?String> ?> -
A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMR Release Guide.
final
-
autoscalingRole
→ Input<
String?> ? -
IAM role for automatic scaling policies. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.
final
-
autoTerminationPolicy
→ Input<
ClusterAutoTerminationPolicy?> ? -
An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. See Auto Termination Policy Below.
final
-
bootstrapActions
→ Input<
List< ?ClusterBootstrapAction> ?> -
Ordered list of bootstrap actions that will be run before Hadoop is started on the cluster nodes. See below.
final
-
configurations
→ Input<
String?> ? -
List of configurations supplied for the EMR cluster you are creating. Supply a configuration object for applications to override their default configuration. See AWS Documentation for more information.
final
-
configurationsJson
→ Input<
String?> ? -
JSON string for supplying list of configurations for the EMR cluster.
final
-
coreInstanceFleet
→ Input<
ClusterCoreInstanceFleet?> ? -
Configuration block to use an Instance Fleet for the core node type. Cannot be specified if any
coreInstanceGroupconfiguration blocks are set. Detailed below.final -
coreInstanceGroup
→ Input<
ClusterCoreInstanceGroup?> ? -
Configuration block to use an Instance Group for the core node type.
final
-
customAmiId
→ Input<
String?> ? -
Custom Amazon Linux AMI for the cluster (instead of an EMR-owned AMI). Available in Amazon EMR version 5.7.0 and later.
final
-
ebsRootVolumeSize
→ Input<
int?> ? -
Size in GiB of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.
final
-
ec2Attributes
→ Input<
ClusterEc2Attributes?> ? -
Attributes for the EC2 instances running the job flow. See below.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
keepJobFlowAliveWhenNoSteps
→ Input<
bool?> ? -
Switch on/off run cluster with no steps or when all steps are complete (default is on)
final
-
kerberosAttributes
→ Input<
ClusterKerberosAttributes?> ? -
Kerberos configuration for the cluster. See below.
final
-
listStepsStates
→ Input<
List< ?String> ?> -
List of step states used to filter returned steps
final
-
logEncryptionKmsKeyId
→ Input<
String?> ? -
AWS KMS customer master key (CMK) key ID or arn used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.
final
-
logUri
→ Input<
String?> ? -
S3 bucket to write the log files of the job flow. If a value is not provided, logs are not created.
final
-
masterInstanceFleet
→ Input<
ClusterMasterInstanceFleet?> ? -
Configuration block to use an Instance Fleet for the master node type. Cannot be specified if any
masterInstanceGroupconfiguration blocks are set. Detailed below.final -
masterInstanceGroup
→ Input<
ClusterMasterInstanceGroup?> ? -
Configuration block to use an Instance Group for the master node type.
final
-
name
→ Input<
String?> ? -
Name of the job flow.
final
-
osReleaseLabel
→ Input<
String?> ? -
Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.
final
-
placementGroupConfigs
→ Input<
List< ?ClusterPlacementGroupConfig> ?> -
The specified placement group configuration for an Amazon EMR cluster.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
releaseLabel
→ Input<
String> -
Release label for the Amazon EMR release.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scaleDownBehavior
→ Input<
String?> ? -
Way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an
instance groupis resized.final -
securityConfiguration
→ Input<
String?> ? -
Security configuration name to attach to the EMR cluster. Only valid for EMR clusters with
releaseLabel4.8.0 or greater.final -
serviceRole
→ Input<
String> -
IAM role that will be assumed by the Amazon EMR service to access AWS resources.
final
-
stepConcurrencyLevel
→ Input<
int?> ? -
Number of steps that can be executed concurrently. You can specify a maximum of 256 steps. Only valid for EMR clusters with
releaseLabel5.28.0 or greater (default is 1).final -
steps
→ Input<
List< ?ClusterStep> ?> -
List of steps to run when creating the cluster. See below. It is highly recommended to utilize the lifecycle resource options block with
ignoreChangesif other steps are being managed outside of this provider.final -
list of tags to apply to the EMR Cluster. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
terminationProtection
→ Input<
bool?> ? -
Switch on/off termination protection (default is
false, except when using multiple master nodes). Before attempting to destroy the resource when termination protection is enabled, this configuration must be applied with its value set tofalse.final -
unhealthyNodeReplacement
→ Input<
bool?> ? -
Whether whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster. Default value is
false.final -
visibleToAllUsers
→ Input<
bool?> ? -
Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. Default value is
true.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited