aws-cdk-lib 2.178.2__py3-none-any.whl → 2.180.0__py3-none-any.whl
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.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +83 -41
- aws_cdk/_jsii/__init__.py +1 -2
- aws_cdk/_jsii/{aws-cdk-lib@2.178.2.jsii.tgz → aws-cdk-lib@2.180.0.jsii.tgz} +0 -0
- aws_cdk/aws_acmpca/__init__.py +47 -0
- aws_cdk/aws_apigateway/__init__.py +176 -35
- aws_cdk/aws_apigatewayv2/__init__.py +151 -32
- aws_cdk/aws_apigatewayv2_integrations/__init__.py +348 -0
- aws_cdk/aws_applicationautoscaling/__init__.py +8 -8
- aws_cdk/aws_appsync/__init__.py +10 -7
- aws_cdk/aws_backup/__init__.py +89 -0
- aws_cdk/aws_batch/__init__.py +89 -50
- aws_cdk/aws_bedrock/__init__.py +506 -62
- aws_cdk/aws_cloudfront/__init__.py +1037 -146
- aws_cdk/aws_cloudfront_origins/__init__.py +1338 -144
- aws_cdk/aws_cloudtrail/__init__.py +4 -8
- aws_cdk/aws_cloudwatch/__init__.py +1 -1
- aws_cdk/aws_codebuild/__init__.py +218 -2
- aws_cdk/aws_codepipeline/__init__.py +113 -28
- aws_cdk/aws_codepipeline_actions/__init__.py +554 -63
- aws_cdk/aws_codestar/__init__.py +2 -1
- aws_cdk/aws_cognito/__init__.py +676 -29
- aws_cdk/aws_connect/__init__.py +257 -0
- aws_cdk/aws_datasync/__init__.py +279 -50
- aws_cdk/aws_deadline/__init__.py +683 -6
- aws_cdk/aws_directoryservice/__init__.py +9 -4
- aws_cdk/aws_dlm/__init__.py +2 -2
- aws_cdk/aws_dms/__init__.py +3 -3
- aws_cdk/aws_dynamodb/__init__.py +0 -54
- aws_cdk/aws_ec2/__init__.py +402 -130
- aws_cdk/aws_ecs/__init__.py +28 -43
- aws_cdk/aws_efs/__init__.py +1 -1
- aws_cdk/aws_eks/__init__.py +560 -182
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +112 -27
- aws_cdk/aws_emrcontainers/__init__.py +44 -1
- aws_cdk/aws_events/__init__.py +17 -26
- aws_cdk/aws_events_targets/__init__.py +303 -16
- aws_cdk/aws_fms/__init__.py +5 -5
- aws_cdk/aws_fsx/__init__.py +5 -4
- aws_cdk/aws_glue/__init__.py +161 -0
- aws_cdk/aws_groundstation/__init__.py +23 -1
- aws_cdk/aws_iam/__init__.py +15 -15
- aws_cdk/aws_iot/__init__.py +7 -0
- aws_cdk/aws_ivs/__init__.py +254 -77
- aws_cdk/aws_kinesis/__init__.py +689 -35
- aws_cdk/aws_lambda/__init__.py +10 -15
- aws_cdk/aws_lambda_event_sources/__init__.py +175 -2
- aws_cdk/aws_logs/__init__.py +62 -13
- aws_cdk/aws_medialive/__init__.py +314 -4
- aws_cdk/aws_opensearchserverless/__init__.py +19 -0
- aws_cdk/aws_pinpoint/__init__.py +14 -9
- aws_cdk/aws_rds/__init__.py +246 -82
- aws_cdk/aws_s3/__init__.py +287 -9
- aws_cdk/aws_s3objectlambda/__init__.py +2 -2
- aws_cdk/aws_ses/__init__.py +228 -8
- aws_cdk/aws_ssm/__init__.py +4 -5
- aws_cdk/aws_stepfunctions/__init__.py +301 -70
- aws_cdk/aws_stepfunctions_tasks/__init__.py +269 -163
- aws_cdk/aws_supportapp/__init__.py +7 -7
- aws_cdk/aws_transfer/__init__.py +820 -2
- aws_cdk/aws_wafv2/__init__.py +17 -9
- aws_cdk/custom_resources/__init__.py +23 -26
- aws_cdk/cx_api/__init__.py +16 -0
- aws_cdk/pipelines/__init__.py +2 -2
- {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.180.0.dist-info}/METADATA +1 -2
- {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.180.0.dist-info}/RECORD +69 -70
- aws_cdk/lambda_layer_kubectl/__init__.py +0 -107
- {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.180.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.180.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.180.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.178.2.dist-info → aws_cdk_lib-2.180.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_backup/__init__.py
CHANGED
|
@@ -1757,6 +1757,9 @@ class CfnBackupPlan(
|
|
|
1757
1757
|
)
|
|
1758
1758
|
)],
|
|
1759
1759
|
enable_continuous_backup=False,
|
|
1760
|
+
index_actions=[backup.CfnBackupPlan.IndexActionsResourceTypeProperty(
|
|
1761
|
+
resource_types=["resourceTypes"]
|
|
1762
|
+
)],
|
|
1760
1763
|
lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
|
|
1761
1764
|
delete_after_days=123,
|
|
1762
1765
|
move_to_cold_storage_after_days=123,
|
|
@@ -2061,6 +2064,9 @@ class CfnBackupPlan(
|
|
|
2061
2064
|
)
|
|
2062
2065
|
)],
|
|
2063
2066
|
enable_continuous_backup=False,
|
|
2067
|
+
index_actions=[backup.CfnBackupPlan.IndexActionsResourceTypeProperty(
|
|
2068
|
+
resource_types=["resourceTypes"]
|
|
2069
|
+
)],
|
|
2064
2070
|
lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
|
|
2065
2071
|
delete_after_days=123,
|
|
2066
2072
|
move_to_cold_storage_after_days=123,
|
|
@@ -2146,6 +2152,7 @@ class CfnBackupPlan(
|
|
|
2146
2152
|
"completion_window_minutes": "completionWindowMinutes",
|
|
2147
2153
|
"copy_actions": "copyActions",
|
|
2148
2154
|
"enable_continuous_backup": "enableContinuousBackup",
|
|
2155
|
+
"index_actions": "indexActions",
|
|
2149
2156
|
"lifecycle": "lifecycle",
|
|
2150
2157
|
"recovery_point_tags": "recoveryPointTags",
|
|
2151
2158
|
"schedule_expression": "scheduleExpression",
|
|
@@ -2162,6 +2169,7 @@ class CfnBackupPlan(
|
|
|
2162
2169
|
completion_window_minutes: typing.Optional[jsii.Number] = None,
|
|
2163
2170
|
copy_actions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnBackupPlan.CopyActionResourceTypeProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
2164
2171
|
enable_continuous_backup: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
2172
|
+
index_actions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnBackupPlan.IndexActionsResourceTypeProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
2165
2173
|
lifecycle: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnBackupPlan.LifecycleResourceTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
2166
2174
|
recovery_point_tags: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
|
|
2167
2175
|
schedule_expression: typing.Optional[builtins.str] = None,
|
|
@@ -2175,6 +2183,7 @@ class CfnBackupPlan(
|
|
|
2175
2183
|
:param completion_window_minutes: A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup .
|
|
2176
2184
|
:param copy_actions: An array of CopyAction objects, which contains the details of the copy operation.
|
|
2177
2185
|
:param enable_continuous_backup: Enables continuous backup and point-in-time restores (PITR).
|
|
2186
|
+
:param index_actions:
|
|
2178
2187
|
:param lifecycle: The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
|
|
2179
2188
|
:param recovery_point_tags: The tags to assign to the resources.
|
|
2180
2189
|
:param schedule_expression: A CRON expression specifying when AWS Backup initiates a backup job.
|
|
@@ -2207,6 +2216,9 @@ class CfnBackupPlan(
|
|
|
2207
2216
|
)
|
|
2208
2217
|
)],
|
|
2209
2218
|
enable_continuous_backup=False,
|
|
2219
|
+
index_actions=[backup.CfnBackupPlan.IndexActionsResourceTypeProperty(
|
|
2220
|
+
resource_types=["resourceTypes"]
|
|
2221
|
+
)],
|
|
2210
2222
|
lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
|
|
2211
2223
|
delete_after_days=123,
|
|
2212
2224
|
move_to_cold_storage_after_days=123,
|
|
@@ -2227,6 +2239,7 @@ class CfnBackupPlan(
|
|
|
2227
2239
|
check_type(argname="argument completion_window_minutes", value=completion_window_minutes, expected_type=type_hints["completion_window_minutes"])
|
|
2228
2240
|
check_type(argname="argument copy_actions", value=copy_actions, expected_type=type_hints["copy_actions"])
|
|
2229
2241
|
check_type(argname="argument enable_continuous_backup", value=enable_continuous_backup, expected_type=type_hints["enable_continuous_backup"])
|
|
2242
|
+
check_type(argname="argument index_actions", value=index_actions, expected_type=type_hints["index_actions"])
|
|
2230
2243
|
check_type(argname="argument lifecycle", value=lifecycle, expected_type=type_hints["lifecycle"])
|
|
2231
2244
|
check_type(argname="argument recovery_point_tags", value=recovery_point_tags, expected_type=type_hints["recovery_point_tags"])
|
|
2232
2245
|
check_type(argname="argument schedule_expression", value=schedule_expression, expected_type=type_hints["schedule_expression"])
|
|
@@ -2242,6 +2255,8 @@ class CfnBackupPlan(
|
|
|
2242
2255
|
self._values["copy_actions"] = copy_actions
|
|
2243
2256
|
if enable_continuous_backup is not None:
|
|
2244
2257
|
self._values["enable_continuous_backup"] = enable_continuous_backup
|
|
2258
|
+
if index_actions is not None:
|
|
2259
|
+
self._values["index_actions"] = index_actions
|
|
2245
2260
|
if lifecycle is not None:
|
|
2246
2261
|
self._values["lifecycle"] = lifecycle
|
|
2247
2262
|
if recovery_point_tags is not None:
|
|
@@ -2306,6 +2321,16 @@ class CfnBackupPlan(
|
|
|
2306
2321
|
result = self._values.get("enable_continuous_backup")
|
|
2307
2322
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], result)
|
|
2308
2323
|
|
|
2324
|
+
@builtins.property
|
|
2325
|
+
def index_actions(
|
|
2326
|
+
self,
|
|
2327
|
+
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnBackupPlan.IndexActionsResourceTypeProperty"]]]]:
|
|
2328
|
+
'''
|
|
2329
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-indexactions
|
|
2330
|
+
'''
|
|
2331
|
+
result = self._values.get("index_actions")
|
|
2332
|
+
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnBackupPlan.IndexActionsResourceTypeProperty"]]]], result)
|
|
2333
|
+
|
|
2309
2334
|
@builtins.property
|
|
2310
2335
|
def lifecycle(
|
|
2311
2336
|
self,
|
|
@@ -2460,6 +2485,59 @@ class CfnBackupPlan(
|
|
|
2460
2485
|
k + "=" + repr(v) for k, v in self._values.items()
|
|
2461
2486
|
)
|
|
2462
2487
|
|
|
2488
|
+
@jsii.data_type(
|
|
2489
|
+
jsii_type="aws-cdk-lib.aws_backup.CfnBackupPlan.IndexActionsResourceTypeProperty",
|
|
2490
|
+
jsii_struct_bases=[],
|
|
2491
|
+
name_mapping={"resource_types": "resourceTypes"},
|
|
2492
|
+
)
|
|
2493
|
+
class IndexActionsResourceTypeProperty:
|
|
2494
|
+
def __init__(
|
|
2495
|
+
self,
|
|
2496
|
+
*,
|
|
2497
|
+
resource_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
2498
|
+
) -> None:
|
|
2499
|
+
'''
|
|
2500
|
+
:param resource_types:
|
|
2501
|
+
|
|
2502
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-indexactionsresourcetype.html
|
|
2503
|
+
:exampleMetadata: fixture=_generated
|
|
2504
|
+
|
|
2505
|
+
Example::
|
|
2506
|
+
|
|
2507
|
+
# The code below shows an example of how to instantiate this type.
|
|
2508
|
+
# The values are placeholders you should change.
|
|
2509
|
+
from aws_cdk import aws_backup as backup
|
|
2510
|
+
|
|
2511
|
+
index_actions_resource_type_property = backup.CfnBackupPlan.IndexActionsResourceTypeProperty(
|
|
2512
|
+
resource_types=["resourceTypes"]
|
|
2513
|
+
)
|
|
2514
|
+
'''
|
|
2515
|
+
if __debug__:
|
|
2516
|
+
type_hints = typing.get_type_hints(_typecheckingstub__da981045a3cee9f5e8fc63c128c7e612a5dc43d041acf8903816ac5b23b3827f)
|
|
2517
|
+
check_type(argname="argument resource_types", value=resource_types, expected_type=type_hints["resource_types"])
|
|
2518
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
2519
|
+
if resource_types is not None:
|
|
2520
|
+
self._values["resource_types"] = resource_types
|
|
2521
|
+
|
|
2522
|
+
@builtins.property
|
|
2523
|
+
def resource_types(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
2524
|
+
'''
|
|
2525
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-indexactionsresourcetype.html#cfn-backup-backupplan-indexactionsresourcetype-resourcetypes
|
|
2526
|
+
'''
|
|
2527
|
+
result = self._values.get("resource_types")
|
|
2528
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
|
2529
|
+
|
|
2530
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
2531
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
2532
|
+
|
|
2533
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
2534
|
+
return not (rhs == self)
|
|
2535
|
+
|
|
2536
|
+
def __repr__(self) -> str:
|
|
2537
|
+
return "IndexActionsResourceTypeProperty(%s)" % ", ".join(
|
|
2538
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
2539
|
+
)
|
|
2540
|
+
|
|
2463
2541
|
@jsii.data_type(
|
|
2464
2542
|
jsii_type="aws-cdk-lib.aws_backup.CfnBackupPlan.LifecycleResourceTypeProperty",
|
|
2465
2543
|
jsii_struct_bases=[],
|
|
@@ -2602,6 +2680,9 @@ class CfnBackupPlanProps:
|
|
|
2602
2680
|
)
|
|
2603
2681
|
)],
|
|
2604
2682
|
enable_continuous_backup=False,
|
|
2683
|
+
index_actions=[backup.CfnBackupPlan.IndexActionsResourceTypeProperty(
|
|
2684
|
+
resource_types=["resourceTypes"]
|
|
2685
|
+
)],
|
|
2605
2686
|
lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
|
|
2606
2687
|
delete_after_days=123,
|
|
2607
2688
|
move_to_cold_storage_after_days=123,
|
|
@@ -7803,6 +7884,7 @@ def _typecheckingstub__a15d5028e47f5757a8c2319a31ccf993bd398f0a4476991c75f1e1c3b
|
|
|
7803
7884
|
completion_window_minutes: typing.Optional[jsii.Number] = None,
|
|
7804
7885
|
copy_actions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnBackupPlan.CopyActionResourceTypeProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
7805
7886
|
enable_continuous_backup: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
7887
|
+
index_actions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnBackupPlan.IndexActionsResourceTypeProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
7806
7888
|
lifecycle: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnBackupPlan.LifecycleResourceTypeProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7807
7889
|
recovery_point_tags: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
|
|
7808
7890
|
schedule_expression: typing.Optional[builtins.str] = None,
|
|
@@ -7820,6 +7902,13 @@ def _typecheckingstub__b0175b5c6dd7a96151259f5cc498692c56086843795ca19e3f9f69670
|
|
|
7820
7902
|
"""Type checking stubs"""
|
|
7821
7903
|
pass
|
|
7822
7904
|
|
|
7905
|
+
def _typecheckingstub__da981045a3cee9f5e8fc63c128c7e612a5dc43d041acf8903816ac5b23b3827f(
|
|
7906
|
+
*,
|
|
7907
|
+
resource_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
7908
|
+
) -> None:
|
|
7909
|
+
"""Type checking stubs"""
|
|
7910
|
+
pass
|
|
7911
|
+
|
|
7823
7912
|
def _typecheckingstub__b9cc85d565a0bdd44f5b8b5d29dce7bae38cfd50437c39a049e1b16bd8a24c1e(
|
|
7824
7913
|
*,
|
|
7825
7914
|
delete_after_days: typing.Optional[jsii.Number] = None,
|
aws_cdk/aws_batch/__init__.py
CHANGED
|
@@ -1028,7 +1028,7 @@ class CfnComputeEnvironment(
|
|
|
1028
1028
|
:param service_role: The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see `AWS Batch service IAM role <https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html>`_ in the *AWS Batch User Guide* . .. epigraph:: If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account. If your specified role has a path other than ``/`` , then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` , specify ``/foo/bar`` as the role name. For more information, see `Friendly names and paths <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names>`_ in the *IAM User Guide* . .. epigraph:: Depending on how you created your AWS Batch service role, its ARN might contain the ``service-role`` path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the ``service-role`` path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
|
|
1029
1029
|
:param state: The state of the compute environment. If the state is ``ENABLED`` , then the compute environment accepts jobs from a queue and can scale out automatically based on queues. If the state is ``ENABLED`` , then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand. If the state is ``DISABLED`` , then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a ``STARTING`` or ``RUNNING`` state continue to progress normally. Managed compute environments in the ``DISABLED`` state don't scale out. .. epigraph:: Compute environments in a ``DISABLED`` state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see `State <https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state>`_ in the *AWS Batch User Guide* . When an instance is idle, the instance scales down to the ``minvCpus`` value. However, the instance size doesn't change. For example, consider a ``c5.8xlarge`` instance with a ``minvCpus`` value of ``4`` and a ``desiredvCpus`` value of ``36`` . This instance doesn't scale down to a ``c5.large`` instance.
|
|
1030
1030
|
:param tags: The tags applied to the compute environment.
|
|
1031
|
-
:param unmanagedv_cpus: The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair
|
|
1031
|
+
:param unmanagedv_cpus: The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved. .. epigraph:: This parameter is only supported when the ``type`` parameter is set to ``UNMANAGED`` .
|
|
1032
1032
|
:param update_policy: Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see `Updating compute environments <https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html>`_ in the *AWS Batch User Guide* .
|
|
1033
1033
|
'''
|
|
1034
1034
|
if __debug__:
|
|
@@ -2359,7 +2359,7 @@ class CfnComputeEnvironmentProps:
|
|
|
2359
2359
|
:param service_role: The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see `AWS Batch service IAM role <https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html>`_ in the *AWS Batch User Guide* . .. epigraph:: If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account. If your specified role has a path other than ``/`` , then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` , specify ``/foo/bar`` as the role name. For more information, see `Friendly names and paths <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names>`_ in the *IAM User Guide* . .. epigraph:: Depending on how you created your AWS Batch service role, its ARN might contain the ``service-role`` path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the ``service-role`` path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
|
|
2360
2360
|
:param state: The state of the compute environment. If the state is ``ENABLED`` , then the compute environment accepts jobs from a queue and can scale out automatically based on queues. If the state is ``ENABLED`` , then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand. If the state is ``DISABLED`` , then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a ``STARTING`` or ``RUNNING`` state continue to progress normally. Managed compute environments in the ``DISABLED`` state don't scale out. .. epigraph:: Compute environments in a ``DISABLED`` state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see `State <https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state>`_ in the *AWS Batch User Guide* . When an instance is idle, the instance scales down to the ``minvCpus`` value. However, the instance size doesn't change. For example, consider a ``c5.8xlarge`` instance with a ``minvCpus`` value of ``4`` and a ``desiredvCpus`` value of ``36`` . This instance doesn't scale down to a ``c5.large`` instance.
|
|
2361
2361
|
:param tags: The tags applied to the compute environment.
|
|
2362
|
-
:param unmanagedv_cpus: The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair
|
|
2362
|
+
:param unmanagedv_cpus: The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved. .. epigraph:: This parameter is only supported when the ``type`` parameter is set to ``UNMANAGED`` .
|
|
2363
2363
|
:param update_policy: Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see `Updating compute environments <https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html>`_ in the *AWS Batch User Guide* .
|
|
2364
2364
|
|
|
2365
2365
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html
|
|
@@ -2596,7 +2596,7 @@ class CfnComputeEnvironmentProps:
|
|
|
2596
2596
|
def unmanagedv_cpus(self) -> typing.Optional[jsii.Number]:
|
|
2597
2597
|
'''The maximum number of vCPUs for an unmanaged compute environment.
|
|
2598
2598
|
|
|
2599
|
-
This parameter is only used for fair
|
|
2599
|
+
This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.
|
|
2600
2600
|
.. epigraph::
|
|
2601
2601
|
|
|
2602
2602
|
This parameter is only supported when the ``type`` parameter is set to ``UNMANAGED`` .
|
|
@@ -2682,7 +2682,7 @@ class CfnJobDefinition(
|
|
|
2682
2682
|
:param platform_capabilities: The platform capabilities required by the job definition. If no value is specified, it defaults to ``EC2`` . Jobs run on Fargate resources specify ``FARGATE`` .
|
|
2683
2683
|
:param propagate_tags: Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the ``FAILED`` state.
|
|
2684
2684
|
:param retry_strategy: The retry strategy to use for failed jobs that are submitted with this job definition.
|
|
2685
|
-
:param scheduling_priority: The scheduling priority of the job definition. This only affects jobs in job queues with a fair
|
|
2685
|
+
:param scheduling_priority: The scheduling priority of the job definition. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
|
|
2686
2686
|
:param tags: The tags that are applied to the job definition.
|
|
2687
2687
|
:param timeout: The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.
|
|
2688
2688
|
'''
|
|
@@ -5795,7 +5795,7 @@ class CfnJobDefinition(
|
|
|
5795
5795
|
|
|
5796
5796
|
:param devices: Any of the host devices to expose to the container. This parameter maps to ``Devices`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/>`_ and the ``--device`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ . .. epigraph:: This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
|
|
5797
5797
|
:param init_process_enabled: If true, run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version | grep "Server API version"``
|
|
5798
|
-
:param max_swap: The total amount of swap memory (in MiB) a container can use. This parameter is translated to the ``--memory-swap`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ where the value is the sum of the container memory plus the ``maxSwap`` value. For more information, see ```--memory-swap`` details <https://docs.aws.amazon.com/https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details>`_ in the Docker documentation. If a ``maxSwap`` value of ``0`` is specified, the container doesn't use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container doesn't use the swap configuration for the container instance
|
|
5798
|
+
:param max_swap: The total amount of swap memory (in MiB) a container can use. This parameter is translated to the ``--memory-swap`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ where the value is the sum of the container memory plus the ``maxSwap`` value. For more information, see ```--memory-swap`` details <https://docs.aws.amazon.com/https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details>`_ in the Docker documentation. If a ``maxSwap`` value of ``0`` is specified, the container doesn't use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container doesn't use the swap configuration for the container instance on which it runs. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used. .. epigraph:: This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
|
|
5799
5799
|
:param shared_memory_size: The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ . .. epigraph:: This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
|
|
5800
5800
|
:param swappiness: You can use this parameter to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` causes swapping to not occur unless absolutely necessary. A ``swappiness`` value of ``100`` causes pages to be swapped aggressively. Valid values are whole numbers between ``0`` and ``100`` . If the ``swappiness`` parameter isn't specified, a default value of ``60`` is used. If a value isn't specified for ``maxSwap`` , then this parameter is ignored. If ``maxSwap`` is set to 0, the container doesn't use swap. This parameter maps to the ``--memory-swappiness`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ . Consider the following when you use a per-container swap configuration. - Swap space must be enabled and allocated on the container instance for the containers to use. .. epigraph:: By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see `Instance store swap volumes <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html>`_ in the *Amazon EC2 User Guide for Linux Instances* or `How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file? <https://docs.aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/>`_ - The swap space parameters are only supported for job definitions using EC2 resources. - If the ``maxSwap`` and ``swappiness`` parameters are omitted from a job definition, each container has a default ``swappiness`` value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container. .. epigraph:: This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
|
|
5801
5801
|
:param tmpfs: The container path, mount options, and size (in MiB) of the ``tmpfs`` mount. This parameter maps to the ``--tmpfs`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ . .. epigraph:: This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
|
|
@@ -5885,7 +5885,7 @@ class CfnJobDefinition(
|
|
|
5885
5885
|
|
|
5886
5886
|
This parameter is translated to the ``--memory-swap`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ where the value is the sum of the container memory plus the ``maxSwap`` value. For more information, see ```--memory-swap`` details <https://docs.aws.amazon.com/https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details>`_ in the Docker documentation.
|
|
5887
5887
|
|
|
5888
|
-
If a ``maxSwap`` value of ``0`` is specified, the container doesn't use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container doesn't use the swap configuration for the container instance
|
|
5888
|
+
If a ``maxSwap`` value of ``0`` is specified, the container doesn't use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container doesn't use the swap configuration for the container instance on which it runs. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used.
|
|
5889
5889
|
.. epigraph::
|
|
5890
5890
|
|
|
5891
5891
|
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
|
|
@@ -6330,8 +6330,9 @@ class CfnJobDefinition(
|
|
|
6330
6330
|
*,
|
|
6331
6331
|
task_properties: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnJobDefinition.MultiNodeEcsTaskPropertiesProperty", typing.Dict[builtins.str, typing.Any]]]]],
|
|
6332
6332
|
) -> None:
|
|
6333
|
-
'''
|
|
6334
|
-
|
|
6333
|
+
'''An object that contains the properties for the Amazon ECS resources of a job.
|
|
6334
|
+
|
|
6335
|
+
:param task_properties: An object that contains the properties for the Amazon ECS task definition of a job. .. epigraph:: This object is currently limited to one task element. However, the task element can run up to 10 containers.
|
|
6335
6336
|
|
|
6336
6337
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecsproperties.html
|
|
6337
6338
|
:exampleMetadata: fixture=_generated
|
|
@@ -6450,7 +6451,12 @@ class CfnJobDefinition(
|
|
|
6450
6451
|
def task_properties(
|
|
6451
6452
|
self,
|
|
6452
6453
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.MultiNodeEcsTaskPropertiesProperty"]]]:
|
|
6453
|
-
'''
|
|
6454
|
+
'''An object that contains the properties for the Amazon ECS task definition of a job.
|
|
6455
|
+
|
|
6456
|
+
.. epigraph::
|
|
6457
|
+
|
|
6458
|
+
This object is currently limited to one task element. However, the task element can run up to 10 containers.
|
|
6459
|
+
|
|
6454
6460
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecsproperties.html#cfn-batch-jobdefinition-multinodeecsproperties-taskproperties
|
|
6455
6461
|
'''
|
|
6456
6462
|
result = self._values.get("task_properties")
|
|
@@ -6491,13 +6497,16 @@ class CfnJobDefinition(
|
|
|
6491
6497
|
task_role_arn: typing.Optional[builtins.str] = None,
|
|
6492
6498
|
volumes: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnJobDefinition.VolumesProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
6493
6499
|
) -> None:
|
|
6494
|
-
'''
|
|
6495
|
-
|
|
6496
|
-
|
|
6497
|
-
|
|
6498
|
-
:param
|
|
6499
|
-
:param
|
|
6500
|
-
:param
|
|
6500
|
+
'''The properties for a task definition that describes the container and volume definitions of an Amazon ECS task.
|
|
6501
|
+
|
|
6502
|
+
You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.
|
|
6503
|
+
|
|
6504
|
+
:param containers: This object is a list of containers.
|
|
6505
|
+
:param execution_role_arn: The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see `AWS Batch execution IAM role <https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html>`_ in the *AWS Batch User Guide* .
|
|
6506
|
+
:param ipc_mode: The IPC resource namespace to use for the containers in the task. The valid values are ``host`` , ``task`` , or ``none`` . If ``host`` is specified, all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified ``task`` share the same IPC resources. If ``none`` is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see `IPC settings <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc>`_ in the Docker run reference.
|
|
6507
|
+
:param pid_mode: The process namespace to use for the containers in the task. The valid values are ``host`` or ``task`` . For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task. If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the process namespace with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace for each container. For more information, see `PID settings <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid>`_ in the Docker run reference.
|
|
6508
|
+
:param task_role_arn: The Amazon Resource Name (ARN) that's associated with the Amazon ECS task. .. epigraph:: This is object is comparable to `ContainerProperties:jobRoleArn <https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html>`_ .
|
|
6509
|
+
:param volumes: A list of volumes that are associated with the job.
|
|
6501
6510
|
|
|
6502
6511
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html
|
|
6503
6512
|
:exampleMetadata: fixture=_generated
|
|
@@ -6629,7 +6638,8 @@ class CfnJobDefinition(
|
|
|
6629
6638
|
def containers(
|
|
6630
6639
|
self,
|
|
6631
6640
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.TaskContainerPropertiesProperty"]]]]:
|
|
6632
|
-
'''
|
|
6641
|
+
'''This object is a list of containers.
|
|
6642
|
+
|
|
6633
6643
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-containers
|
|
6634
6644
|
'''
|
|
6635
6645
|
result = self._values.get("containers")
|
|
@@ -6637,7 +6647,10 @@ class CfnJobDefinition(
|
|
|
6637
6647
|
|
|
6638
6648
|
@builtins.property
|
|
6639
6649
|
def execution_role_arn(self) -> typing.Optional[builtins.str]:
|
|
6640
|
-
'''
|
|
6650
|
+
'''The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
|
|
6651
|
+
|
|
6652
|
+
For jobs that run on Fargate resources, you must provide an execution role. For more information, see `AWS Batch execution IAM role <https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html>`_ in the *AWS Batch User Guide* .
|
|
6653
|
+
|
|
6641
6654
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-executionrolearn
|
|
6642
6655
|
'''
|
|
6643
6656
|
result = self._values.get("execution_role_arn")
|
|
@@ -6645,7 +6658,18 @@ class CfnJobDefinition(
|
|
|
6645
6658
|
|
|
6646
6659
|
@builtins.property
|
|
6647
6660
|
def ipc_mode(self) -> typing.Optional[builtins.str]:
|
|
6648
|
-
'''
|
|
6661
|
+
'''The IPC resource namespace to use for the containers in the task.
|
|
6662
|
+
|
|
6663
|
+
The valid values are ``host`` , ``task`` , or ``none`` .
|
|
6664
|
+
|
|
6665
|
+
If ``host`` is specified, all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.
|
|
6666
|
+
|
|
6667
|
+
If ``task`` is specified, all containers within the specified ``task`` share the same IPC resources.
|
|
6668
|
+
|
|
6669
|
+
If ``none`` is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.
|
|
6670
|
+
|
|
6671
|
+
If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see `IPC settings <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc>`_ in the Docker run reference.
|
|
6672
|
+
|
|
6649
6673
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-ipcmode
|
|
6650
6674
|
'''
|
|
6651
6675
|
result = self._values.get("ipc_mode")
|
|
@@ -6653,7 +6677,16 @@ class CfnJobDefinition(
|
|
|
6653
6677
|
|
|
6654
6678
|
@builtins.property
|
|
6655
6679
|
def pid_mode(self) -> typing.Optional[builtins.str]:
|
|
6656
|
-
'''
|
|
6680
|
+
'''The process namespace to use for the containers in the task.
|
|
6681
|
+
|
|
6682
|
+
The valid values are ``host`` or ``task`` . For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.
|
|
6683
|
+
|
|
6684
|
+
If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.
|
|
6685
|
+
|
|
6686
|
+
If ``task`` is specified, all containers within the specified task share the same process namespace.
|
|
6687
|
+
|
|
6688
|
+
If no value is specified, the default is a private namespace for each container. For more information, see `PID settings <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid>`_ in the Docker run reference.
|
|
6689
|
+
|
|
6657
6690
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-pidmode
|
|
6658
6691
|
'''
|
|
6659
6692
|
result = self._values.get("pid_mode")
|
|
@@ -6661,7 +6694,12 @@ class CfnJobDefinition(
|
|
|
6661
6694
|
|
|
6662
6695
|
@builtins.property
|
|
6663
6696
|
def task_role_arn(self) -> typing.Optional[builtins.str]:
|
|
6664
|
-
'''
|
|
6697
|
+
'''The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
|
|
6698
|
+
|
|
6699
|
+
.. epigraph::
|
|
6700
|
+
|
|
6701
|
+
This is object is comparable to `ContainerProperties:jobRoleArn <https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html>`_ .
|
|
6702
|
+
|
|
6665
6703
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-taskrolearn
|
|
6666
6704
|
'''
|
|
6667
6705
|
result = self._values.get("task_role_arn")
|
|
@@ -6671,7 +6709,8 @@ class CfnJobDefinition(
|
|
|
6671
6709
|
def volumes(
|
|
6672
6710
|
self,
|
|
6673
6711
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.VolumesProperty"]]]]:
|
|
6674
|
-
'''
|
|
6712
|
+
'''A list of volumes that are associated with the job.
|
|
6713
|
+
|
|
6675
6714
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-volumes
|
|
6676
6715
|
'''
|
|
6677
6716
|
result = self._values.get("volumes")
|
|
@@ -9469,7 +9508,7 @@ class CfnJobDefinitionProps:
|
|
|
9469
9508
|
:param platform_capabilities: The platform capabilities required by the job definition. If no value is specified, it defaults to ``EC2`` . Jobs run on Fargate resources specify ``FARGATE`` .
|
|
9470
9509
|
:param propagate_tags: Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the ``FAILED`` state.
|
|
9471
9510
|
:param retry_strategy: The retry strategy to use for failed jobs that are submitted with this job definition.
|
|
9472
|
-
:param scheduling_priority: The scheduling priority of the job definition. This only affects jobs in job queues with a fair
|
|
9511
|
+
:param scheduling_priority: The scheduling priority of the job definition. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
|
|
9473
9512
|
:param tags: The tags that are applied to the job definition.
|
|
9474
9513
|
:param timeout: The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.
|
|
9475
9514
|
|
|
@@ -9654,7 +9693,7 @@ class CfnJobDefinitionProps:
|
|
|
9654
9693
|
def scheduling_priority(self) -> typing.Optional[jsii.Number]:
|
|
9655
9694
|
'''The scheduling priority of the job definition.
|
|
9656
9695
|
|
|
9657
|
-
This only affects jobs in job queues with a fair
|
|
9696
|
+
This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
|
|
9658
9697
|
|
|
9659
9698
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-schedulingpriority
|
|
9660
9699
|
'''
|
|
@@ -10359,8 +10398,8 @@ class CfnSchedulingPolicy(
|
|
|
10359
10398
|
'''
|
|
10360
10399
|
:param scope: Scope in which this resource is defined.
|
|
10361
10400
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
10362
|
-
:param fairshare_policy: The fair
|
|
10363
|
-
:param name: The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
|
|
10401
|
+
:param fairshare_policy: The fair-share scheduling policy details.
|
|
10402
|
+
:param name: The name of the fair-share scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
|
|
10364
10403
|
:param tags: The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see `Tagging AWS Resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`_ in *AWS General Reference* . These tags can be updated or removed using the `TagResource <https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html>`_ and `UntagResource <https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html>`_ API operations.
|
|
10365
10404
|
'''
|
|
10366
10405
|
if __debug__:
|
|
@@ -10428,7 +10467,7 @@ class CfnSchedulingPolicy(
|
|
|
10428
10467
|
def fairshare_policy(
|
|
10429
10468
|
self,
|
|
10430
10469
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSchedulingPolicy.FairsharePolicyProperty"]]:
|
|
10431
|
-
'''The fair
|
|
10470
|
+
'''The fair-share scheduling policy details.'''
|
|
10432
10471
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSchedulingPolicy.FairsharePolicyProperty"]], jsii.get(self, "fairsharePolicy"))
|
|
10433
10472
|
|
|
10434
10473
|
@fairshare_policy.setter
|
|
@@ -10444,7 +10483,7 @@ class CfnSchedulingPolicy(
|
|
|
10444
10483
|
@builtins.property
|
|
10445
10484
|
@jsii.member(jsii_name="name")
|
|
10446
10485
|
def name(self) -> typing.Optional[builtins.str]:
|
|
10447
|
-
'''The name of the scheduling policy.'''
|
|
10486
|
+
'''The name of the fair-share scheduling policy.'''
|
|
10448
10487
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "name"))
|
|
10449
10488
|
|
|
10450
10489
|
@name.setter
|
|
@@ -10487,11 +10526,11 @@ class CfnSchedulingPolicy(
|
|
|
10487
10526
|
share_decay_seconds: typing.Optional[jsii.Number] = None,
|
|
10488
10527
|
share_distribution: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnSchedulingPolicy.ShareAttributesProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
10489
10528
|
) -> None:
|
|
10490
|
-
'''The fair
|
|
10529
|
+
'''The fair-share scheduling policy details.
|
|
10491
10530
|
|
|
10492
|
-
:param compute_reservation: A value used to reserve some of the available maximum vCPU for
|
|
10493
|
-
:param share_decay_seconds: The amount of time (in seconds) to use to calculate a fair
|
|
10494
|
-
:param share_distribution: An array of ``SharedIdentifier`` objects that contain the weights for the
|
|
10531
|
+
:param compute_reservation: A value used to reserve some of the available maximum vCPU for share identifiers that aren't already used. The reserved ratio is ``( *computeReservation* /100)^ *ActiveFairShares*`` where ``*ActiveFairShares*`` is the number of active share identifiers. For example, a ``computeReservation`` value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one share identifier. It reserves 25% if there are two share identifiers. It reserves 12.5% if there are three share identifiers. A ``computeReservation`` value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three share identifiers. The minimum value is 0 and the maximum value is 99.
|
|
10532
|
+
:param share_decay_seconds: The amount of time (in seconds) to use to calculate a fair-share percentage for each share identifier in use. A value of zero (0) indicates the default minimum time window (600 seconds). The maximum supported value is 604800 (1 week). The decay allows for more recently run jobs to have more weight than jobs that ran earlier. Consider adjusting this number if you have jobs that (on average) run longer than ten minutes, or a large difference in job count or job run times between share identifiers, and the allocation of resources doesn’t meet your needs.
|
|
10533
|
+
:param share_distribution: An array of ``SharedIdentifier`` objects that contain the weights for the share identifiers for the fair-share policy. Share identifiers that aren't included have a default weight of ``1.0`` .
|
|
10495
10534
|
|
|
10496
10535
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html
|
|
10497
10536
|
:exampleMetadata: fixture=_generated
|
|
@@ -10526,11 +10565,11 @@ class CfnSchedulingPolicy(
|
|
|
10526
10565
|
|
|
10527
10566
|
@builtins.property
|
|
10528
10567
|
def compute_reservation(self) -> typing.Optional[jsii.Number]:
|
|
10529
|
-
'''A value used to reserve some of the available maximum vCPU for
|
|
10568
|
+
'''A value used to reserve some of the available maximum vCPU for share identifiers that aren't already used.
|
|
10530
10569
|
|
|
10531
|
-
The reserved ratio is ``( *computeReservation* /100)^ *ActiveFairShares*`` where ``*ActiveFairShares*`` is the number of active
|
|
10570
|
+
The reserved ratio is ``( *computeReservation* /100)^ *ActiveFairShares*`` where ``*ActiveFairShares*`` is the number of active share identifiers.
|
|
10532
10571
|
|
|
10533
|
-
For example, a ``computeReservation`` value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one
|
|
10572
|
+
For example, a ``computeReservation`` value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one share identifier. It reserves 25% if there are two share identifiers. It reserves 12.5% if there are three share identifiers. A ``computeReservation`` value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three share identifiers.
|
|
10534
10573
|
|
|
10535
10574
|
The minimum value is 0 and the maximum value is 99.
|
|
10536
10575
|
|
|
@@ -10541,7 +10580,7 @@ class CfnSchedulingPolicy(
|
|
|
10541
10580
|
|
|
10542
10581
|
@builtins.property
|
|
10543
10582
|
def share_decay_seconds(self) -> typing.Optional[jsii.Number]:
|
|
10544
|
-
'''The amount of time (in seconds) to use to calculate a fair
|
|
10583
|
+
'''The amount of time (in seconds) to use to calculate a fair-share percentage for each share identifier in use.
|
|
10545
10584
|
|
|
10546
10585
|
A value of zero (0) indicates the default minimum time window (600 seconds). The maximum supported value is 604800 (1 week).
|
|
10547
10586
|
|
|
@@ -10556,9 +10595,9 @@ class CfnSchedulingPolicy(
|
|
|
10556
10595
|
def share_distribution(
|
|
10557
10596
|
self,
|
|
10558
10597
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnSchedulingPolicy.ShareAttributesProperty"]]]]:
|
|
10559
|
-
'''An array of ``SharedIdentifier`` objects that contain the weights for the
|
|
10598
|
+
'''An array of ``SharedIdentifier`` objects that contain the weights for the share identifiers for the fair-share policy.
|
|
10560
10599
|
|
|
10561
|
-
|
|
10600
|
+
Share identifiers that aren't included have a default weight of ``1.0`` .
|
|
10562
10601
|
|
|
10563
10602
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy-sharedistribution
|
|
10564
10603
|
'''
|
|
@@ -10591,12 +10630,12 @@ class CfnSchedulingPolicy(
|
|
|
10591
10630
|
share_identifier: typing.Optional[builtins.str] = None,
|
|
10592
10631
|
weight_factor: typing.Optional[jsii.Number] = None,
|
|
10593
10632
|
) -> None:
|
|
10594
|
-
'''Specifies the weights for the
|
|
10633
|
+
'''Specifies the weights for the share identifiers for the fair-share policy.
|
|
10595
10634
|
|
|
10596
|
-
|
|
10635
|
+
Share identifiers that aren't included have a default weight of ``1.0`` .
|
|
10597
10636
|
|
|
10598
|
-
:param share_identifier: A
|
|
10599
|
-
:param weight_factor: The weight factor for the
|
|
10637
|
+
:param share_identifier: A share identifier or share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for share identifiers that start with that prefix. The list of share identifiers in a fair-share policy can't overlap. For example, you can't have one that specifies a ``shareIdentifier`` of ``UserA*`` and another that specifies a ``shareIdentifier`` of ``UserA-1`` . There can be no more than 500 share identifiers active in a job queue. The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).
|
|
10638
|
+
:param weight_factor: The weight factor for the share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1. The smallest supported value is 0.0001, and the largest supported value is 999.9999.
|
|
10600
10639
|
|
|
10601
10640
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-shareattributes.html
|
|
10602
10641
|
:exampleMetadata: fixture=_generated
|
|
@@ -10624,11 +10663,11 @@ class CfnSchedulingPolicy(
|
|
|
10624
10663
|
|
|
10625
10664
|
@builtins.property
|
|
10626
10665
|
def share_identifier(self) -> typing.Optional[builtins.str]:
|
|
10627
|
-
'''A
|
|
10666
|
+
'''A share identifier or share identifier prefix.
|
|
10628
10667
|
|
|
10629
|
-
If the string ends with an asterisk (*), this entry specifies the weight factor to use for
|
|
10668
|
+
If the string ends with an asterisk (*), this entry specifies the weight factor to use for share identifiers that start with that prefix. The list of share identifiers in a fair-share policy can't overlap. For example, you can't have one that specifies a ``shareIdentifier`` of ``UserA*`` and another that specifies a ``shareIdentifier`` of ``UserA-1`` .
|
|
10630
10669
|
|
|
10631
|
-
There can be no more than 500
|
|
10670
|
+
There can be no more than 500 share identifiers active in a job queue.
|
|
10632
10671
|
|
|
10633
10672
|
The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).
|
|
10634
10673
|
|
|
@@ -10639,7 +10678,7 @@ class CfnSchedulingPolicy(
|
|
|
10639
10678
|
|
|
10640
10679
|
@builtins.property
|
|
10641
10680
|
def weight_factor(self) -> typing.Optional[jsii.Number]:
|
|
10642
|
-
'''The weight factor for the
|
|
10681
|
+
'''The weight factor for the share identifier.
|
|
10643
10682
|
|
|
10644
10683
|
The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1.
|
|
10645
10684
|
|
|
@@ -10681,8 +10720,8 @@ class CfnSchedulingPolicyProps:
|
|
|
10681
10720
|
) -> None:
|
|
10682
10721
|
'''Properties for defining a ``CfnSchedulingPolicy``.
|
|
10683
10722
|
|
|
10684
|
-
:param fairshare_policy: The fair
|
|
10685
|
-
:param name: The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
|
|
10723
|
+
:param fairshare_policy: The fair-share scheduling policy details.
|
|
10724
|
+
:param name: The name of the fair-share scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
|
|
10686
10725
|
:param tags: The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see `Tagging AWS Resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`_ in *AWS General Reference* . These tags can be updated or removed using the `TagResource <https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html>`_ and `UntagResource <https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html>`_ API operations.
|
|
10687
10726
|
|
|
10688
10727
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-schedulingpolicy.html
|
|
@@ -10726,7 +10765,7 @@ class CfnSchedulingPolicyProps:
|
|
|
10726
10765
|
def fairshare_policy(
|
|
10727
10766
|
self,
|
|
10728
10767
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnSchedulingPolicy.FairsharePolicyProperty]]:
|
|
10729
|
-
'''The fair
|
|
10768
|
+
'''The fair-share scheduling policy details.
|
|
10730
10769
|
|
|
10731
10770
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-schedulingpolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy
|
|
10732
10771
|
'''
|
|
@@ -10735,7 +10774,7 @@ class CfnSchedulingPolicyProps:
|
|
|
10735
10774
|
|
|
10736
10775
|
@builtins.property
|
|
10737
10776
|
def name(self) -> typing.Optional[builtins.str]:
|
|
10738
|
-
'''The name of the scheduling policy.
|
|
10777
|
+
'''The name of the fair-share scheduling policy.
|
|
10739
10778
|
|
|
10740
10779
|
It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
|
|
10741
10780
|
|