Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
aws
GitHub Repository: aws/aws-cli
Path: blob/develop/awscli/customizations/emr/helptext.py
1567 views
1
# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
#
3
# Licensed under the Apache License, Version 2.0 (the "License"). You
4
# may not use this file except in compliance with the License. A copy of
5
# the License is located at
6
#
7
# http://aws.amazon.com/apache2.0/
8
#
9
# or in the "license" file accompanying this file. This file is
10
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
# ANY KIND, either express or implied. See the License for the specific
12
# language governing permissions and limitations under the License.
13
14
15
TERMINATE_CLUSTERS = (
16
'Shuts down one or more clusters, each specified by cluster ID. '
17
'Use this command only on clusters that do not have termination '
18
'protection enabled. Clusters with termination protection enabled '
19
'are not terminated. When a cluster is shut '
20
'down, any step not yet completed is canceled and the '
21
'Amazon EC2 instances in the cluster are terminated. '
22
'Any log files not already saved are uploaded to '
23
'Amazon S3 if a --log-uri was specified when the cluster was created. '
24
'The maximum number of clusters allowed in the list is 10. '
25
'The command is asynchronous. Depending on the '
26
'configuration of the cluster, it may take from 5 to 20 minutes for the '
27
'cluster to terminate completely and release allocated resources such as '
28
'Amazon EC2 instances.'
29
)
30
31
CLUSTER_ID = (
32
'<p>A unique string that identifies a cluster. The '
33
'<code>create-cluster</code> command returns this identifier. You can '
34
'use the <code>list-clusters</code> command to get cluster IDs.</p>'
35
)
36
37
HBASE_BACKUP_DIR = (
38
'<p>The Amazon S3 location of the Hbase backup. Example: '
39
'<code>s3://mybucket/mybackup</code>, where <code>mybucket</code> is the '
40
'specified Amazon S3 bucket and mybackup is the specified backup '
41
'location. The path argument must begin with s3://, which '
42
'refers to an Amazon S3 bucket.</p>'
43
)
44
45
HBASE_BACKUP_VERSION = (
46
'<p>The backup version to restore from. If not specified, the latest backup '
47
'in the specified location is used.</p>'
48
)
49
50
# create-cluster options help text
51
52
CREATE_CLUSTER_DESCRIPTION = (
53
'Creates an Amazon EMR cluster with the specified configurations.'
54
)
55
56
DESCRIBE_CLUSTER_DESCRIPTION = (
57
'Provides cluster-level details including status, hardware '
58
'and software configuration, VPC settings, bootstrap '
59
'actions, instance groups and so on. '
60
'Permissions needed for describe-cluster include '
61
'elasticmapreduce:ListBootstrapActions, '
62
'elasticmapreduce:ListInstanceFleets, '
63
'elasticmapreduce:DescribeCluster, '
64
'and elasticmapreduce:ListInstanceGroups.'
65
)
66
67
CLUSTER_NAME = '<p>The name of the cluster. If not provided, the default is "Development Cluster".</p>'
68
69
LOG_URI = (
70
'<p>Specifies the location in Amazon S3 to which log files '
71
'are periodically written. If a value is not provided, '
72
'logs files are not written to Amazon S3 from the master node '
73
'and are lost if the master node terminates.</p>'
74
)
75
76
LOG_ENCRYPTION_KMS_KEY_ID = (
77
'<p> Specifies the KMS Id utilized for log encryption. If a value is '
78
'not provided, log files will be encrypted by default encryption method '
79
'AES-256. This attribute is only available with EMR version 5.30.0 and later, '
80
'excluding EMR 6.0.0.</p>'
81
)
82
83
SERVICE_ROLE = (
84
'<p>Specifies an IAM service role, which Amazon EMR requires to call other AWS services '
85
'on your behalf during cluster operation. This parameter '
86
'is usually specified when a customized service role is used. '
87
'To specify the default service role, as well as the default instance '
88
'profile, use the <code>--use-default-roles</code> parameter. '
89
'If the role and instance profile do not already exist, use the '
90
'<code>aws emr create-default-roles</code> command to create them.</p>'
91
)
92
93
AUTOSCALING_ROLE = (
94
'<p>Specify <code>--auto-scaling-role EMR_AutoScaling_DefaultRole</code>'
95
' if an automatic scaling policy is specified for an instance group'
96
' using the <code>--instance-groups</code> parameter. This default'
97
' IAM role allows the automatic scaling feature'
98
' to launch and terminate Amazon EC2 instances during scaling operations.</p>'
99
)
100
101
USE_DEFAULT_ROLES = (
102
'<p>Specifies that the cluster should use the default'
103
' service role (EMR_DefaultRole) and instance profile (EMR_EC2_DefaultRole)'
104
' for permissions to access other AWS services.</p>'
105
'<p>Make sure that the role and instance profile exist first. To create them,'
106
' use the <code>create-default-roles</code> command.</p>'
107
)
108
109
AMI_VERSION = (
110
'<p>Applies only to Amazon EMR release versions earlier than 4.0. Use'
111
' <code>--release-label</code> for 4.0 and later. Specifies'
112
' the version of Amazon Linux Amazon Machine Image (AMI)'
113
' to use when launching Amazon EC2 instances in the cluster.'
114
' For example, <code>--ami-version 3.1.0</code>.'
115
)
116
117
RELEASE_LABEL = (
118
'<p>Specifies the Amazon EMR release version, which determines'
119
' the versions of application software that are installed on the cluster.'
120
' For example, <code>--release-label emr-5.15.0</code> installs'
121
' the application versions and features available in that version.'
122
' For details about application versions and features available'
123
' in each release, see the Amazon EMR Release Guide:</p>'
124
'<p>https://docs.aws.amazon.com/emr/latest/ReleaseGuide</p>'
125
'<p>Use <code>--release-label</code> only for Amazon EMR release version 4.0'
126
' and later. Use <code>--ami-version</code> for earlier versions.'
127
' You cannot specify both a release label and AMI version.</p>'
128
)
129
130
OS_RELEASE_LABEL = (
131
'<p>Specifies a particular Amazon Linux release for all nodes in a cluster'
132
' launch request. If a release is not specified, EMR uses the latest validated'
133
' Amazon Linux release for cluster launch.</p>'
134
)
135
136
CONFIGURATIONS = (
137
'<p>Specifies a JSON file that contains configuration classifications,'
138
' which you can use to customize applications that Amazon EMR installs'
139
' when cluster instances launch. Applies only to Amazon EMR 4.0 and later.'
140
' The file referenced can either be stored locally (for example,'
141
' <code>--configurations file://configurations.json</code>)'
142
' or stored in Amazon S3 (for example, <code>--configurations'
143
' https://s3.amazonaws.com/myBucket/configurations.json</code>).'
144
' Each classification usually corresponds to the xml configuration'
145
' file for an application, such as <code>yarn-site</code> for YARN. For a list of'
146
' available configuration classifications and example JSON, see'
147
' the following topic in the Amazon EMR Release Guide:</p>'
148
'<p>https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html</p>'
149
)
150
151
INSTANCE_GROUPS = (
152
'<p>Specifies the number and type of Amazon EC2 instances'
153
' to create for each node type in a cluster, using uniform instance groups.'
154
' You can specify either <code>--instance-groups</code> or'
155
' <code>--instance-fleets</code> but not both.'
156
' For more information, see the following topic in the EMR Management Guide:</p>'
157
'<p>https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html</p>'
158
'<p>You can specify arguments individually using multiple'
159
' <code>InstanceGroupType</code> argument blocks, one for the <code>MASTER</code>'
160
' instance group, one for a <code>CORE</code> instance group,'
161
' and optional, multiple <code>TASK</code> instance groups.</p>'
162
'<p>If you specify inline JSON structures, enclose the entire'
163
' <code>InstanceGroupType</code> argument block in single quotation marks.'
164
'<p>Each <code>InstanceGroupType</code> block takes the following inline arguments.'
165
' Optional arguments are shown in [square brackets].</p>'
166
'<li><code>[Name]</code> - An optional friendly name for the instance group.</li>'
167
'<li><code>InstanceGroupType</code> - <code>MASTER</code>, <code>CORE</code>, or <code>TASK</code>.</li>'
168
'<li><code>InstanceType</code> - The type of EC2 instance, for'
169
' example <code>m4.large</code>,'
170
' to use for all nodes in the instance group.</li>'
171
'<li><code>InstanceCount</code> - The number of EC2 instances to provision in the instance group.</li>'
172
'<li><code>[BidPrice]</code> - If specified, indicates that the instance group uses Spot Instances.'
173
' This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice'
174
' to set the amount equal to the On-Demand price, or specify an amount in USD.</li>'
175
'<li><code>[EbsConfiguration]</code> - Specifies additional Amazon EBS storage volumes attached'
176
' to EC2 instances using an inline JSON structure.</li>'
177
'<li><code>[AutoScalingPolicy]</code> - Specifies an automatic scaling policy for the'
178
' instance group using an inline JSON structure.</li>'
179
)
180
181
INSTANCE_FLEETS = (
182
'<p>Applies only to Amazon EMR release version 5.0 and later. Specifies'
183
' the number and type of Amazon EC2 instances to create'
184
' for each node type in a cluster, using instance fleets.'
185
' You can specify either <code>--instance-fleets</code> or'
186
' <code>--instance-groups</code> but not both.'
187
' For more information and examples, see the following topic in the Amazon EMR Management Guide:</p>'
188
'<p>https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-fleet.html</p>'
189
'<p>You can specify arguments individually using multiple'
190
' <code>InstanceFleetType</code> argument blocks, one for the <code>MASTER</code>'
191
' instance fleet, one for a <code>CORE</code> instance fleet,'
192
' and an optional <code>TASK</code> instance fleet.</p>'
193
'<p>The following arguments can be specified for each instance fleet. Optional arguments are shown in [square brackets].</p>'
194
'<li><code>[Name]</code> - An optional friendly name for the instance fleet.</li>'
195
'<li><code>InstanceFleetType</code> - <code>MASTER</code>, <code>CORE</code>, or <code>TASK</code>.</li>'
196
'<li><code>TargetOnDemandCapacity</code> - The target capacity of On-Demand units'
197
' for the instance fleet, which determines how many On-Demand Instances to provision.'
198
' The <code>WeightedCapacity</code> specified for an instance type within'
199
' <code>InstanceTypeConfigs</code> counts toward this total when an instance type'
200
' with the On-Demand purchasing option launches.</li>'
201
'<li><code>TargetSpotCapacity</code> - The target capacity of Spot units'
202
' for the instance fleet, which determines how many Spot Instances to provision.'
203
' The <code>WeightedCapacity</code> specified for an instance type within'
204
' <code>InstanceTypeConfigs</code> counts toward this total when an instance'
205
' type with the Spot purchasing option launches.</li>'
206
'<li><code>[LaunchSpecifications]</code> - When <code>TargetSpotCapacity</code> is specified,'
207
' specifies the block duration and timeout action for Spot Instances.'
208
'<li><code>InstanceTypeConfigs</code> - Specify up to five EC2 instance types to'
209
' use in the instance fleet, including details such as Spot price and Amazon EBS configuration.'
210
' When you use an On-Demand or Spot Instance allocation strategy,'
211
' you can specify up to 30 instance types per instance fleet.</li>'
212
)
213
214
INSTANCE_TYPE = (
215
'<p>Shortcut parameter as an alternative to <code>--instance-groups</code>.'
216
' Specifies the type of Amazon EC2 instance to use in a cluster.'
217
' If used without the <code>--instance-count</code> parameter,'
218
' the cluster consists of a single master node running on the EC2 instance type'
219
' specified. When used together with <code>--instance-count</code>,'
220
' one instance is used for the master node, and the remainder'
221
' are used for the core node type.</p>'
222
)
223
224
INSTANCE_COUNT = (
225
'<p>Shortcut parameter as an alternative to <code>--instance-groups</code>'
226
' when used together with <code>--instance-type</code>. Specifies the'
227
' number of Amazon EC2 instances to create for a cluster.'
228
' One instance is used for the master node, and the remainder'
229
' are used for the core node type.</p>'
230
)
231
232
ADDITIONAL_INFO = (
233
'<p>Specifies additional information during cluster creation. To set development mode when starting your EMR cluster,'
234
' set this parameter to <code>{"clusterType":"development"}</code>.</p>'
235
)
236
237
EC2_ATTRIBUTES = (
238
'<p>Configures cluster and Amazon EC2 instance configurations. Accepts'
239
' the following arguments:</p>'
240
'<li><code>KeyName</code> - Specifies the name of the AWS EC2 key pair that will be used for'
241
' SSH connections to the master node and other instances on the cluster.</li>'
242
'<li><code>AvailabilityZone</code> - Applies to clusters that use the uniform instance group configuration.'
243
' Specifies the availability zone in which to launch the cluster.'
244
' For example, <code>us-west-1b</code>. <code>AvailabilityZone</code> is used for uniform instance groups,'
245
' while <code>AvailabilityZones</code> (plural) is used for instance fleets.</li>'
246
'<li><code>AvailabilityZones</code> - Applies to clusters that use the instance fleet configuration.'
247
' When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances'
248
' in the optimal Availability Zone. <code>AvailabilityZone</code> is used for uniform instance groups,'
249
' while <code>AvailabilityZones</code> (plural) is used for instance fleets.</li>'
250
'<li><code>SubnetId</code> - Applies to clusters that use the uniform instance group configuration.'
251
' Specify the VPC subnet in which to create the cluster. <code>SubnetId</code> is used for uniform instance groups,'
252
' while <code>SubnetIds</code> (plural) is used for instance fleets.</li>'
253
'<li><code>SubnetIds</code> - Applies to clusters that use the instance fleet configuration.'
254
' When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.'
255
' <code>SubnetId</code> is used for uniform instance groups,'
256
' while <code>SubnetIds</code> (plural) is used for instance fleets.</li>'
257
'<li><code>InstanceProfile</code> - An IAM role that allows EC2 instances to'
258
' access other AWS services, such as Amazon S3, that'
259
' are required for operations.</li>'
260
'<li><code>EmrManagedMasterSecurityGroup</code> - The security group ID of the Amazon EC2'
261
' security group for the master node.</li>'
262
'<li><code>EmrManagedSlaveSecurityGroup</code> - The security group ID of the Amazon EC2'
263
' security group for the slave nodes.</li>'
264
'<li><code>ServiceAccessSecurityGroup</code> - The security group ID of the Amazon EC2 '
265
'security group for Amazon EMR access to clusters in VPC private subnets.</li>'
266
'<li><code>AdditionalMasterSecurityGroups</code> - A list of additional Amazon EC2'
267
' security group IDs for the master node.</li>'
268
'<li><code>AdditionalSlaveSecurityGroups</code> - A list of additional Amazon EC2'
269
' security group IDs for the slave nodes.</li>'
270
)
271
272
AUTO_TERMINATE = (
273
'<p>Specifies whether the cluster should terminate after'
274
' completing all the steps. Auto termination is off by default.</p>'
275
)
276
277
TERMINATION_PROTECTED = (
278
'<p>Specifies whether to lock the cluster to prevent the'
279
' Amazon EC2 instances from being terminated by API call,'
280
' user intervention, or an error.</p>'
281
)
282
283
SCALE_DOWN_BEHAVIOR = (
284
'<p>Specifies the way that individual Amazon EC2 instances terminate'
285
' when an automatic scale-in activity occurs or an instance group is resized.</p>'
286
'<p>Accepted values:</p>'
287
'<li><code>TERMINATE_AT_TASK_COMPLETION</code> - Specifies that Amazon EMR'
288
' blacklists and drains tasks from nodes before terminating the instance.</li>'
289
'<li><code>TERMINATE_AT_INSTANCE_HOUR</code> - Specifies that Amazon EMR'
290
' terminate EC2 instances at the instance-hour boundary, regardless of when'
291
' the request to terminate was submitted.</li>'
292
)
293
294
VISIBILITY = (
295
'<p>Specifies whether the cluster is visible to all IAM users'
296
' of the AWS account associated with the cluster. If a user'
297
' has the proper policy permissions set, they can also manage the cluster.</p>'
298
'<p>Visibility is on by default. The <code>--no-visible-to-all-users</code> option'
299
' is no longer supported. To restrict cluster visibility, use an IAM policy.</p>'
300
)
301
302
DEBUGGING = (
303
'<p>Specifies that the debugging tool is enabled for the cluster,'
304
' which allows you to browse log files using the Amazon EMR console.'
305
' Turning debugging on requires that you specify <code>--log-uri</code>'
306
' because log files must be stored in Amazon S3 so that'
307
' Amazon EMR can index them for viewing in the console.'
308
' Effective January 23, 2023, Amazon EMR will discontinue the debugging tool for all versions.</p>'
309
)
310
311
TAGS = (
312
'<p>A list of tags to associate with a cluster, which apply to'
313
' each Amazon EC2 instance in the cluster. Tags are key-value pairs that'
314
' consist of a required key string'
315
' with a maximum of 128 characters, and an optional value string'
316
' with a maximum of 256 characters.</p>'
317
'<p>You can specify tags in <code>key=value</code> format or you can add a'
318
' tag without a value using only the key name, for example <code>key</code>.'
319
' Use a space to separate multiple tags.</p>'
320
)
321
322
BOOTSTRAP_ACTIONS = (
323
'<p>Specifies a list of bootstrap actions to run on each EC2 instance when'
324
' a cluster is created. Bootstrap actions run on each instance'
325
' immediately after Amazon EMR provisions the EC2 instance and'
326
' before Amazon EMR installs specified applications.</p>'
327
'<p>You can specify a bootstrap action as an inline JSON structure'
328
' enclosed in single quotation marks, or you can use a shorthand'
329
' syntax, specifying multiple bootstrap actions, each separated'
330
' by a space. When using the shorthand syntax, each bootstrap'
331
' action takes the following parameters, separated by'
332
' commas with no trailing space. Optional parameters'
333
' are shown in [square brackets].</p>'
334
'<li><code>Path</code> - The path and file name of the script'
335
' to run, which must be accessible to each instance in the cluster.'
336
' For example, <code>Path=s3://mybucket/myscript.sh</code>.</li>'
337
'<li><code>[Name]</code> - A friendly name to help you identify'
338
' the bootstrap action. For example, <code>Name=BootstrapAction1</code></li>'
339
'<li><code>[Args]</code> - A comma-separated list of arguments'
340
' to pass to the bootstrap action script. Arguments can be'
341
' either a list of values (<code>Args=arg1,arg2,arg3</code>)'
342
' or a list of key-value pairs, as well as optional values,'
343
' enclosed in square brackets (<code>Args=[arg1,arg2=arg2value,arg3])</li>.'
344
)
345
346
APPLICATIONS = (
347
'<p>Specifies the applications to install on the cluster.'
348
' Available applications and their respective versions vary'
349
' by Amazon EMR release. For more information, see the'
350
' Amazon EMR Release Guide:</p>'
351
'<p>https://docs.aws.amazon.com/emr/latest/ReleaseGuide/</p>'
352
'<p>When using versions of Amazon EMR earlier than 4.0,'
353
' some applications take optional arguments for configuration.'
354
' Arguments should either be a comma-separated list of values'
355
' (<code>Args=arg1,arg2,arg3</code>) or a bracket-enclosed list of values'
356
' and key-value pairs (<code>Args=[arg1,arg2=arg3,arg4]</code>).</p>'
357
)
358
359
EMR_FS = (
360
'<p>Specifies EMRFS configuration options, such as consistent view'
361
' and Amazon S3 encryption parameters.</p>'
362
'<p>When you use Amazon EMR release version 4.8.0 or later, we recommend'
363
' that you use the <code>--configurations</code> option together'
364
' with the <code>emrfs-site</code> configuration classification'
365
' to configure EMRFS, and use security configurations'
366
' to configure encryption for EMRFS data in Amazon S3 instead.'
367
' For more information, see the following topic in the Amazon EMR Management Guide:</p>'
368
'<p>https://docs.aws.amazon.com/emr/latest/ManagementGuide/emrfs-configure-consistent-view.html</p>'
369
)
370
371
RESTORE_FROM_HBASE = (
372
'<p>Applies only when using Amazon EMR release versions earlier than 4.0.'
373
' Launches a new HBase cluster and populates it with'
374
' data from a previous backup of an HBase cluster. HBase'
375
' must be installed using the <code>--applications</code> option.</p>'
376
)
377
378
STEPS = (
379
'<p>Specifies a list of steps to be executed by the cluster. Steps run'
380
' only on the master node after applications are installed'
381
' and are used to submit work to a cluster. A step can be'
382
' specified using the shorthand syntax, by referencing a JSON file'
383
' or by specifying an inline JSON structure. <code>Args</code> supplied with steps'
384
' should be a comma-separated list of values (<code>Args=arg1,arg2,arg3</code>) or'
385
' a bracket-enclosed list of values and key-value'
386
' pairs (<code>Args=[arg1,arg2=value,arg4</code>).</p>'
387
)
388
389
INSTALL_APPLICATIONS = (
390
'<p>The applications to be installed.'
391
' Takes the following parameters: '
392
'<code>Name</code> and <code>Args</code>.</p>'
393
)
394
395
EBS_ROOT_VOLUME_SIZE = (
396
'<p>This option is available only with Amazon EMR version 4.x and later. Specifies the size,'
397
' in GiB, of the EBS root device volume of the Amazon Linux AMI'
398
' that is used for each EC2 instance in the cluster. </p>'
399
)
400
401
EBS_ROOT_VOLUME_IOPS = (
402
'<p>This option is available only with Amazon EMR version 6.15.0 and later. Specifies the IOPS,'
403
' of the EBS root device volume of the Amazon Linux AMI'
404
' that is used for each EC2 instance in the cluster. </p>'
405
)
406
407
EBS_ROOT_VOLUME_THROUGHPUT = (
408
'<p>This option is available only with Amazon EMR version 6.15.0 and later. Specifies the throughput,'
409
' in MiB/s, of the EBS root device volume of the Amazon Linux AMI'
410
' that is used for each EC2 instance in the cluster. </p>'
411
)
412
413
414
SECURITY_CONFIG = (
415
'<p>Specifies the name of a security configuration to use for the cluster.'
416
' A security configuration defines data encryption settings and'
417
' other security options. For more information, see'
418
' the following topic in the Amazon EMR Management Guide:</p>'
419
'<p>https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-encryption-enable-security-configuration.html</p>'
420
'<p>Use <code>list-security-configurations</code> to get a list of available'
421
' security configurations in the active account.</p>'
422
)
423
424
CUSTOM_AMI_ID = (
425
'<p>Applies only to Amazon EMR release version 5.7.0 and later.'
426
' Specifies the AMI ID of a custom AMI to use'
427
' when Amazon EMR provisions EC2 instances. A custom'
428
' AMI can be used to encrypt the Amazon EBS root volume. It'
429
' can also be used instead of bootstrap actions to customize'
430
' cluster node configurations. For more information, see'
431
' the following topic in the Amazon EMR Management Guide:</p>'
432
'<p>https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-custom-ami.html</p>'
433
)
434
435
REPO_UPGRADE_ON_BOOT = (
436
'<p>Applies only when a <code>--custom-ami-id</code> is'
437
' specified. On first boot, by default, Amazon Linux AMIs'
438
' connect to package repositories to install security updates'
439
' before other services start. You can set this parameter'
440
' using <code>--rep-upgrade-on-boot NONE</code> to'
441
' disable these updates. CAUTION: This creates additional'
442
' security risks.</p>'
443
)
444
445
KERBEROS_ATTRIBUTES = (
446
'<p>Specifies required cluster attributes for Kerberos when Kerberos authentication'
447
' is enabled in the specified <code>--security-configuration</code>.'
448
' Takes the following arguments:</p>'
449
' <li><code>Realm</code> - Specifies the name of the Kerberos'
450
' realm to which all nodes in a cluster belong. For example,'
451
' <code>Realm=EC2.INTERNAL</code>.</li>'
452
' <li><code>KdcAdminPassword</code> - Specifies the password used within the cluster'
453
' for the kadmin service, which maintains Kerberos principals, password'
454
' policies, and keytabs for the cluster.</li>'
455
' <li><code>CrossRealmTrustPrincipalPassword</code> - Required when establishing a cross-realm trust'
456
' with a KDC in a different realm. This is the cross-realm principal password,'
457
' which must be identical across realms.</li>'
458
' <li><code>ADDomainJoinUser</code> - Required when establishing trust with an Active Directory'
459
' domain. This is the User logon name of an AD account with sufficient privileges to join resources to the domain.</li>'
460
' <li><code>ADDomainJoinPassword</code> - The AD password for <code>ADDomainJoinUser</code>.</li>'
461
)
462
463
# end create-cluster options help descriptions
464
465
LIST_CLUSTERS_CLUSTER_STATES = (
466
'<p>Specifies that only clusters in the states specified are'
467
' listed. Alternatively, you can use the shorthand'
468
' form for single states or a group of states.</p>'
469
'<p>Takes the following state values:</p>'
470
'<li><code>STARTING</code></li>'
471
'<li><code>BOOTSTRAPPING</code></li>'
472
'<li><code>RUNNING</code></li>'
473
'<li><code>WAITING</code></li>'
474
'<li><code>TERMINATING</code></li>'
475
'<li><code>TERMINATED</code></li>'
476
'<li><code>TERMINATED_WITH_ERRORS</code></li>'
477
)
478
479
LIST_CLUSTERS_STATE_FILTERS = (
480
'<p>Shortcut options for --cluster-states. The'
481
' following shortcut options can be specified:</p>'
482
'<li><code>--active</code> - list only clusters that'
483
' are <code>STARTING</code>,<code>BOOTSTRAPPING</code>,'
484
' <code>RUNNING</code>, <code>WAITING</code>, or <code>TERMINATING</code>. </li>'
485
'<li><code>--terminated</code> - list only clusters that are <code>TERMINATED</code>. </li>'
486
'<li><code>--failed</code> - list only clusters that are <code>TERMINATED_WITH_ERRORS</code>.</li>'
487
)
488
489
LIST_CLUSTERS_CREATED_AFTER = (
490
'<p>List only those clusters created after the date and time'
491
' specified in the format yyyy-mm-ddThh:mm:ss. For example,'
492
' <code>--created-after 2017-07-04T00:01:30.</p>'
493
)
494
495
LIST_CLUSTERS_CREATED_BEFORE = (
496
'<p>List only those clusters created before the date and time'
497
' specified in the format yyyy-mm-ddThh:mm:ss. For example,'
498
' <code>--created-before 2017-07-04T00:01:30.</p>'
499
)
500
501
EMR_MANAGED_MASTER_SECURITY_GROUP = (
502
'<p>The identifier of the Amazon EC2 security group '
503
'for the master node.</p>'
504
)
505
506
EMR_MANAGED_SLAVE_SECURITY_GROUP = (
507
'<p>The identifier of the Amazon EC2 security group '
508
'for the slave nodes.</p>'
509
)
510
511
SERVICE_ACCESS_SECURITY_GROUP = (
512
'<p>The identifier of the Amazon EC2 security group '
513
'for Amazon EMR to access clusters in VPC private subnets.</p>'
514
)
515
516
ADDITIONAL_MASTER_SECURITY_GROUPS = (
517
'<p> A list of additional Amazon EC2 security group IDs for '
518
'the master node</p>'
519
)
520
521
ADDITIONAL_SLAVE_SECURITY_GROUPS = (
522
'<p>A list of additional Amazon EC2 security group IDs for '
523
'the slave nodes.</p>'
524
)
525
526
AVAILABLE_ONLY_FOR_AMI_VERSIONS = (
527
'This command is only available when using Amazon EMR versions'
528
'earlier than 4.0.'
529
)
530
531
STEP_CONCURRENCY_LEVEL = (
532
'This command specifies the step concurrency level of the cluster.'
533
'Default is 1 which is non-concurrent.'
534
)
535
536
MANAGED_SCALING_POLICY = (
537
'<p>Managed scaling policy for an Amazon EMR cluster. The policy '
538
'specifies the limits for resources that can be added or terminated '
539
'from a cluster. You can specify the ComputeLimits which include '
540
'the MaximumCapacityUnits, MaximumCoreCapacityUnits, MinimumCapacityUnits, '
541
'MaximumOnDemandCapacityUnits and UnitType. For an '
542
'InstanceFleet cluster, the UnitType must be InstanceFleetUnits. For '
543
'InstanceGroup clusters, the UnitType can be either VCPU or Instances.</p>'
544
)
545
546
PLACEMENT_GROUP_CONFIGS = (
547
'<p>Placement group configuration for an Amazon EMR '
548
'cluster. The configuration specifies the EC2 placement group '
549
'strategy associated with each EMR Instance Role.</p> '
550
'<p>Currently, we support placement group only for <code>MASTER</code> '
551
'role with <code>SPREAD</code> strategy by default. You can opt-in by '
552
'passing <code>--placement-group-configs InstanceRole=MASTER</code> '
553
'during cluster creation.</p>'
554
)
555
556
AUTO_TERMINATION_POLICY = (
557
'<p>Auto termination policy for an Amazon EMR cluster. '
558
'The configuration specifies the termination idle timeout'
559
'threshold for an cluster.</p> '
560
)
561
562
EXECUTION_ROLE_ARN = (
563
'<p>You must grant the execution role the permissions needed '
564
'to access the same IAM resources that the step can access. '
565
'The execution role can be a cross-account IAM Role.</p> '
566
)
567
568
UNHEALTHY_NODE_REPLACEMENT = (
569
'<p>Unhealthy node replacement for an Amazon EMR cluster.</p> '
570
)
571
572
EXTENDED_SUPPORT = '<p>Reserved.</p> '
573
574