aws-sdk-batch 1.149.0 → 1.151.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch/client.rb +443 -10
- data/lib/aws-sdk-batch/client_api.rb +70 -0
- data/lib/aws-sdk-batch/types.rb +453 -18
- data/lib/aws-sdk-batch.rb +1 -1
- data/sig/client.rbs +68 -6
- data/sig/params.rbs +2 -1
- data/sig/types.rbs +87 -7
- metadata +1 -1
data/lib/aws-sdk-batch/types.rb
CHANGED
|
@@ -313,6 +313,35 @@ module Aws::Batch
|
|
|
313
313
|
include Aws::Structure
|
|
314
314
|
end
|
|
315
315
|
|
|
316
|
+
# The capacity reservation configuration for Amazon ECS Managed
|
|
317
|
+
# Instances. Use this to target On-Demand Capacity Reservations or
|
|
318
|
+
# Reserved Instances.
|
|
319
|
+
#
|
|
320
|
+
# @!attribute [rw] reservation_group_arn
|
|
321
|
+
# The Amazon Resource Name (ARN) of the capacity reservation group to
|
|
322
|
+
# target.
|
|
323
|
+
# @return [String]
|
|
324
|
+
#
|
|
325
|
+
# @!attribute [rw] reservation_preference
|
|
326
|
+
# The capacity reservation preference. Valid values:
|
|
327
|
+
#
|
|
328
|
+
# * `RESERVATIONS_ONLY` — Use only capacity reservations.
|
|
329
|
+
#
|
|
330
|
+
# * `RESERVATIONS_FIRST` — Prefer capacity reservations but fall back
|
|
331
|
+
# to On-Demand if unavailable.
|
|
332
|
+
#
|
|
333
|
+
# * `RESERVATIONS_EXCLUDED` — Do not use capacity reservations.
|
|
334
|
+
# @return [String]
|
|
335
|
+
#
|
|
336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CapacityReservationRequest AWS API Documentation
|
|
337
|
+
#
|
|
338
|
+
class CapacityReservationRequest < Struct.new(
|
|
339
|
+
:reservation_group_arn,
|
|
340
|
+
:reservation_preference)
|
|
341
|
+
SENSITIVE = []
|
|
342
|
+
include Aws::Structure
|
|
343
|
+
end
|
|
344
|
+
|
|
316
345
|
# These errors are usually caused by a client action. One example cause
|
|
317
346
|
# is using an action or resource on behalf of a user that doesn't have
|
|
318
347
|
# permissions to use the action or resource. Another cause is specifying
|
|
@@ -528,15 +557,23 @@ module Aws::Batch
|
|
|
528
557
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
|
529
558
|
#
|
|
530
559
|
# @!attribute [rw] type
|
|
531
|
-
# The type of compute environment: `EC2`, `SPOT`, `FARGATE`,
|
|
532
|
-
# `FARGATE_SPOT`. For more information,
|
|
533
|
-
# in the *Batch User Guide*.
|
|
560
|
+
# The type of compute environment: `EC2`, `SPOT`, `FARGATE`,
|
|
561
|
+
# `FARGATE_SPOT`, or `ECS_MANAGED_INSTANCES`. For more information,
|
|
562
|
+
# see [Compute environments][1] in the *Batch User Guide*.
|
|
534
563
|
#
|
|
535
564
|
# If you choose `SPOT`, you must also specify an Amazon EC2 Spot Fleet
|
|
536
565
|
# role with the `spotIamFleetRole` parameter. For more information,
|
|
537
566
|
# see [Amazon EC2 spot fleet role][2] in the *Batch User Guide*.
|
|
538
567
|
#
|
|
539
|
-
#
|
|
568
|
+
# If you choose `ECS_MANAGED_INSTANCES`, you must also specify a
|
|
569
|
+
# `managedInstancesProvider` configuration. To use Spot capacity, set
|
|
570
|
+
# `capacityOptionType` to `SPOT` in the
|
|
571
|
+
# `managedInstancesProvider.instanceLaunchTemplate` configuration. For
|
|
572
|
+
# more information, see [Amazon ECS Managed Instances compute
|
|
573
|
+
# environments][3] in the *Batch User Guide*.
|
|
574
|
+
#
|
|
575
|
+
# <note markdown="1"> Multi-node parallel jobs aren't supported on Spot Instances or
|
|
576
|
+
# Amazon ECS Managed Instances.
|
|
540
577
|
#
|
|
541
578
|
# </note>
|
|
542
579
|
#
|
|
@@ -544,6 +581,7 @@ module Aws::Batch
|
|
|
544
581
|
#
|
|
545
582
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
|
546
583
|
# [2]: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html
|
|
584
|
+
# [3]: https://docs.aws.amazon.com/batch/latest/userguide/ecs_managed_instances.html
|
|
547
585
|
# @return [String]
|
|
548
586
|
#
|
|
549
587
|
# @!attribute [rw] allocation_strategy
|
|
@@ -982,6 +1020,32 @@ module Aws::Batch
|
|
|
982
1020
|
# </note>
|
|
983
1021
|
# @return [Types::ComputeScalingPolicy]
|
|
984
1022
|
#
|
|
1023
|
+
# @!attribute [rw] managed_instances_provider
|
|
1024
|
+
# The configuration for the Amazon ECS Managed Instances capacity
|
|
1025
|
+
# provider. This parameter is required when `computeResources.type` is
|
|
1026
|
+
# `ECS_MANAGED_INSTANCES` and must not be specified for other compute
|
|
1027
|
+
# environment types.
|
|
1028
|
+
#
|
|
1029
|
+
# For more information, see [Amazon ECS Managed Instances compute
|
|
1030
|
+
# environments][1] in the *Batch User Guide*.
|
|
1031
|
+
#
|
|
1032
|
+
#
|
|
1033
|
+
#
|
|
1034
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/ecs_managed_instances.html
|
|
1035
|
+
# @return [Types::ManagedInstancesProvider]
|
|
1036
|
+
#
|
|
1037
|
+
# @!attribute [rw] capacity_tags
|
|
1038
|
+
# The tags to apply to the Amazon ECS capacity provider and Amazon EC2
|
|
1039
|
+
# instances launched by the compute environment. These tags are
|
|
1040
|
+
# separate from the compute environment resource tags (the top-level
|
|
1041
|
+
# `tags` parameter). Use `capacityTags` for cost allocation and
|
|
1042
|
+
# organization of the underlying infrastructure resources.
|
|
1043
|
+
#
|
|
1044
|
+
# This parameter is only valid for `ECS_MANAGED_INSTANCES` compute
|
|
1045
|
+
# environments. You must have the `batch:SetCapacityTags` permission
|
|
1046
|
+
# on the compute environment resource to use this parameter.
|
|
1047
|
+
# @return [Hash<String,String>]
|
|
1048
|
+
#
|
|
985
1049
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeResource AWS API Documentation
|
|
986
1050
|
#
|
|
987
1051
|
class ComputeResource < Struct.new(
|
|
@@ -1002,7 +1066,9 @@ module Aws::Batch
|
|
|
1002
1066
|
:spot_iam_fleet_role,
|
|
1003
1067
|
:launch_template,
|
|
1004
1068
|
:ec2_configuration,
|
|
1005
|
-
:scaling_policy
|
|
1069
|
+
:scaling_policy,
|
|
1070
|
+
:managed_instances_provider,
|
|
1071
|
+
:capacity_tags)
|
|
1006
1072
|
SENSITIVE = []
|
|
1007
1073
|
include Aws::Structure
|
|
1008
1074
|
end
|
|
@@ -1496,9 +1562,9 @@ module Aws::Batch
|
|
|
1496
1562
|
# @return [Boolean]
|
|
1497
1563
|
#
|
|
1498
1564
|
# @!attribute [rw] type
|
|
1499
|
-
# The type of compute environment: `EC2`, `SPOT`, `FARGATE`,
|
|
1500
|
-
# `FARGATE_SPOT`. For more information,
|
|
1501
|
-
# in the *Batch User Guide*.
|
|
1565
|
+
# The type of compute environment: `EC2`, `SPOT`, `FARGATE`,
|
|
1566
|
+
# `FARGATE_SPOT`, or `ECS_MANAGED_INSTANCES`. For more information,
|
|
1567
|
+
# see [Compute environments][1] in the *Batch User Guide*.
|
|
1502
1568
|
#
|
|
1503
1569
|
# If you choose `SPOT`, you must also specify an Amazon EC2 Spot Fleet
|
|
1504
1570
|
# role with the `spotIamFleetRole` parameter. For more information,
|
|
@@ -1509,6 +1575,8 @@ module Aws::Batch
|
|
|
1509
1575
|
# environment. For more information, see [Updating compute
|
|
1510
1576
|
# environments][3] in the *Batch User Guide*.
|
|
1511
1577
|
#
|
|
1578
|
+
# You cannot change the type to or from `ECS_MANAGED_INSTANCES`.
|
|
1579
|
+
#
|
|
1512
1580
|
#
|
|
1513
1581
|
#
|
|
1514
1582
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
|
@@ -1559,6 +1627,21 @@ module Aws::Batch
|
|
|
1559
1627
|
# </note>
|
|
1560
1628
|
# @return [Types::ComputeScalingPolicy]
|
|
1561
1629
|
#
|
|
1630
|
+
# @!attribute [rw] managed_instances_provider
|
|
1631
|
+
# The updated configuration for the Amazon ECS Managed Instances
|
|
1632
|
+
# capacity provider. This parameter is only valid when the compute
|
|
1633
|
+
# environment type is `ECS_MANAGED_INSTANCES`. You cannot change
|
|
1634
|
+
# `capacityOptionType` or `fipsEnabled` on update.
|
|
1635
|
+
# @return [Types::UpdateManagedInstancesProviderConfiguration]
|
|
1636
|
+
#
|
|
1637
|
+
# @!attribute [rw] capacity_tags
|
|
1638
|
+
# The updated tags to apply to the Amazon ECS capacity provider and
|
|
1639
|
+
# Amazon EC2 instances. This parameter is only valid for
|
|
1640
|
+
# `ECS_MANAGED_INSTANCES` compute environments. You must have the
|
|
1641
|
+
# `batch:SetCapacityTags` permission on the compute environment
|
|
1642
|
+
# resource to use this parameter.
|
|
1643
|
+
# @return [Hash<String,String>]
|
|
1644
|
+
#
|
|
1562
1645
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeResourceUpdate AWS API Documentation
|
|
1563
1646
|
#
|
|
1564
1647
|
class ComputeResourceUpdate < Struct.new(
|
|
@@ -1579,7 +1662,9 @@ module Aws::Batch
|
|
|
1579
1662
|
:update_to_latest_image_version,
|
|
1580
1663
|
:type,
|
|
1581
1664
|
:image_id,
|
|
1582
|
-
:scaling_policy
|
|
1665
|
+
:scaling_policy,
|
|
1666
|
+
:managed_instances_provider,
|
|
1667
|
+
:capacity_tags)
|
|
1583
1668
|
SENSITIVE = []
|
|
1584
1669
|
include Aws::Structure
|
|
1585
1670
|
end
|
|
@@ -4300,7 +4385,8 @@ module Aws::Batch
|
|
|
4300
4385
|
#
|
|
4301
4386
|
# @!attribute [rw] runtime_platform
|
|
4302
4387
|
# An object that represents the compute environment architecture for
|
|
4303
|
-
# Batch jobs on Fargate.
|
|
4388
|
+
# Batch jobs on Fargate or Amazon ECS Managed Instances. Contains the
|
|
4389
|
+
# operating system family and CPU architecture of the task.
|
|
4304
4390
|
# @return [Types::RuntimePlatform]
|
|
4305
4391
|
#
|
|
4306
4392
|
# @!attribute [rw] volumes
|
|
@@ -4313,6 +4399,12 @@ module Aws::Batch
|
|
|
4313
4399
|
# the containers in the task.
|
|
4314
4400
|
# @return [Boolean]
|
|
4315
4401
|
#
|
|
4402
|
+
# @!attribute [rw] network_mode
|
|
4403
|
+
# The network mode configured for the task. This field is populated
|
|
4404
|
+
# for jobs running on Amazon ECS Managed Instances
|
|
4405
|
+
# (`MANAGED_INSTANCES` platform capability) and always returns `host`.
|
|
4406
|
+
# @return [String]
|
|
4407
|
+
#
|
|
4316
4408
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EcsTaskDetails AWS API Documentation
|
|
4317
4409
|
#
|
|
4318
4410
|
class EcsTaskDetails < Struct.new(
|
|
@@ -4328,7 +4420,8 @@ module Aws::Batch
|
|
|
4328
4420
|
:network_configuration,
|
|
4329
4421
|
:runtime_platform,
|
|
4330
4422
|
:volumes,
|
|
4331
|
-
:enable_execute_command
|
|
4423
|
+
:enable_execute_command,
|
|
4424
|
+
:network_mode)
|
|
4332
4425
|
SENSITIVE = []
|
|
4333
4426
|
include Aws::Structure
|
|
4334
4427
|
end
|
|
@@ -4440,13 +4533,19 @@ module Aws::Batch
|
|
|
4440
4533
|
#
|
|
4441
4534
|
# @!attribute [rw] network_configuration
|
|
4442
4535
|
# The network configuration for jobs that are running on Fargate
|
|
4443
|
-
# resources. Jobs that are running on Amazon EC2 resources
|
|
4444
|
-
# specify this parameter.
|
|
4536
|
+
# resources. Jobs that are running on Amazon EC2 resources or Amazon
|
|
4537
|
+
# ECS Managed Instances must not specify this parameter.
|
|
4445
4538
|
# @return [Types::NetworkConfiguration]
|
|
4446
4539
|
#
|
|
4447
4540
|
# @!attribute [rw] runtime_platform
|
|
4448
4541
|
# An object that represents the compute environment architecture for
|
|
4449
|
-
# Batch jobs on Fargate.
|
|
4542
|
+
# Batch jobs on Fargate or Amazon ECS Managed Instances. Use this to
|
|
4543
|
+
# specify the operating system family (`operatingSystemFamily`) and
|
|
4544
|
+
# CPU architecture (`cpuArchitecture`).
|
|
4545
|
+
#
|
|
4546
|
+
# For Amazon ECS Managed Instances, the valid value for
|
|
4547
|
+
# `operatingSystemFamily` is `LINUX` (default). The valid values for
|
|
4548
|
+
# `cpuArchitecture` are `X86_64` and `ARM64`.
|
|
4450
4549
|
# @return [Types::RuntimePlatform]
|
|
4451
4550
|
#
|
|
4452
4551
|
# @!attribute [rw] volumes
|
|
@@ -4459,6 +4558,21 @@ module Aws::Batch
|
|
|
4459
4558
|
# the containers in the task.
|
|
4460
4559
|
# @return [Boolean]
|
|
4461
4560
|
#
|
|
4561
|
+
# @!attribute [rw] network_mode
|
|
4562
|
+
# The network mode to use for the task. Valid values: `host`. When not
|
|
4563
|
+
# specified, the default is `host`.
|
|
4564
|
+
#
|
|
4565
|
+
# With `host` mode, the container shares the host instance's network
|
|
4566
|
+
# stack directly. When running tasks that use the `host` network mode,
|
|
4567
|
+
# do not run containers using the root user (UID 0). Running as root
|
|
4568
|
+
# grants unrestricted access to host resources and increases the
|
|
4569
|
+
# attack surface.
|
|
4570
|
+
#
|
|
4571
|
+
# This parameter only applies to jobs running on Amazon ECS Managed
|
|
4572
|
+
# Instances (`MANAGED_INSTANCES` platform capability). It cannot be
|
|
4573
|
+
# specified for Fargate or Amazon EC2 platform job definitions.
|
|
4574
|
+
# @return [String]
|
|
4575
|
+
#
|
|
4462
4576
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EcsTaskProperties AWS API Documentation
|
|
4463
4577
|
#
|
|
4464
4578
|
class EcsTaskProperties < Struct.new(
|
|
@@ -4472,7 +4586,8 @@ module Aws::Batch
|
|
|
4472
4586
|
:network_configuration,
|
|
4473
4587
|
:runtime_platform,
|
|
4474
4588
|
:volumes,
|
|
4475
|
-
:enable_execute_command
|
|
4589
|
+
:enable_execute_command,
|
|
4590
|
+
:network_mode)
|
|
4476
4591
|
SENSITIVE = []
|
|
4477
4592
|
include Aws::Structure
|
|
4478
4593
|
end
|
|
@@ -6219,6 +6334,179 @@ module Aws::Batch
|
|
|
6219
6334
|
include Aws::Structure
|
|
6220
6335
|
end
|
|
6221
6336
|
|
|
6337
|
+
# The infrastructure optimization configuration for an Amazon ECS
|
|
6338
|
+
# Managed Instances capacity provider. Specifies the idle-instance
|
|
6339
|
+
# scale-in behavior.
|
|
6340
|
+
#
|
|
6341
|
+
# @!attribute [rw] scale_in_after
|
|
6342
|
+
# The number of seconds an instance can remain idle before it is
|
|
6343
|
+
# terminated. Valid values are `-1` or `0` to `3600`. Use `-1` as a
|
|
6344
|
+
# special value to disable scale-in (instances are never terminated
|
|
6345
|
+
# for being idle). If not specified, a default value applies.
|
|
6346
|
+
# @return [Integer]
|
|
6347
|
+
#
|
|
6348
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/InfrastructureOptimization AWS API Documentation
|
|
6349
|
+
#
|
|
6350
|
+
class InfrastructureOptimization < Struct.new(
|
|
6351
|
+
:scale_in_after)
|
|
6352
|
+
SENSITIVE = []
|
|
6353
|
+
include Aws::Structure
|
|
6354
|
+
end
|
|
6355
|
+
|
|
6356
|
+
# The instance launch configuration for an Amazon ECS Managed Instances
|
|
6357
|
+
# capacity provider. Specifies the instance profile, networking,
|
|
6358
|
+
# instance selection constraints, capacity pricing model, storage, and
|
|
6359
|
+
# monitoring settings.
|
|
6360
|
+
#
|
|
6361
|
+
# @!attribute [rw] ec2_instance_profile_arn
|
|
6362
|
+
# The Amazon Resource Name (ARN) of the Amazon EC2 instance profile
|
|
6363
|
+
# for the managed instances. The instance profile must use the
|
|
6364
|
+
# `AmazonECSInstanceRolePolicyForManagedInstances` managed policy with
|
|
6365
|
+
# a trust policy for `ec2.amazonaws.com`.
|
|
6366
|
+
# @return [String]
|
|
6367
|
+
#
|
|
6368
|
+
# @!attribute [rw] network_configuration
|
|
6369
|
+
# The network configuration for the managed instances. Specifies the
|
|
6370
|
+
# VPC subnets and security groups where instances are launched.
|
|
6371
|
+
# @return [Types::ManagedInstancesNetworkConfiguration]
|
|
6372
|
+
#
|
|
6373
|
+
# @!attribute [rw] instance_requirements
|
|
6374
|
+
# The instance type requirements for the capacity provider. Use this
|
|
6375
|
+
# to constrain which Amazon EC2 instance types Amazon ECS can launch.
|
|
6376
|
+
# If not specified, all available instance types are eligible.
|
|
6377
|
+
# @return [Types::InstanceRequirementsRequest]
|
|
6378
|
+
#
|
|
6379
|
+
# @!attribute [rw] capacity_option_type
|
|
6380
|
+
# The capacity pricing model for the managed instances. Valid values:
|
|
6381
|
+
#
|
|
6382
|
+
# * `ON_DEMAND` (default) — On-Demand pricing.
|
|
6383
|
+
#
|
|
6384
|
+
# * `SPOT` — Spot Instances, which can provide significant cost
|
|
6385
|
+
# savings for fault-tolerant workloads.
|
|
6386
|
+
# @return [String]
|
|
6387
|
+
#
|
|
6388
|
+
# @!attribute [rw] storage_configuration
|
|
6389
|
+
# The storage configuration for the managed instances. Configures the
|
|
6390
|
+
# root EBS volume size. If not specified, the service uses the default
|
|
6391
|
+
# EBS volume size for the instance type.
|
|
6392
|
+
# @return [Types::ManagedInstancesStorageConfiguration]
|
|
6393
|
+
#
|
|
6394
|
+
# @!attribute [rw] monitoring
|
|
6395
|
+
# The level of CloudWatch monitoring for the managed instances. Valid
|
|
6396
|
+
# values are `BASIC` and `DETAILED`.
|
|
6397
|
+
# @return [String]
|
|
6398
|
+
#
|
|
6399
|
+
# @!attribute [rw] fips_enabled
|
|
6400
|
+
# Specifies whether FIPS 140-2 validated cryptographic modules are
|
|
6401
|
+
# enabled on the managed instances. Not available in all Regions.
|
|
6402
|
+
# @return [Boolean]
|
|
6403
|
+
#
|
|
6404
|
+
# @!attribute [rw] capacity_reservations
|
|
6405
|
+
# The capacity reservation configuration for the managed instances.
|
|
6406
|
+
# Use this to target On-Demand Capacity Reservations or Reserved
|
|
6407
|
+
# Instances for predictable capacity and cost optimization.
|
|
6408
|
+
# @return [Types::CapacityReservationRequest]
|
|
6409
|
+
#
|
|
6410
|
+
# @!attribute [rw] instance_metadata_tags_propagation
|
|
6411
|
+
# Specifies whether instance tags are accessible from the instance
|
|
6412
|
+
# metadata service (IMDS). If not specified, instance tags are not
|
|
6413
|
+
# accessible from IMDS.
|
|
6414
|
+
# @return [Boolean]
|
|
6415
|
+
#
|
|
6416
|
+
# @!attribute [rw] local_storage_configuration
|
|
6417
|
+
# The local storage configuration for the managed instances. If not
|
|
6418
|
+
# specified, instance store volumes are not available to containers.
|
|
6419
|
+
# @return [Types::ManagedInstancesLocalStorageConfiguration]
|
|
6420
|
+
#
|
|
6421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/InstanceLaunchTemplate AWS API Documentation
|
|
6422
|
+
#
|
|
6423
|
+
class InstanceLaunchTemplate < Struct.new(
|
|
6424
|
+
:ec2_instance_profile_arn,
|
|
6425
|
+
:network_configuration,
|
|
6426
|
+
:instance_requirements,
|
|
6427
|
+
:capacity_option_type,
|
|
6428
|
+
:storage_configuration,
|
|
6429
|
+
:monitoring,
|
|
6430
|
+
:fips_enabled,
|
|
6431
|
+
:capacity_reservations,
|
|
6432
|
+
:instance_metadata_tags_propagation,
|
|
6433
|
+
:local_storage_configuration)
|
|
6434
|
+
SENSITIVE = []
|
|
6435
|
+
include Aws::Structure
|
|
6436
|
+
end
|
|
6437
|
+
|
|
6438
|
+
# The instance launch configuration for updating an Amazon ECS Managed
|
|
6439
|
+
# Instances capacity provider. You cannot change `capacityOptionType` or
|
|
6440
|
+
# `fipsEnabled` after the compute environment is created.
|
|
6441
|
+
#
|
|
6442
|
+
# @!attribute [rw] ec2_instance_profile_arn
|
|
6443
|
+
# The updated Amazon Resource Name (ARN) of the Amazon EC2 instance
|
|
6444
|
+
# profile for the managed instances.
|
|
6445
|
+
# @return [String]
|
|
6446
|
+
#
|
|
6447
|
+
# @!attribute [rw] network_configuration
|
|
6448
|
+
# The updated network configuration for the managed instances.
|
|
6449
|
+
# @return [Types::ManagedInstancesNetworkConfiguration]
|
|
6450
|
+
#
|
|
6451
|
+
# @!attribute [rw] instance_requirements
|
|
6452
|
+
# The updated instance type requirements for the capacity provider.
|
|
6453
|
+
# @return [Types::InstanceRequirementsRequest]
|
|
6454
|
+
#
|
|
6455
|
+
# @!attribute [rw] storage_configuration
|
|
6456
|
+
# The updated storage configuration for the managed instances.
|
|
6457
|
+
# @return [Types::ManagedInstancesStorageConfiguration]
|
|
6458
|
+
#
|
|
6459
|
+
# @!attribute [rw] monitoring
|
|
6460
|
+
# The updated monitoring level. Valid values are `BASIC` and
|
|
6461
|
+
# `DETAILED`.
|
|
6462
|
+
# @return [String]
|
|
6463
|
+
#
|
|
6464
|
+
# @!attribute [rw] capacity_reservations
|
|
6465
|
+
# The updated capacity reservation configuration.
|
|
6466
|
+
# @return [Types::CapacityReservationRequest]
|
|
6467
|
+
#
|
|
6468
|
+
# @!attribute [rw] instance_metadata_tags_propagation
|
|
6469
|
+
# Specifies whether instance tags are accessible from the instance
|
|
6470
|
+
# metadata service (IMDS).
|
|
6471
|
+
# @return [Boolean]
|
|
6472
|
+
#
|
|
6473
|
+
# @!attribute [rw] local_storage_configuration
|
|
6474
|
+
# The updated local storage configuration.
|
|
6475
|
+
# @return [Types::ManagedInstancesLocalStorageConfiguration]
|
|
6476
|
+
#
|
|
6477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/InstanceLaunchTemplateUpdate AWS API Documentation
|
|
6478
|
+
#
|
|
6479
|
+
class InstanceLaunchTemplateUpdate < Struct.new(
|
|
6480
|
+
:ec2_instance_profile_arn,
|
|
6481
|
+
:network_configuration,
|
|
6482
|
+
:instance_requirements,
|
|
6483
|
+
:storage_configuration,
|
|
6484
|
+
:monitoring,
|
|
6485
|
+
:capacity_reservations,
|
|
6486
|
+
:instance_metadata_tags_propagation,
|
|
6487
|
+
:local_storage_configuration)
|
|
6488
|
+
SENSITIVE = []
|
|
6489
|
+
include Aws::Structure
|
|
6490
|
+
end
|
|
6491
|
+
|
|
6492
|
+
# The instance type requirements for the Amazon ECS Managed Instances
|
|
6493
|
+
# capacity provider. Use this to specify which Amazon EC2 instance types
|
|
6494
|
+
# or instance families Amazon ECS can launch.
|
|
6495
|
+
#
|
|
6496
|
+
# @!attribute [rw] allowed_instance_types
|
|
6497
|
+
# A list of specific instance types or instance families that Amazon
|
|
6498
|
+
# ECS can launch (for example, `m5.large` or `g5`). When specified,
|
|
6499
|
+
# only these instance types are used.
|
|
6500
|
+
# @return [Array<String>]
|
|
6501
|
+
#
|
|
6502
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/InstanceRequirementsRequest AWS API Documentation
|
|
6503
|
+
#
|
|
6504
|
+
class InstanceRequirementsRequest < Struct.new(
|
|
6505
|
+
:allowed_instance_types)
|
|
6506
|
+
SENSITIVE = []
|
|
6507
|
+
include Aws::Structure
|
|
6508
|
+
end
|
|
6509
|
+
|
|
6222
6510
|
# The capacity usage for a job, including the unit of measure and
|
|
6223
6511
|
# quantity of resources being used.
|
|
6224
6512
|
#
|
|
@@ -6338,7 +6626,8 @@ module Aws::Batch
|
|
|
6338
6626
|
# @!attribute [rw] platform_capabilities
|
|
6339
6627
|
# The platform capabilities required by the job definition. If no
|
|
6340
6628
|
# value is specified, it defaults to `EC2`. Jobs run on Fargate
|
|
6341
|
-
# resources specify `FARGATE`.
|
|
6629
|
+
# resources specify `FARGATE`. Jobs run on Amazon ECS Managed
|
|
6630
|
+
# Instances specify `MANAGED_INSTANCES`.
|
|
6342
6631
|
# @return [Array<String>]
|
|
6343
6632
|
#
|
|
6344
6633
|
# @!attribute [rw] ecs_properties
|
|
@@ -6565,7 +6854,8 @@ module Aws::Batch
|
|
|
6565
6854
|
# @!attribute [rw] platform_capabilities
|
|
6566
6855
|
# The platform capabilities required by the job definition. If no
|
|
6567
6856
|
# value is specified, it defaults to `EC2`. Jobs run on Fargate
|
|
6568
|
-
# resources specify `FARGATE`.
|
|
6857
|
+
# resources specify `FARGATE`. Jobs run on Amazon ECS Managed
|
|
6858
|
+
# Instances specify `MANAGED_INSTANCES`.
|
|
6569
6859
|
# @return [Array<String>]
|
|
6570
6860
|
#
|
|
6571
6861
|
# @!attribute [rw] eks_properties
|
|
@@ -8141,6 +8431,102 @@ module Aws::Batch
|
|
|
8141
8431
|
include Aws::Structure
|
|
8142
8432
|
end
|
|
8143
8433
|
|
|
8434
|
+
# The local storage configuration for Amazon ECS Managed Instances.
|
|
8435
|
+
#
|
|
8436
|
+
# @!attribute [rw] use_local_storage
|
|
8437
|
+
# Specifies whether instance store volumes (local NVMe SSDs) are
|
|
8438
|
+
# available to containers. When enabled, containers can use the
|
|
8439
|
+
# instance store for high-performance temporary storage.
|
|
8440
|
+
# @return [Boolean]
|
|
8441
|
+
#
|
|
8442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ManagedInstancesLocalStorageConfiguration AWS API Documentation
|
|
8443
|
+
#
|
|
8444
|
+
class ManagedInstancesLocalStorageConfiguration < Struct.new(
|
|
8445
|
+
:use_local_storage)
|
|
8446
|
+
SENSITIVE = []
|
|
8447
|
+
include Aws::Structure
|
|
8448
|
+
end
|
|
8449
|
+
|
|
8450
|
+
# The network configuration for Amazon ECS Managed Instances. Specifies
|
|
8451
|
+
# the VPC subnets and security groups where instances are launched.
|
|
8452
|
+
#
|
|
8453
|
+
# @!attribute [rw] subnets
|
|
8454
|
+
# The VPC subnets where managed instances are launched. If your
|
|
8455
|
+
# subnets don't provide public IP addresses, they must have a NAT
|
|
8456
|
+
# gateway for outbound internet access.
|
|
8457
|
+
# @return [Array<String>]
|
|
8458
|
+
#
|
|
8459
|
+
# @!attribute [rw] security_groups
|
|
8460
|
+
# The VPC security groups to associate with the managed instances.
|
|
8461
|
+
# @return [Array<String>]
|
|
8462
|
+
#
|
|
8463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ManagedInstancesNetworkConfiguration AWS API Documentation
|
|
8464
|
+
#
|
|
8465
|
+
class ManagedInstancesNetworkConfiguration < Struct.new(
|
|
8466
|
+
:subnets,
|
|
8467
|
+
:security_groups)
|
|
8468
|
+
SENSITIVE = []
|
|
8469
|
+
include Aws::Structure
|
|
8470
|
+
end
|
|
8471
|
+
|
|
8472
|
+
# The configuration for an Amazon ECS Managed Instances capacity
|
|
8473
|
+
# provider. This object is required when creating a compute environment
|
|
8474
|
+
# with `computeResources.type` set to `ECS_MANAGED_INSTANCES`.
|
|
8475
|
+
#
|
|
8476
|
+
# @!attribute [rw] propagate_tags
|
|
8477
|
+
# Specifies whether tags on the capacity provider are propagated to
|
|
8478
|
+
# the Amazon EC2 instances it launches. Valid values:
|
|
8479
|
+
#
|
|
8480
|
+
# * `CAPACITY_PROVIDER` — Propagates tags to instances.
|
|
8481
|
+
#
|
|
8482
|
+
# * `NONE` (default) — Does not propagate tags to instances.
|
|
8483
|
+
# @return [String]
|
|
8484
|
+
#
|
|
8485
|
+
# @!attribute [rw] infrastructure_role_arn
|
|
8486
|
+
# The Amazon Resource Name (ARN) of the IAM role that Amazon ECS
|
|
8487
|
+
# assumes to manage Amazon EC2 instances on your behalf. This role
|
|
8488
|
+
# must have a trust policy for `ecs.amazonaws.com`. You must have the
|
|
8489
|
+
# `iam:PassRole` permission for this role with the condition
|
|
8490
|
+
# `iam:PassedToService: ecs.amazonaws.com`.
|
|
8491
|
+
# @return [String]
|
|
8492
|
+
#
|
|
8493
|
+
# @!attribute [rw] instance_launch_template
|
|
8494
|
+
# The instance launch configuration for the Amazon ECS Managed
|
|
8495
|
+
# Instances capacity provider. Contains networking, instance profile,
|
|
8496
|
+
# instance requirements, capacity type, storage, and monitoring
|
|
8497
|
+
# configuration.
|
|
8498
|
+
# @return [Types::InstanceLaunchTemplate]
|
|
8499
|
+
#
|
|
8500
|
+
# @!attribute [rw] infrastructure_optimization
|
|
8501
|
+
# The infrastructure optimization configuration for the capacity
|
|
8502
|
+
# provider. Specifies the idle-instance scale-in behavior.
|
|
8503
|
+
# @return [Types::InfrastructureOptimization]
|
|
8504
|
+
#
|
|
8505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ManagedInstancesProvider AWS API Documentation
|
|
8506
|
+
#
|
|
8507
|
+
class ManagedInstancesProvider < Struct.new(
|
|
8508
|
+
:propagate_tags,
|
|
8509
|
+
:infrastructure_role_arn,
|
|
8510
|
+
:instance_launch_template,
|
|
8511
|
+
:infrastructure_optimization)
|
|
8512
|
+
SENSITIVE = []
|
|
8513
|
+
include Aws::Structure
|
|
8514
|
+
end
|
|
8515
|
+
|
|
8516
|
+
# The storage configuration for Amazon ECS Managed Instances.
|
|
8517
|
+
#
|
|
8518
|
+
# @!attribute [rw] storage_size_gi_b
|
|
8519
|
+
# The size of the root EBS volume in GiB for the managed instances.
|
|
8520
|
+
# @return [Integer]
|
|
8521
|
+
#
|
|
8522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ManagedInstancesStorageConfiguration AWS API Documentation
|
|
8523
|
+
#
|
|
8524
|
+
class ManagedInstancesStorageConfiguration < Struct.new(
|
|
8525
|
+
:storage_size_gi_b)
|
|
8526
|
+
SENSITIVE = []
|
|
8527
|
+
include Aws::Structure
|
|
8528
|
+
end
|
|
8529
|
+
|
|
8144
8530
|
# Details for a Docker volume mount point that's used in a job's
|
|
8145
8531
|
# container properties. This parameter maps to `Volumes` in the [Create
|
|
8146
8532
|
# a container][1] section of the *Docker Remote API* and the `--volume`
|
|
@@ -8854,7 +9240,12 @@ module Aws::Batch
|
|
|
8854
9240
|
# @!attribute [rw] platform_capabilities
|
|
8855
9241
|
# The platform capabilities required by the job definition. If no
|
|
8856
9242
|
# value is specified, it defaults to `EC2`. To run the job on Fargate
|
|
8857
|
-
# resources, specify `FARGATE`.
|
|
9243
|
+
# resources, specify `FARGATE`. To run the job on Amazon ECS Managed
|
|
9244
|
+
# Instances, specify `MANAGED_INSTANCES`.
|
|
9245
|
+
#
|
|
9246
|
+
# Jobs with the `MANAGED_INSTANCES` platform capability must use
|
|
9247
|
+
# `ecsProperties` (not `containerProperties`) and do not support
|
|
9248
|
+
# multi-node parallel jobs.
|
|
8858
9249
|
#
|
|
8859
9250
|
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
|
8860
9251
|
# `platformCapabilities`.
|
|
@@ -11425,10 +11816,54 @@ module Aws::Batch
|
|
|
11425
11816
|
include Aws::Structure
|
|
11426
11817
|
end
|
|
11427
11818
|
|
|
11819
|
+
# The configuration for updating an Amazon ECS Managed Instances
|
|
11820
|
+
# capacity provider. Used in `UpdateComputeEnvironment` requests. The
|
|
11821
|
+
# `capacityOptionType` and `fipsEnabled` fields cannot be changed on
|
|
11822
|
+
# update.
|
|
11823
|
+
#
|
|
11824
|
+
# @!attribute [rw] propagate_tags
|
|
11825
|
+
# Specifies whether tags on the capacity provider are propagated to
|
|
11826
|
+
# the Amazon EC2 instances it launches. Valid values:
|
|
11827
|
+
#
|
|
11828
|
+
# * `CAPACITY_PROVIDER` — Propagates tags to instances.
|
|
11829
|
+
#
|
|
11830
|
+
# * `NONE` — Does not propagate tags to instances.
|
|
11831
|
+
# @return [String]
|
|
11832
|
+
#
|
|
11833
|
+
# @!attribute [rw] infrastructure_role_arn
|
|
11834
|
+
# The updated Amazon Resource Name (ARN) of the IAM role that Amazon
|
|
11835
|
+
# ECS assumes to manage Amazon EC2 instances on your behalf.
|
|
11836
|
+
# @return [String]
|
|
11837
|
+
#
|
|
11838
|
+
# @!attribute [rw] instance_launch_template
|
|
11839
|
+
# The updated instance launch configuration for the Amazon ECS Managed
|
|
11840
|
+
# Instances capacity provider.
|
|
11841
|
+
# @return [Types::InstanceLaunchTemplateUpdate]
|
|
11842
|
+
#
|
|
11843
|
+
# @!attribute [rw] infrastructure_optimization
|
|
11844
|
+
# The updated infrastructure optimization configuration.
|
|
11845
|
+
# @return [Types::InfrastructureOptimization]
|
|
11846
|
+
#
|
|
11847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateManagedInstancesProviderConfiguration AWS API Documentation
|
|
11848
|
+
#
|
|
11849
|
+
class UpdateManagedInstancesProviderConfiguration < Struct.new(
|
|
11850
|
+
:propagate_tags,
|
|
11851
|
+
:infrastructure_role_arn,
|
|
11852
|
+
:instance_launch_template,
|
|
11853
|
+
:infrastructure_optimization)
|
|
11854
|
+
SENSITIVE = []
|
|
11855
|
+
include Aws::Structure
|
|
11856
|
+
end
|
|
11857
|
+
|
|
11428
11858
|
# Specifies the infrastructure update policy for the Amazon EC2 compute
|
|
11429
11859
|
# environment. For more information about infrastructure updates, see
|
|
11430
11860
|
# [Updating compute environments][1] in the *Batch User Guide*.
|
|
11431
11861
|
#
|
|
11862
|
+
# The `updatePolicy` property applies only to Amazon EC2 managed compute
|
|
11863
|
+
# environments. Batch doesn't support `updatePolicy` for Fargate
|
|
11864
|
+
# compute environments. If you specify it for a Fargate compute
|
|
11865
|
+
# environment, Batch ignores it.
|
|
11866
|
+
#
|
|
11432
11867
|
#
|
|
11433
11868
|
#
|
|
11434
11869
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
|