aws-cdk-lib 2.133.0__py3-none-any.whl → 2.135.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.
- aws_cdk/__init__.py +14 -1
- aws_cdk/_jsii/__init__.py +4 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.133.0.jsii.tgz → aws-cdk-lib@2.135.0.jsii.tgz} +0 -0
- aws_cdk/alexa_ask/__init__.py +3 -0
- aws_cdk/assertions/__init__.py +3 -0
- aws_cdk/aws_accessanalyzer/__init__.py +3 -0
- aws_cdk/aws_acmpca/__init__.py +3 -0
- aws_cdk/aws_amazonmq/__init__.py +3 -0
- aws_cdk/aws_amplify/__init__.py +3 -0
- aws_cdk/aws_amplifyuibuilder/__init__.py +3 -0
- aws_cdk/aws_apigateway/__init__.py +3 -0
- aws_cdk/aws_apigatewayv2/__init__.py +108 -3
- aws_cdk/aws_apigatewayv2_authorizers/__init__.py +3 -0
- aws_cdk/aws_apigatewayv2_integrations/__init__.py +158 -3
- aws_cdk/aws_appconfig/__init__.py +189 -8
- aws_cdk/aws_appflow/__init__.py +3 -0
- aws_cdk/aws_appintegrations/__init__.py +560 -0
- aws_cdk/aws_applicationautoscaling/__init__.py +4 -1
- aws_cdk/aws_applicationinsights/__init__.py +3 -0
- aws_cdk/aws_appmesh/__init__.py +4 -1
- aws_cdk/aws_apprunner/__init__.py +3 -0
- aws_cdk/aws_appstream/__init__.py +3 -0
- aws_cdk/aws_appsync/__init__.py +74 -0
- aws_cdk/aws_aps/__init__.py +805 -1
- aws_cdk/aws_arczonalshift/__init__.py +3 -0
- aws_cdk/aws_athena/__init__.py +3 -0
- aws_cdk/aws_auditmanager/__init__.py +3 -0
- aws_cdk/aws_autoscaling/__init__.py +9 -4
- aws_cdk/aws_autoscaling_common/__init__.py +3 -0
- aws_cdk/aws_autoscaling_hooktargets/__init__.py +3 -0
- aws_cdk/aws_autoscalingplans/__init__.py +3 -0
- aws_cdk/aws_b2bi/__init__.py +3 -0
- aws_cdk/aws_backup/__init__.py +26 -12
- aws_cdk/aws_backupgateway/__init__.py +3 -0
- aws_cdk/aws_batch/__init__.py +426 -73
- aws_cdk/aws_bedrock/__init__.py +200 -2
- aws_cdk/aws_billingconductor/__init__.py +3 -0
- aws_cdk/aws_budgets/__init__.py +3 -0
- aws_cdk/aws_cassandra/__init__.py +3 -0
- aws_cdk/aws_ce/__init__.py +3 -0
- aws_cdk/aws_certificatemanager/__init__.py +3 -0
- aws_cdk/aws_chatbot/__init__.py +3 -0
- aws_cdk/aws_cleanrooms/__init__.py +183 -6
- aws_cdk/aws_cloud9/__init__.py +3 -0
- aws_cdk/aws_cloudformation/__init__.py +4 -1
- aws_cdk/aws_cloudfront/__init__.py +5 -2
- aws_cdk/aws_cloudfront/experimental/__init__.py +3 -0
- aws_cdk/aws_cloudfront_origins/__init__.py +3 -0
- aws_cdk/aws_cloudtrail/__init__.py +47 -14
- aws_cdk/aws_cloudwatch/__init__.py +21 -0
- aws_cdk/aws_cloudwatch_actions/__init__.py +3 -0
- aws_cdk/aws_codeartifact/__init__.py +815 -2
- aws_cdk/aws_codebuild/__init__.py +38 -16
- aws_cdk/aws_codecommit/__init__.py +3 -0
- aws_cdk/aws_codedeploy/__init__.py +3 -0
- aws_cdk/aws_codeguruprofiler/__init__.py +3 -0
- aws_cdk/aws_codegurureviewer/__init__.py +3 -0
- aws_cdk/aws_codepipeline/__init__.py +27 -8
- aws_cdk/aws_codepipeline_actions/__init__.py +3 -0
- aws_cdk/aws_codestar/__init__.py +3 -0
- aws_cdk/aws_codestarconnections/__init__.py +91 -2
- aws_cdk/aws_codestarnotifications/__init__.py +3 -0
- aws_cdk/aws_cognito/__init__.py +44 -40
- aws_cdk/aws_comprehend/__init__.py +3 -0
- aws_cdk/aws_config/__init__.py +3 -0
- aws_cdk/aws_connect/__init__.py +277 -0
- aws_cdk/aws_connectcampaigns/__init__.py +3 -0
- aws_cdk/aws_controltower/__init__.py +3 -0
- aws_cdk/aws_cur/__init__.py +3 -0
- aws_cdk/aws_customerprofiles/__init__.py +3 -0
- aws_cdk/aws_databrew/__init__.py +3 -0
- aws_cdk/aws_datapipeline/__init__.py +3 -0
- aws_cdk/aws_datasync/__init__.py +396 -13
- aws_cdk/aws_datazone/__init__.py +3 -0
- aws_cdk/aws_dax/__init__.py +3 -0
- aws_cdk/aws_detective/__init__.py +3 -0
- aws_cdk/aws_devicefarm/__init__.py +3 -0
- aws_cdk/aws_devopsguru/__init__.py +3 -0
- aws_cdk/aws_directoryservice/__init__.py +3 -0
- aws_cdk/aws_dlm/__init__.py +5 -2
- aws_cdk/aws_dms/__init__.py +30 -9
- aws_cdk/aws_docdb/__init__.py +3 -0
- aws_cdk/aws_docdbelastic/__init__.py +128 -0
- aws_cdk/aws_dynamodb/__init__.py +419 -5
- aws_cdk/aws_ec2/__init__.py +3530 -504
- aws_cdk/aws_ecr/__init__.py +3 -0
- aws_cdk/aws_ecr_assets/__init__.py +3 -0
- aws_cdk/aws_ecs/__init__.py +12 -4
- aws_cdk/aws_ecs_patterns/__init__.py +3 -0
- aws_cdk/aws_efs/__init__.py +3 -0
- aws_cdk/aws_eks/__init__.py +69 -47
- aws_cdk/aws_elasticache/__init__.py +3 -0
- aws_cdk/aws_elasticbeanstalk/__init__.py +3 -0
- aws_cdk/aws_elasticloadbalancing/__init__.py +3 -0
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +431 -72
- aws_cdk/aws_elasticloadbalancingv2_actions/__init__.py +3 -0
- aws_cdk/aws_elasticloadbalancingv2_targets/__init__.py +3 -0
- aws_cdk/aws_elasticsearch/__init__.py +3 -0
- aws_cdk/aws_emr/__init__.py +3 -0
- aws_cdk/aws_emrcontainers/__init__.py +3 -0
- aws_cdk/aws_emrserverless/__init__.py +3 -0
- aws_cdk/aws_entityresolution/__init__.py +96 -66
- aws_cdk/aws_events/__init__.py +3 -0
- aws_cdk/aws_events_targets/__init__.py +3 -0
- aws_cdk/aws_eventschemas/__init__.py +3 -0
- aws_cdk/aws_evidently/__init__.py +3 -0
- aws_cdk/aws_finspace/__init__.py +3 -0
- aws_cdk/aws_fis/__init__.py +3 -0
- aws_cdk/aws_fms/__init__.py +3 -0
- aws_cdk/aws_forecast/__init__.py +3 -0
- aws_cdk/aws_frauddetector/__init__.py +3 -0
- aws_cdk/aws_fsx/__init__.py +3 -0
- aws_cdk/aws_gamelift/__init__.py +3 -0
- aws_cdk/aws_globalaccelerator/__init__.py +5 -2
- aws_cdk/aws_globalaccelerator_endpoints/__init__.py +3 -0
- aws_cdk/aws_glue/__init__.py +147 -3
- aws_cdk/aws_grafana/__init__.py +3 -0
- aws_cdk/aws_greengrass/__init__.py +3 -0
- aws_cdk/aws_greengrassv2/__init__.py +3 -0
- aws_cdk/aws_groundstation/__init__.py +3 -0
- aws_cdk/aws_guardduty/__init__.py +3 -0
- aws_cdk/aws_healthimaging/__init__.py +3 -0
- aws_cdk/aws_healthlake/__init__.py +3 -0
- aws_cdk/aws_iam/__init__.py +12 -10
- aws_cdk/aws_identitystore/__init__.py +3 -0
- aws_cdk/aws_imagebuilder/__init__.py +3 -0
- aws_cdk/aws_inspector/__init__.py +3 -0
- aws_cdk/aws_inspectorv2/__init__.py +3 -0
- aws_cdk/aws_internetmonitor/__init__.py +88 -0
- aws_cdk/aws_iot/__init__.py +3 -0
- aws_cdk/aws_iot1click/__init__.py +3 -0
- aws_cdk/aws_iotanalytics/__init__.py +3 -0
- aws_cdk/aws_iotcoredeviceadvisor/__init__.py +3 -0
- aws_cdk/aws_iotevents/__init__.py +3 -0
- aws_cdk/aws_iotfleethub/__init__.py +3 -0
- aws_cdk/aws_iotfleetwise/__init__.py +3 -0
- aws_cdk/aws_iotsitewise/__init__.py +138 -55
- aws_cdk/aws_iotthingsgraph/__init__.py +3 -0
- aws_cdk/aws_iottwinmaker/__init__.py +3 -0
- aws_cdk/aws_iotwireless/__init__.py +3 -0
- aws_cdk/aws_ivs/__init__.py +3 -0
- aws_cdk/aws_ivschat/__init__.py +3 -0
- aws_cdk/aws_kafkaconnect/__init__.py +1239 -161
- aws_cdk/aws_kendra/__init__.py +56 -39
- aws_cdk/aws_kendraranking/__init__.py +3 -0
- aws_cdk/aws_kinesis/__init__.py +3 -0
- aws_cdk/aws_kinesisanalytics/__init__.py +40 -37
- aws_cdk/aws_kinesisanalyticsv2/__init__.py +40 -37
- aws_cdk/aws_kinesisfirehose/__init__.py +14 -3
- aws_cdk/aws_kinesisvideo/__init__.py +3 -0
- aws_cdk/aws_kms/__init__.py +3 -0
- aws_cdk/aws_lakeformation/__init__.py +3 -0
- aws_cdk/aws_lambda/__init__.py +9 -0
- aws_cdk/aws_lambda_destinations/__init__.py +3 -0
- aws_cdk/aws_lambda_event_sources/__init__.py +45 -18
- aws_cdk/aws_lambda_nodejs/__init__.py +3 -0
- aws_cdk/aws_lex/__init__.py +3 -0
- aws_cdk/aws_licensemanager/__init__.py +3 -0
- aws_cdk/aws_lightsail/__init__.py +3 -0
- aws_cdk/aws_location/__init__.py +3 -0
- aws_cdk/aws_logs/__init__.py +3 -0
- aws_cdk/aws_logs_destinations/__init__.py +3 -0
- aws_cdk/aws_lookoutequipment/__init__.py +3 -0
- aws_cdk/aws_lookoutmetrics/__init__.py +3 -0
- aws_cdk/aws_lookoutvision/__init__.py +3 -0
- aws_cdk/aws_m2/__init__.py +3 -0
- aws_cdk/aws_macie/__init__.py +3 -0
- aws_cdk/aws_managedblockchain/__init__.py +5 -3
- aws_cdk/aws_mediaconnect/__init__.py +3 -0
- aws_cdk/aws_mediaconvert/__init__.py +3 -0
- aws_cdk/aws_medialive/__init__.py +3 -0
- aws_cdk/aws_mediapackage/__init__.py +3 -0
- aws_cdk/aws_mediapackagev2/__init__.py +3 -0
- aws_cdk/aws_mediastore/__init__.py +3 -0
- aws_cdk/aws_mediatailor/__init__.py +3 -0
- aws_cdk/aws_memorydb/__init__.py +3 -0
- aws_cdk/aws_msk/__init__.py +91 -0
- aws_cdk/aws_mwaa/__init__.py +3 -0
- aws_cdk/aws_neptune/__init__.py +3 -0
- aws_cdk/aws_neptunegraph/__init__.py +3 -0
- aws_cdk/aws_networkfirewall/__init__.py +3 -0
- aws_cdk/aws_networkmanager/__init__.py +3 -0
- aws_cdk/aws_nimblestudio/__init__.py +3 -0
- aws_cdk/aws_oam/__init__.py +6 -3
- aws_cdk/aws_omics/__init__.py +3 -0
- aws_cdk/aws_opensearchserverless/__init__.py +3 -0
- aws_cdk/aws_opensearchservice/__init__.py +26 -18
- aws_cdk/aws_opsworks/__init__.py +3 -0
- aws_cdk/aws_opsworkscm/__init__.py +3 -0
- aws_cdk/aws_organizations/__init__.py +3 -0
- aws_cdk/aws_osis/__init__.py +3 -0
- aws_cdk/aws_panorama/__init__.py +3 -0
- aws_cdk/aws_pcaconnectorad/__init__.py +3 -0
- aws_cdk/aws_personalize/__init__.py +3 -0
- aws_cdk/aws_pinpoint/__init__.py +45 -0
- aws_cdk/aws_pinpointemail/__init__.py +3 -0
- aws_cdk/aws_pipes/__init__.py +3 -0
- aws_cdk/aws_proton/__init__.py +3 -0
- aws_cdk/aws_qldb/__init__.py +3 -0
- aws_cdk/aws_quicksight/__init__.py +3 -0
- aws_cdk/aws_ram/__init__.py +3 -0
- aws_cdk/aws_rds/__init__.py +150 -27
- aws_cdk/aws_redshift/__init__.py +3 -0
- aws_cdk/aws_redshiftserverless/__init__.py +3 -0
- aws_cdk/aws_refactorspaces/__init__.py +3 -0
- aws_cdk/aws_rekognition/__init__.py +3 -0
- aws_cdk/aws_resiliencehub/__init__.py +3 -0
- aws_cdk/aws_resourceexplorer2/__init__.py +3 -0
- aws_cdk/aws_resourcegroups/__init__.py +3 -0
- aws_cdk/aws_robomaker/__init__.py +3 -0
- aws_cdk/aws_rolesanywhere/__init__.py +3 -0
- aws_cdk/aws_route53/__init__.py +52 -0
- aws_cdk/aws_route53_patterns/__init__.py +3 -0
- aws_cdk/aws_route53_targets/__init__.py +3 -0
- aws_cdk/aws_route53recoverycontrol/__init__.py +3 -0
- aws_cdk/aws_route53recoveryreadiness/__init__.py +3 -0
- aws_cdk/aws_route53resolver/__init__.py +3 -0
- aws_cdk/aws_rum/__init__.py +3 -0
- aws_cdk/aws_s3/__init__.py +3 -0
- aws_cdk/aws_s3_assets/__init__.py +3 -0
- aws_cdk/aws_s3_deployment/__init__.py +3 -0
- aws_cdk/aws_s3_notifications/__init__.py +3 -0
- aws_cdk/aws_s3express/__init__.py +3 -0
- aws_cdk/aws_s3objectlambda/__init__.py +3 -0
- aws_cdk/aws_s3outposts/__init__.py +3 -0
- aws_cdk/aws_sagemaker/__init__.py +5 -2
- aws_cdk/aws_sam/__init__.py +3 -0
- aws_cdk/aws_scheduler/__init__.py +3 -0
- aws_cdk/aws_sdb/__init__.py +3 -0
- aws_cdk/aws_secretsmanager/__init__.py +3 -0
- aws_cdk/aws_securityhub/__init__.py +59 -14
- aws_cdk/aws_securitylake/__init__.py +859 -0
- aws_cdk/aws_servicecatalog/__init__.py +3 -0
- aws_cdk/aws_servicecatalogappregistry/__init__.py +3 -0
- aws_cdk/aws_servicediscovery/__init__.py +3 -0
- aws_cdk/aws_ses/__init__.py +3 -0
- aws_cdk/aws_ses_actions/__init__.py +3 -0
- aws_cdk/aws_shield/__init__.py +3 -0
- aws_cdk/aws_signer/__init__.py +3 -0
- aws_cdk/aws_simspaceweaver/__init__.py +3 -0
- aws_cdk/aws_sns/__init__.py +48 -13
- aws_cdk/aws_sns_subscriptions/__init__.py +3 -0
- aws_cdk/aws_sqs/__init__.py +3 -0
- aws_cdk/aws_ssm/__init__.py +6 -3
- aws_cdk/aws_ssmcontacts/__init__.py +3 -0
- aws_cdk/aws_ssmincidents/__init__.py +3 -0
- aws_cdk/aws_sso/__init__.py +3 -0
- aws_cdk/aws_stepfunctions/__init__.py +3 -0
- aws_cdk/aws_stepfunctions_tasks/__init__.py +26 -0
- aws_cdk/aws_supportapp/__init__.py +3 -0
- aws_cdk/aws_synthetics/__init__.py +77 -14
- aws_cdk/aws_systemsmanagersap/__init__.py +3 -0
- aws_cdk/aws_timestream/__init__.py +3 -0
- aws_cdk/aws_transfer/__init__.py +7 -3
- aws_cdk/aws_verifiedpermissions/__init__.py +3 -0
- aws_cdk/aws_voiceid/__init__.py +3 -0
- aws_cdk/aws_vpclattice/__init__.py +3 -0
- aws_cdk/aws_waf/__init__.py +3 -0
- aws_cdk/aws_wafregional/__init__.py +3 -0
- aws_cdk/aws_wafv2/__init__.py +99 -46
- aws_cdk/aws_wisdom/__init__.py +3 -0
- aws_cdk/aws_workspaces/__init__.py +3 -0
- aws_cdk/aws_workspacesthinclient/__init__.py +3 -0
- aws_cdk/aws_workspacesweb/__init__.py +3 -0
- aws_cdk/aws_xray/__init__.py +3 -0
- aws_cdk/cloud_assembly_schema/__init__.py +3 -0
- aws_cdk/cloudformation_include/__init__.py +3 -0
- aws_cdk/custom_resources/__init__.py +7 -4
- aws_cdk/cx_api/__init__.py +20 -0
- aws_cdk/lambda_layer_awscli/__init__.py +3 -0
- aws_cdk/lambda_layer_kubectl/__init__.py +3 -0
- aws_cdk/lambda_layer_node_proxy_agent/__init__.py +3 -0
- aws_cdk/pipelines/__init__.py +3 -0
- aws_cdk/region_info/__init__.py +3 -0
- aws_cdk/triggers/__init__.py +3 -0
- {aws_cdk_lib-2.133.0.dist-info → aws_cdk_lib-2.135.0.dist-info}/METADATA +2 -2
- aws_cdk_lib-2.135.0.dist-info/RECORD +282 -0
- aws_cdk_lib-2.133.0.dist-info/RECORD +0 -281
- {aws_cdk_lib-2.133.0.dist-info → aws_cdk_lib-2.135.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.133.0.dist-info → aws_cdk_lib-2.135.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.133.0.dist-info → aws_cdk_lib-2.135.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.133.0.dist-info → aws_cdk_lib-2.135.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_batch/__init__.py
CHANGED
|
@@ -680,6 +680,9 @@ user = iam.User(self, "MyUser")
|
|
|
680
680
|
ecs_job.grant_submit_job(user, queue)
|
|
681
681
|
```
|
|
682
682
|
'''
|
|
683
|
+
from pkgutil import extend_path
|
|
684
|
+
__path__ = extend_path(__path__, __name__)
|
|
685
|
+
|
|
683
686
|
import abc
|
|
684
687
|
import builtins
|
|
685
688
|
import datetime
|
|
@@ -2402,7 +2405,7 @@ class CfnJobDefinition(
|
|
|
2402
2405
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
2403
2406
|
:param type: The type of job definition. For more information about multi-node parallel jobs, see `Creating a multi-node parallel job definition <https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html>`_ in the *AWS Batch User Guide* . - If the value is ``container`` , then one of the following is required: ``containerProperties`` , ``ecsProperties`` , or ``eksProperties`` . - If the value is ``multinode`` , then ``nodeProperties`` is required. .. epigraph:: If the job is run on Fargate resources, then ``multinode`` isn't supported.
|
|
2404
2407
|
:param container_properties: An object with properties specific to Amazon ECS-based jobs. When ``containerProperties`` is used in the job definition, it can't be used in addition to ``eksProperties`` , ``ecsProperties`` , or ``nodeProperties`` .
|
|
2405
|
-
:param ecs_properties:
|
|
2408
|
+
:param ecs_properties: An object that contains the properties for the Amazon ECS resources of a job.When ``ecsProperties`` is used in the job definition, it can't be used in addition to ``containerProperties`` , ``eksProperties`` , or ``nodeProperties`` .
|
|
2406
2409
|
:param eks_properties: An object with properties that are specific to Amazon EKS-based jobs. When ``eksProperties`` is used in the job definition, it can't be used in addition to ``containerProperties`` , ``ecsProperties`` , or ``nodeProperties`` .
|
|
2407
2410
|
:param job_definition_name: The name of the job definition.
|
|
2408
2411
|
:param node_properties: An object with properties that are specific to multi-node parallel jobs. When ``nodeProperties`` is used in the job definition, it can't be used in addition to ``containerProperties`` , ``ecsProperties`` , or ``eksProperties`` . .. epigraph:: If the job runs on Fargate resources, don't specify ``nodeProperties`` . Use ``containerProperties`` instead.
|
|
@@ -2521,6 +2524,7 @@ class CfnJobDefinition(
|
|
|
2521
2524
|
def ecs_properties(
|
|
2522
2525
|
self,
|
|
2523
2526
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.EcsPropertiesProperty"]]:
|
|
2527
|
+
'''An object that contains the properties for the Amazon ECS resources of a job.When ``ecsProperties`` is used in the job definition, it can't be used in addition to ``containerProperties`` , ``eksProperties`` , or ``nodeProperties`` .'''
|
|
2524
2528
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.EcsPropertiesProperty"]], jsii.get(self, "ecsProperties"))
|
|
2525
2529
|
|
|
2526
2530
|
@ecs_properties.setter
|
|
@@ -3459,8 +3463,9 @@ class CfnJobDefinition(
|
|
|
3459
3463
|
*,
|
|
3460
3464
|
task_properties: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnJobDefinition.EcsTaskPropertiesProperty", typing.Dict[builtins.str, typing.Any]]]]],
|
|
3461
3465
|
) -> None:
|
|
3462
|
-
'''
|
|
3463
|
-
|
|
3466
|
+
'''An object that contains the properties for the Amazon ECS resources of a job.
|
|
3467
|
+
|
|
3468
|
+
: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 element.
|
|
3464
3469
|
|
|
3465
3470
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecsproperties.html
|
|
3466
3471
|
:exampleMetadata: fixture=_generated
|
|
@@ -3590,7 +3595,12 @@ class CfnJobDefinition(
|
|
|
3590
3595
|
def task_properties(
|
|
3591
3596
|
self,
|
|
3592
3597
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.EcsTaskPropertiesProperty"]]]:
|
|
3593
|
-
'''
|
|
3598
|
+
'''An object that contains the properties for the Amazon ECS task definition of a job.
|
|
3599
|
+
|
|
3600
|
+
.. epigraph::
|
|
3601
|
+
|
|
3602
|
+
This object is currently limited to one element.
|
|
3603
|
+
|
|
3594
3604
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecsproperties.html#cfn-batch-jobdefinition-ecsproperties-taskproperties
|
|
3595
3605
|
'''
|
|
3596
3606
|
result = self._values.get("task_properties")
|
|
@@ -3639,17 +3649,20 @@ class CfnJobDefinition(
|
|
|
3639
3649
|
task_role_arn: typing.Optional[builtins.str] = None,
|
|
3640
3650
|
volumes: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnJobDefinition.VolumesProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
3641
3651
|
) -> None:
|
|
3642
|
-
'''
|
|
3643
|
-
|
|
3644
|
-
|
|
3645
|
-
|
|
3646
|
-
:param
|
|
3647
|
-
:param
|
|
3648
|
-
:param
|
|
3649
|
-
:param
|
|
3650
|
-
:param
|
|
3651
|
-
:param
|
|
3652
|
-
:param
|
|
3652
|
+
'''The properties for a task definition that describes the container and volume definitions of an Amazon ECS task.
|
|
3653
|
+
|
|
3654
|
+
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.
|
|
3655
|
+
|
|
3656
|
+
:param containers: This object is a list of containers.
|
|
3657
|
+
:param ephemeral_storage: The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate .
|
|
3658
|
+
: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* .
|
|
3659
|
+
: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.
|
|
3660
|
+
:param network_configuration: The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
|
|
3661
|
+
: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.
|
|
3662
|
+
:param platform_version: The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the ``LATEST`` platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see `AWS Fargate platform versions <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
3663
|
+
:param runtime_platform: An object that represents the compute environment architecture for AWS Batch jobs on Fargate.
|
|
3664
|
+
: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>`_ .
|
|
3665
|
+
:param volumes: A list of volumes that are associated with the job.
|
|
3653
3666
|
|
|
3654
3667
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html
|
|
3655
3668
|
:exampleMetadata: fixture=_generated
|
|
@@ -3804,7 +3817,8 @@ class CfnJobDefinition(
|
|
|
3804
3817
|
def containers(
|
|
3805
3818
|
self,
|
|
3806
3819
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.TaskContainerPropertiesProperty"]]]]:
|
|
3807
|
-
'''
|
|
3820
|
+
'''This object is a list of containers.
|
|
3821
|
+
|
|
3808
3822
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-containers
|
|
3809
3823
|
'''
|
|
3810
3824
|
result = self._values.get("containers")
|
|
@@ -3814,7 +3828,10 @@ class CfnJobDefinition(
|
|
|
3814
3828
|
def ephemeral_storage(
|
|
3815
3829
|
self,
|
|
3816
3830
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.EphemeralStorageProperty"]]:
|
|
3817
|
-
'''
|
|
3831
|
+
'''The amount of ephemeral storage to allocate for the task.
|
|
3832
|
+
|
|
3833
|
+
This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate .
|
|
3834
|
+
|
|
3818
3835
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-ephemeralstorage
|
|
3819
3836
|
'''
|
|
3820
3837
|
result = self._values.get("ephemeral_storage")
|
|
@@ -3822,7 +3839,10 @@ class CfnJobDefinition(
|
|
|
3822
3839
|
|
|
3823
3840
|
@builtins.property
|
|
3824
3841
|
def execution_role_arn(self) -> typing.Optional[builtins.str]:
|
|
3825
|
-
'''
|
|
3842
|
+
'''The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
|
|
3843
|
+
|
|
3844
|
+
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* .
|
|
3845
|
+
|
|
3826
3846
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-executionrolearn
|
|
3827
3847
|
'''
|
|
3828
3848
|
result = self._values.get("execution_role_arn")
|
|
@@ -3830,7 +3850,18 @@ class CfnJobDefinition(
|
|
|
3830
3850
|
|
|
3831
3851
|
@builtins.property
|
|
3832
3852
|
def ipc_mode(self) -> typing.Optional[builtins.str]:
|
|
3833
|
-
'''
|
|
3853
|
+
'''The IPC resource namespace to use for the containers in the task.
|
|
3854
|
+
|
|
3855
|
+
The valid values are ``host`` , ``task`` , or ``none`` .
|
|
3856
|
+
|
|
3857
|
+
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.
|
|
3858
|
+
|
|
3859
|
+
If ``task`` is specified, all containers within the specified ``task`` share the same IPC resources.
|
|
3860
|
+
|
|
3861
|
+
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.
|
|
3862
|
+
|
|
3863
|
+
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.
|
|
3864
|
+
|
|
3834
3865
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-ipcmode
|
|
3835
3866
|
'''
|
|
3836
3867
|
result = self._values.get("ipc_mode")
|
|
@@ -3840,7 +3871,10 @@ class CfnJobDefinition(
|
|
|
3840
3871
|
def network_configuration(
|
|
3841
3872
|
self,
|
|
3842
3873
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.NetworkConfigurationProperty"]]:
|
|
3843
|
-
'''
|
|
3874
|
+
'''The network configuration for jobs that are running on Fargate resources.
|
|
3875
|
+
|
|
3876
|
+
Jobs that are running on Amazon EC2 resources must not specify this parameter.
|
|
3877
|
+
|
|
3844
3878
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-networkconfiguration
|
|
3845
3879
|
'''
|
|
3846
3880
|
result = self._values.get("network_configuration")
|
|
@@ -3848,7 +3882,16 @@ class CfnJobDefinition(
|
|
|
3848
3882
|
|
|
3849
3883
|
@builtins.property
|
|
3850
3884
|
def pid_mode(self) -> typing.Optional[builtins.str]:
|
|
3851
|
-
'''
|
|
3885
|
+
'''The process namespace to use for the containers in the task.
|
|
3886
|
+
|
|
3887
|
+
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.
|
|
3888
|
+
|
|
3889
|
+
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.
|
|
3890
|
+
|
|
3891
|
+
If ``task`` is specified, all containers within the specified task share the same process namespace.
|
|
3892
|
+
|
|
3893
|
+
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.
|
|
3894
|
+
|
|
3852
3895
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-pidmode
|
|
3853
3896
|
'''
|
|
3854
3897
|
result = self._values.get("pid_mode")
|
|
@@ -3856,7 +3899,10 @@ class CfnJobDefinition(
|
|
|
3856
3899
|
|
|
3857
3900
|
@builtins.property
|
|
3858
3901
|
def platform_version(self) -> typing.Optional[builtins.str]:
|
|
3859
|
-
'''
|
|
3902
|
+
'''The Fargate platform version where the jobs are running.
|
|
3903
|
+
|
|
3904
|
+
A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the ``LATEST`` platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see `AWS Fargate platform versions <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
3905
|
+
|
|
3860
3906
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-platformversion
|
|
3861
3907
|
'''
|
|
3862
3908
|
result = self._values.get("platform_version")
|
|
@@ -3866,7 +3912,8 @@ class CfnJobDefinition(
|
|
|
3866
3912
|
def runtime_platform(
|
|
3867
3913
|
self,
|
|
3868
3914
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.RuntimePlatformProperty"]]:
|
|
3869
|
-
'''
|
|
3915
|
+
'''An object that represents the compute environment architecture for AWS Batch jobs on Fargate.
|
|
3916
|
+
|
|
3870
3917
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-runtimeplatform
|
|
3871
3918
|
'''
|
|
3872
3919
|
result = self._values.get("runtime_platform")
|
|
@@ -3874,7 +3921,12 @@ class CfnJobDefinition(
|
|
|
3874
3921
|
|
|
3875
3922
|
@builtins.property
|
|
3876
3923
|
def task_role_arn(self) -> typing.Optional[builtins.str]:
|
|
3877
|
-
'''
|
|
3924
|
+
'''The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
|
|
3925
|
+
|
|
3926
|
+
.. epigraph::
|
|
3927
|
+
|
|
3928
|
+
This is object is comparable to `ContainerProperties:jobRoleArn <https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html>`_ .
|
|
3929
|
+
|
|
3878
3930
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-taskrolearn
|
|
3879
3931
|
'''
|
|
3880
3932
|
result = self._values.get("task_role_arn")
|
|
@@ -3884,7 +3936,8 @@ class CfnJobDefinition(
|
|
|
3884
3936
|
def volumes(
|
|
3885
3937
|
self,
|
|
3886
3938
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.VolumesProperty"]]]]:
|
|
3887
|
-
'''
|
|
3939
|
+
'''A list of volumes that are associated with the job.
|
|
3940
|
+
|
|
3888
3941
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-volumes
|
|
3889
3942
|
'''
|
|
3890
3943
|
result = self._values.get("volumes")
|
|
@@ -6093,8 +6146,8 @@ class CfnJobDefinition(
|
|
|
6093
6146
|
|
|
6094
6147
|
:param target_nodes: The range of nodes, using node index values. A range of ``0:3`` indicates nodes with index values of ``0`` through ``3`` . If the starting range value is omitted ( ``:n`` ), then ``0`` is used to start the range. If the ending range value is omitted ( ``n:`` ), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes ( ``0:n`` ). You can nest node ranges (for example, ``0:10`` and ``4:5`` ). In this case, the ``4:5`` range properties override the ``0:10`` properties.
|
|
6095
6148
|
:param container: The container details for the node range.
|
|
6096
|
-
:param ecs_properties:
|
|
6097
|
-
:param instance_types:
|
|
6149
|
+
:param ecs_properties: This is an object that represents the properties of the node range for a multi-node parallel job.
|
|
6150
|
+
:param instance_types: The instance types of the underlying host infrastructure of a multi-node parallel job. .. epigraph:: This parameter isn't applicable to jobs that are running on Fargate resources. In addition, this list object is currently limited to one element.
|
|
6098
6151
|
|
|
6099
6152
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html
|
|
6100
6153
|
:exampleMetadata: fixture=_generated
|
|
@@ -6360,7 +6413,8 @@ class CfnJobDefinition(
|
|
|
6360
6413
|
def ecs_properties(
|
|
6361
6414
|
self,
|
|
6362
6415
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.EcsPropertiesProperty"]]:
|
|
6363
|
-
'''
|
|
6416
|
+
'''This is an object that represents the properties of the node range for a multi-node parallel job.
|
|
6417
|
+
|
|
6364
6418
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-ecsproperties
|
|
6365
6419
|
'''
|
|
6366
6420
|
result = self._values.get("ecs_properties")
|
|
@@ -6368,7 +6422,14 @@ class CfnJobDefinition(
|
|
|
6368
6422
|
|
|
6369
6423
|
@builtins.property
|
|
6370
6424
|
def instance_types(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6371
|
-
'''
|
|
6425
|
+
'''The instance types of the underlying host infrastructure of a multi-node parallel job.
|
|
6426
|
+
|
|
6427
|
+
.. epigraph::
|
|
6428
|
+
|
|
6429
|
+
This parameter isn't applicable to jobs that are running on Fargate resources.
|
|
6430
|
+
|
|
6431
|
+
In addition, this list object is currently limited to one element.
|
|
6432
|
+
|
|
6372
6433
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-instancetypes
|
|
6373
6434
|
'''
|
|
6374
6435
|
result = self._values.get("instance_types")
|
|
@@ -6417,10 +6478,10 @@ class CfnJobDefinition(
|
|
|
6417
6478
|
:param containers: The properties of the container that's used on the Amazon EKS pod.
|
|
6418
6479
|
:param dns_policy: The DNS policy for the pod. The default value is ``ClusterFirst`` . If the ``hostNetwork`` parameter is not specified, the default is ``ClusterFirstWithHostNet`` . ``ClusterFirst`` indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see `Pod's DNS policy <https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy>`_ in the *Kubernetes documentation* . Valid values: ``Default`` | ``ClusterFirst`` | ``ClusterFirstWithHostNet``
|
|
6419
6480
|
:param host_network: Indicates if the pod uses the hosts' network IP address. The default value is ``true`` . Setting this to ``false`` enables the Kubernetes pod networking model. Most AWS Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see `Host namespaces <https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces>`_ and `Pod networking <https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking>`_ in the *Kubernetes documentation* .
|
|
6420
|
-
:param init_containers:
|
|
6481
|
+
:param init_containers: These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see `Init Containers <https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/workloads/pods/init-containers/>`_ in the *Kubernetes documentation* . .. epigraph:: This object is limited to 10 elements
|
|
6421
6482
|
:param metadata: Metadata about the Kubernetes pod. For more information, see `Understanding Kubernetes Objects <https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/>`_ in the *Kubernetes documentation* .
|
|
6422
6483
|
:param service_account_name: The name of the service account that's used to run the pod. For more information, see `Kubernetes service accounts <https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html>`_ and `Configure a Kubernetes service account to assume an IAM role <https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html>`_ in the *Amazon EKS User Guide* and `Configure service accounts for pods <https://docs.aws.amazon.com/https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/>`_ in the *Kubernetes documentation* .
|
|
6423
|
-
:param share_process_namespace:
|
|
6484
|
+
:param share_process_namespace: Indicates if the processes in a container are shared, or visible, to other containers in the same pod. For more information, see `Share Process Namespace between Containers in a Pod <https://docs.aws.amazon.com/https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/>`_ .
|
|
6424
6485
|
:param volumes: Specifies the volumes for a job definition that uses Amazon EKS resources.
|
|
6425
6486
|
|
|
6426
6487
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html
|
|
@@ -6595,7 +6656,13 @@ class CfnJobDefinition(
|
|
|
6595
6656
|
def init_containers(
|
|
6596
6657
|
self,
|
|
6597
6658
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.EksContainerProperty"]]]]:
|
|
6598
|
-
'''
|
|
6659
|
+
'''These containers run before application containers, always runs to completion, and must complete successfully before the next container starts.
|
|
6660
|
+
|
|
6661
|
+
These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see `Init Containers <https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/workloads/pods/init-containers/>`_ in the *Kubernetes documentation* .
|
|
6662
|
+
.. epigraph::
|
|
6663
|
+
|
|
6664
|
+
This object is limited to 10 elements
|
|
6665
|
+
|
|
6599
6666
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-initcontainers
|
|
6600
6667
|
'''
|
|
6601
6668
|
result = self._values.get("init_containers")
|
|
@@ -6629,7 +6696,10 @@ class CfnJobDefinition(
|
|
|
6629
6696
|
def share_process_namespace(
|
|
6630
6697
|
self,
|
|
6631
6698
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
6632
|
-
'''
|
|
6699
|
+
'''Indicates if the processes in a container are shared, or visible, to other containers in the same pod.
|
|
6700
|
+
|
|
6701
|
+
For more information, see `Share Process Namespace between Containers in a Pod <https://docs.aws.amazon.com/https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/>`_ .
|
|
6702
|
+
|
|
6633
6703
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-shareprocessnamespace
|
|
6634
6704
|
'''
|
|
6635
6705
|
result = self._values.get("share_process_namespace")
|
|
@@ -7273,9 +7343,10 @@ class CfnJobDefinition(
|
|
|
7273
7343
|
condition: builtins.str,
|
|
7274
7344
|
container_name: builtins.str,
|
|
7275
7345
|
) -> None:
|
|
7276
|
-
'''
|
|
7277
|
-
|
|
7278
|
-
:param
|
|
7346
|
+
'''A list of containers that this task depends on.
|
|
7347
|
+
|
|
7348
|
+
:param condition: The dependency condition of the container. The following are the available conditions and their behavior:. - ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. - ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. - ``SUCCESS`` - This condition is the same as ``COMPLETE`` , but it also requires that the container exits with a zero status. This condition can't be set on an essential container.
|
|
7349
|
+
:param container_name: A unique identifier for the container.
|
|
7279
7350
|
|
|
7280
7351
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerdependency.html
|
|
7281
7352
|
:exampleMetadata: fixture=_generated
|
|
@@ -7302,7 +7373,12 @@ class CfnJobDefinition(
|
|
|
7302
7373
|
|
|
7303
7374
|
@builtins.property
|
|
7304
7375
|
def condition(self) -> builtins.str:
|
|
7305
|
-
'''
|
|
7376
|
+
'''The dependency condition of the container. The following are the available conditions and their behavior:.
|
|
7377
|
+
|
|
7378
|
+
- ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
|
|
7379
|
+
- ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.
|
|
7380
|
+
- ``SUCCESS`` - This condition is the same as ``COMPLETE`` , but it also requires that the container exits with a zero status. This condition can't be set on an essential container.
|
|
7381
|
+
|
|
7306
7382
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerdependency.html#cfn-batch-jobdefinition-taskcontainerdependency-condition
|
|
7307
7383
|
'''
|
|
7308
7384
|
result = self._values.get("condition")
|
|
@@ -7311,7 +7387,8 @@ class CfnJobDefinition(
|
|
|
7311
7387
|
|
|
7312
7388
|
@builtins.property
|
|
7313
7389
|
def container_name(self) -> builtins.str:
|
|
7314
|
-
'''
|
|
7390
|
+
'''A unique identifier for the container.
|
|
7391
|
+
|
|
7315
7392
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerdependency.html#cfn-batch-jobdefinition-taskcontainerdependency-containername
|
|
7316
7393
|
'''
|
|
7317
7394
|
result = self._values.get("container_name")
|
|
@@ -7372,23 +7449,26 @@ class CfnJobDefinition(
|
|
|
7372
7449
|
ulimits: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnJobDefinition.UlimitProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
7373
7450
|
user: typing.Optional[builtins.str] = None,
|
|
7374
7451
|
) -> None:
|
|
7375
|
-
'''
|
|
7376
|
-
|
|
7377
|
-
|
|
7378
|
-
|
|
7379
|
-
:param
|
|
7380
|
-
:param
|
|
7381
|
-
:param
|
|
7382
|
-
:param
|
|
7383
|
-
:param
|
|
7384
|
-
:param
|
|
7385
|
-
:param
|
|
7386
|
-
:param
|
|
7387
|
-
:param
|
|
7388
|
-
:param
|
|
7389
|
-
:param
|
|
7390
|
-
:param
|
|
7391
|
-
:param
|
|
7452
|
+
'''Container properties are used for Amazon ECS-based job definitions.
|
|
7453
|
+
|
|
7454
|
+
These properties to describe the container that's launched as part of a job.
|
|
7455
|
+
|
|
7456
|
+
:param image: The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest`` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``IMAGE`` parameter of the `*docker run* <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ .
|
|
7457
|
+
:param command: The command that's passed to the container. This parameter maps to ``Cmd`` 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 ``COMMAND`` parameter to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ . For more information, see `Dockerfile reference: CMD <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd>`_ .
|
|
7458
|
+
:param depends_on: A list of containers that this container depends on.
|
|
7459
|
+
:param environment: The environment variables to pass to a container. This parameter maps to Env inthe `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 ``--env`` parameter to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ . .. epigraph:: We don't recommend using plaintext environment variables for sensitive information, such as credential data. > Environment variables cannot start with ``AWS_BATCH`` . This naming convention is reserved for variables that AWS Batch sets.
|
|
7460
|
+
:param essential: If the essential parameter of a container is marked as ``true`` , and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see `Application Architecture <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
7461
|
+
:param linux_parameters: Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information, see `KernelCapabilities <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html>`_ .
|
|
7462
|
+
:param log_configuration: The log configuration specification for the container. This parameter maps to ``LogConfig`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``--log-driver`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ . By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see `Configure logging drivers <https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/>`_ in the *Docker documentation* . .. epigraph:: Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the ``LogConfiguration`` data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 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 ``--format '{{.Server.APIVersion}}'`` .. epigraph:: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see `Amazon ECS container agent configuration <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
7463
|
+
:param mount_points: The mount points for data volumes in your container. This parameter maps to ``Volumes`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the `--volume <https://docs.aws.amazon.com/>`_ option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ . Windows containers can mount whole directories on the same drive as ``$env:ProgramData`` . Windows containers can't mount directories on a different drive, and mount point can't be across drives.
|
|
7464
|
+
:param name: The name of a container. The name can be used as a unique identifier to target your ``dependsOn`` and ``Overrides`` objects.
|
|
7465
|
+
:param privileged: When this parameter is ``true`` , the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``--privileged`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ . .. epigraph:: This parameter is not supported for Windows containers or tasks run on Fargate.
|
|
7466
|
+
:param readonly_root_filesystem: When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``--read-only`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ . .. epigraph:: This parameter is not supported for Windows containers.
|
|
7467
|
+
:param repository_credentials: The private repository authentication credentials to use.
|
|
7468
|
+
:param resource_requirements: The type and amount of a resource to assign to a container. The only supported resource is a GPU.
|
|
7469
|
+
:param secrets: The secrets to pass to the container. For more information, see `Specifying Sensitive Data <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html>`_ in the Amazon Elastic Container Service Developer Guide.
|
|
7470
|
+
:param ulimits: A list of ``ulimits`` to set in the container. If a ``ulimit`` value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to ``Ulimits`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``--ulimit`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ . Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The ``nofile`` resource limit sets a restriction on the number of open files that a container can use. The default ``nofile`` soft limit is ``1024`` and the default hard limit is ``65535`` . This parameter requires version 1.18 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 ``--format '{{.Server.APIVersion}}'`` .. epigraph:: This parameter is not supported for Windows containers.
|
|
7471
|
+
:param user: The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run. .. epigraph:: When running tasks using the ``host`` network mode, don't run containers using the ``root user (UID 0)`` . We recommend using a non-root user for better security. You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer. - ``user`` - ``user:group`` - ``uid`` - ``uid:gid`` - ``user:gi`` - ``uid:group`` .. epigraph:: This parameter is not supported for Windows containers.
|
|
7392
7472
|
|
|
7393
7473
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html
|
|
7394
7474
|
:exampleMetadata: fixture=_generated
|
|
@@ -7524,7 +7604,10 @@ class CfnJobDefinition(
|
|
|
7524
7604
|
|
|
7525
7605
|
@builtins.property
|
|
7526
7606
|
def image(self) -> builtins.str:
|
|
7527
|
-
'''
|
|
7607
|
+
'''The image used to start a container.
|
|
7608
|
+
|
|
7609
|
+
This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest`` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``IMAGE`` parameter of the `*docker run* <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ .
|
|
7610
|
+
|
|
7528
7611
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-image
|
|
7529
7612
|
'''
|
|
7530
7613
|
result = self._values.get("image")
|
|
@@ -7533,7 +7616,10 @@ class CfnJobDefinition(
|
|
|
7533
7616
|
|
|
7534
7617
|
@builtins.property
|
|
7535
7618
|
def command(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
7536
|
-
'''
|
|
7619
|
+
'''The command that's passed to the container.
|
|
7620
|
+
|
|
7621
|
+
This parameter maps to ``Cmd`` 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 ``COMMAND`` parameter to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ . For more information, see `Dockerfile reference: CMD <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd>`_ .
|
|
7622
|
+
|
|
7537
7623
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-command
|
|
7538
7624
|
'''
|
|
7539
7625
|
result = self._values.get("command")
|
|
@@ -7543,7 +7629,8 @@ class CfnJobDefinition(
|
|
|
7543
7629
|
def depends_on(
|
|
7544
7630
|
self,
|
|
7545
7631
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.TaskContainerDependencyProperty"]]]]:
|
|
7546
|
-
'''
|
|
7632
|
+
'''A list of containers that this container depends on.
|
|
7633
|
+
|
|
7547
7634
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-dependson
|
|
7548
7635
|
'''
|
|
7549
7636
|
result = self._values.get("depends_on")
|
|
@@ -7553,7 +7640,13 @@ class CfnJobDefinition(
|
|
|
7553
7640
|
def environment(
|
|
7554
7641
|
self,
|
|
7555
7642
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.EnvironmentProperty"]]]]:
|
|
7556
|
-
'''
|
|
7643
|
+
'''The environment variables to pass to a container.
|
|
7644
|
+
|
|
7645
|
+
This parameter maps to Env inthe `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 ``--env`` parameter to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/>`_ .
|
|
7646
|
+
.. epigraph::
|
|
7647
|
+
|
|
7648
|
+
We don't recommend using plaintext environment variables for sensitive information, such as credential data. > Environment variables cannot start with ``AWS_BATCH`` . This naming convention is reserved for variables that AWS Batch sets.
|
|
7649
|
+
|
|
7557
7650
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-environment
|
|
7558
7651
|
'''
|
|
7559
7652
|
result = self._values.get("environment")
|
|
@@ -7563,7 +7656,12 @@ class CfnJobDefinition(
|
|
|
7563
7656
|
def essential(
|
|
7564
7657
|
self,
|
|
7565
7658
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
7566
|
-
'''
|
|
7659
|
+
'''If the essential parameter of a container is marked as ``true`` , and that container fails or stops for any reason, all other containers that are part of the task are stopped.
|
|
7660
|
+
|
|
7661
|
+
If the ``essential`` parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
|
|
7662
|
+
|
|
7663
|
+
All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see `Application Architecture <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
7664
|
+
|
|
7567
7665
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-essential
|
|
7568
7666
|
'''
|
|
7569
7667
|
result = self._values.get("essential")
|
|
@@ -7573,7 +7671,10 @@ class CfnJobDefinition(
|
|
|
7573
7671
|
def linux_parameters(
|
|
7574
7672
|
self,
|
|
7575
7673
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.LinuxParametersProperty"]]:
|
|
7576
|
-
'''
|
|
7674
|
+
'''Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
|
|
7675
|
+
|
|
7676
|
+
For more information, see `KernelCapabilities <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html>`_ .
|
|
7677
|
+
|
|
7577
7678
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-linuxparameters
|
|
7578
7679
|
'''
|
|
7579
7680
|
result = self._values.get("linux_parameters")
|
|
@@ -7583,7 +7684,20 @@ class CfnJobDefinition(
|
|
|
7583
7684
|
def log_configuration(
|
|
7584
7685
|
self,
|
|
7585
7686
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.LogConfigurationProperty"]]:
|
|
7586
|
-
'''
|
|
7687
|
+
'''The log configuration specification for the container.
|
|
7688
|
+
|
|
7689
|
+
This parameter maps to ``LogConfig`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``--log-driver`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ .
|
|
7690
|
+
|
|
7691
|
+
By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see `Configure logging drivers <https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/>`_ in the *Docker documentation* .
|
|
7692
|
+
.. epigraph::
|
|
7693
|
+
|
|
7694
|
+
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the ``LogConfiguration`` data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
|
|
7695
|
+
|
|
7696
|
+
This parameter requires version 1.18 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 ``--format '{{.Server.APIVersion}}'``
|
|
7697
|
+
.. epigraph::
|
|
7698
|
+
|
|
7699
|
+
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see `Amazon ECS container agent configuration <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
7700
|
+
|
|
7587
7701
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-logconfiguration
|
|
7588
7702
|
'''
|
|
7589
7703
|
result = self._values.get("log_configuration")
|
|
@@ -7593,7 +7707,12 @@ class CfnJobDefinition(
|
|
|
7593
7707
|
def mount_points(
|
|
7594
7708
|
self,
|
|
7595
7709
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.MountPointsProperty"]]]]:
|
|
7596
|
-
'''
|
|
7710
|
+
'''The mount points for data volumes in your container.
|
|
7711
|
+
|
|
7712
|
+
This parameter maps to ``Volumes`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the `--volume <https://docs.aws.amazon.com/>`_ option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ .
|
|
7713
|
+
|
|
7714
|
+
Windows containers can mount whole directories on the same drive as ``$env:ProgramData`` . Windows containers can't mount directories on a different drive, and mount point can't be across drives.
|
|
7715
|
+
|
|
7597
7716
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-mountpoints
|
|
7598
7717
|
'''
|
|
7599
7718
|
result = self._values.get("mount_points")
|
|
@@ -7601,7 +7720,10 @@ class CfnJobDefinition(
|
|
|
7601
7720
|
|
|
7602
7721
|
@builtins.property
|
|
7603
7722
|
def name(self) -> typing.Optional[builtins.str]:
|
|
7604
|
-
'''
|
|
7723
|
+
'''The name of a container.
|
|
7724
|
+
|
|
7725
|
+
The name can be used as a unique identifier to target your ``dependsOn`` and ``Overrides`` objects.
|
|
7726
|
+
|
|
7605
7727
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-name
|
|
7606
7728
|
'''
|
|
7607
7729
|
result = self._values.get("name")
|
|
@@ -7611,7 +7733,13 @@ class CfnJobDefinition(
|
|
|
7611
7733
|
def privileged(
|
|
7612
7734
|
self,
|
|
7613
7735
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
7614
|
-
'''
|
|
7736
|
+
'''When this parameter is ``true`` , the container is given elevated privileges on the host container instance (similar to the ``root`` user).
|
|
7737
|
+
|
|
7738
|
+
This parameter maps to ``Privileged`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``--privileged`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ .
|
|
7739
|
+
.. epigraph::
|
|
7740
|
+
|
|
7741
|
+
This parameter is not supported for Windows containers or tasks run on Fargate.
|
|
7742
|
+
|
|
7615
7743
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-privileged
|
|
7616
7744
|
'''
|
|
7617
7745
|
result = self._values.get("privileged")
|
|
@@ -7621,7 +7749,13 @@ class CfnJobDefinition(
|
|
|
7621
7749
|
def readonly_root_filesystem(
|
|
7622
7750
|
self,
|
|
7623
7751
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
7624
|
-
'''
|
|
7752
|
+
'''When this parameter is true, the container is given read-only access to its root file system.
|
|
7753
|
+
|
|
7754
|
+
This parameter maps to ``ReadonlyRootfs`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``--read-only`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ .
|
|
7755
|
+
.. epigraph::
|
|
7756
|
+
|
|
7757
|
+
This parameter is not supported for Windows containers.
|
|
7758
|
+
|
|
7625
7759
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-readonlyrootfilesystem
|
|
7626
7760
|
'''
|
|
7627
7761
|
result = self._values.get("readonly_root_filesystem")
|
|
@@ -7631,7 +7765,8 @@ class CfnJobDefinition(
|
|
|
7631
7765
|
def repository_credentials(
|
|
7632
7766
|
self,
|
|
7633
7767
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.RepositoryCredentialsProperty"]]:
|
|
7634
|
-
'''
|
|
7768
|
+
'''The private repository authentication credentials to use.
|
|
7769
|
+
|
|
7635
7770
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-repositorycredentials
|
|
7636
7771
|
'''
|
|
7637
7772
|
result = self._values.get("repository_credentials")
|
|
@@ -7641,7 +7776,10 @@ class CfnJobDefinition(
|
|
|
7641
7776
|
def resource_requirements(
|
|
7642
7777
|
self,
|
|
7643
7778
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.ResourceRequirementProperty"]]]]:
|
|
7644
|
-
'''
|
|
7779
|
+
'''The type and amount of a resource to assign to a container.
|
|
7780
|
+
|
|
7781
|
+
The only supported resource is a GPU.
|
|
7782
|
+
|
|
7645
7783
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-resourcerequirements
|
|
7646
7784
|
'''
|
|
7647
7785
|
result = self._values.get("resource_requirements")
|
|
@@ -7651,7 +7789,10 @@ class CfnJobDefinition(
|
|
|
7651
7789
|
def secrets(
|
|
7652
7790
|
self,
|
|
7653
7791
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.SecretProperty"]]]]:
|
|
7654
|
-
'''
|
|
7792
|
+
'''The secrets to pass to the container.
|
|
7793
|
+
|
|
7794
|
+
For more information, see `Specifying Sensitive Data <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html>`_ in the Amazon Elastic Container Service Developer Guide.
|
|
7795
|
+
|
|
7655
7796
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-secrets
|
|
7656
7797
|
'''
|
|
7657
7798
|
result = self._values.get("secrets")
|
|
@@ -7661,7 +7802,17 @@ class CfnJobDefinition(
|
|
|
7661
7802
|
def ulimits(
|
|
7662
7803
|
self,
|
|
7663
7804
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobDefinition.UlimitProperty"]]]]:
|
|
7664
|
-
'''
|
|
7805
|
+
'''A list of ``ulimits`` to set in the container.
|
|
7806
|
+
|
|
7807
|
+
If a ``ulimit`` value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to ``Ulimits`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``--ulimit`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ .
|
|
7808
|
+
|
|
7809
|
+
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The ``nofile`` resource limit sets a restriction on the number of open files that a container can use. The default ``nofile`` soft limit is ``1024`` and the default hard limit is ``65535`` .
|
|
7810
|
+
|
|
7811
|
+
This parameter requires version 1.18 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 ``--format '{{.Server.APIVersion}}'``
|
|
7812
|
+
.. epigraph::
|
|
7813
|
+
|
|
7814
|
+
This parameter is not supported for Windows containers.
|
|
7815
|
+
|
|
7665
7816
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-ulimits
|
|
7666
7817
|
'''
|
|
7667
7818
|
result = self._values.get("ulimits")
|
|
@@ -7669,7 +7820,26 @@ class CfnJobDefinition(
|
|
|
7669
7820
|
|
|
7670
7821
|
@builtins.property
|
|
7671
7822
|
def user(self) -> typing.Optional[builtins.str]:
|
|
7672
|
-
'''
|
|
7823
|
+
'''The user to use inside the container.
|
|
7824
|
+
|
|
7825
|
+
This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
|
|
7826
|
+
.. epigraph::
|
|
7827
|
+
|
|
7828
|
+
When running tasks using the ``host`` network mode, don't run containers using the ``root user (UID 0)`` . We recommend using a non-root user for better security.
|
|
7829
|
+
|
|
7830
|
+
You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer.
|
|
7831
|
+
|
|
7832
|
+
- ``user``
|
|
7833
|
+
- ``user:group``
|
|
7834
|
+
- ``uid``
|
|
7835
|
+
- ``uid:gid``
|
|
7836
|
+
- ``user:gi``
|
|
7837
|
+
- ``uid:group``
|
|
7838
|
+
|
|
7839
|
+
.. epigraph::
|
|
7840
|
+
|
|
7841
|
+
This parameter is not supported for Windows containers.
|
|
7842
|
+
|
|
7673
7843
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-user
|
|
7674
7844
|
'''
|
|
7675
7845
|
result = self._values.get("user")
|
|
@@ -8160,7 +8330,7 @@ class CfnJobDefinitionProps:
|
|
|
8160
8330
|
|
|
8161
8331
|
:param type: The type of job definition. For more information about multi-node parallel jobs, see `Creating a multi-node parallel job definition <https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html>`_ in the *AWS Batch User Guide* . - If the value is ``container`` , then one of the following is required: ``containerProperties`` , ``ecsProperties`` , or ``eksProperties`` . - If the value is ``multinode`` , then ``nodeProperties`` is required. .. epigraph:: If the job is run on Fargate resources, then ``multinode`` isn't supported.
|
|
8162
8332
|
:param container_properties: An object with properties specific to Amazon ECS-based jobs. When ``containerProperties`` is used in the job definition, it can't be used in addition to ``eksProperties`` , ``ecsProperties`` , or ``nodeProperties`` .
|
|
8163
|
-
:param ecs_properties:
|
|
8333
|
+
:param ecs_properties: An object that contains the properties for the Amazon ECS resources of a job.When ``ecsProperties`` is used in the job definition, it can't be used in addition to ``containerProperties`` , ``eksProperties`` , or ``nodeProperties`` .
|
|
8164
8334
|
:param eks_properties: An object with properties that are specific to Amazon EKS-based jobs. When ``eksProperties`` is used in the job definition, it can't be used in addition to ``containerProperties`` , ``ecsProperties`` , or ``nodeProperties`` .
|
|
8165
8335
|
:param job_definition_name: The name of the job definition.
|
|
8166
8336
|
:param node_properties: An object with properties that are specific to multi-node parallel jobs. When ``nodeProperties`` is used in the job definition, it can't be used in addition to ``containerProperties`` , ``ecsProperties`` , or ``eksProperties`` . .. epigraph:: If the job runs on Fargate resources, don't specify ``nodeProperties`` . Use ``containerProperties`` instead.
|
|
@@ -8258,7 +8428,8 @@ class CfnJobDefinitionProps:
|
|
|
8258
8428
|
def ecs_properties(
|
|
8259
8429
|
self,
|
|
8260
8430
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnJobDefinition.EcsPropertiesProperty]]:
|
|
8261
|
-
'''
|
|
8431
|
+
'''An object that contains the properties for the Amazon ECS resources of a job.When ``ecsProperties`` is used in the job definition, it can't be used in addition to ``containerProperties`` , ``eksProperties`` , or ``nodeProperties`` .
|
|
8432
|
+
|
|
8262
8433
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-ecsproperties
|
|
8263
8434
|
'''
|
|
8264
8435
|
result = self._values.get("ecs_properties")
|
|
@@ -8422,6 +8593,12 @@ class CfnJobQueue(
|
|
|
8422
8593
|
|
|
8423
8594
|
# the properties below are optional
|
|
8424
8595
|
job_queue_name="jobQueueName",
|
|
8596
|
+
job_state_time_limit_actions=[batch.CfnJobQueue.JobStateTimeLimitActionProperty(
|
|
8597
|
+
action="action",
|
|
8598
|
+
max_time_seconds=123,
|
|
8599
|
+
reason="reason",
|
|
8600
|
+
state="state"
|
|
8601
|
+
)],
|
|
8425
8602
|
scheduling_policy_arn="schedulingPolicyArn",
|
|
8426
8603
|
state="state",
|
|
8427
8604
|
tags={
|
|
@@ -8438,6 +8615,7 @@ class CfnJobQueue(
|
|
|
8438
8615
|
compute_environment_order: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnJobQueue.ComputeEnvironmentOrderProperty", typing.Dict[builtins.str, typing.Any]]]]],
|
|
8439
8616
|
priority: jsii.Number,
|
|
8440
8617
|
job_queue_name: typing.Optional[builtins.str] = None,
|
|
8618
|
+
job_state_time_limit_actions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnJobQueue.JobStateTimeLimitActionProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
8441
8619
|
scheduling_policy_arn: typing.Optional[builtins.str] = None,
|
|
8442
8620
|
state: typing.Optional[builtins.str] = None,
|
|
8443
8621
|
tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
@@ -8448,6 +8626,7 @@ class CfnJobQueue(
|
|
|
8448
8626
|
:param compute_environment_order: The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the ``VALID`` state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 ( ``EC2`` or ``SPOT`` ) or Fargate ( ``FARGATE`` or ``FARGATE_SPOT`` ); EC2 and Fargate compute environments can't be mixed. .. epigraph:: All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
|
|
8449
8627
|
:param priority: The priority of the job queue. Job queues with a higher priority (or a higher integer value for the ``priority`` parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of ``10`` is given scheduling preference over a job queue with a priority value of ``1`` . All of the compute environments must be either EC2 ( ``EC2`` or ``SPOT`` ) or Fargate ( ``FARGATE`` or ``FARGATE_SPOT`` ); EC2 and Fargate compute environments can't be mixed.
|
|
8450
8628
|
:param job_queue_name: The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
|
|
8629
|
+
:param job_state_time_limit_actions: The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after ``maxTimeSeconds`` has passed.
|
|
8451
8630
|
:param scheduling_policy_arn: The Amazon Resource Name (ARN) of the scheduling policy. The format is ``aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name*`` . For example, ``aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`` .
|
|
8452
8631
|
:param state: The state of the job queue. If the job queue state is ``ENABLED`` , it is able to accept jobs. If the job queue state is ``DISABLED`` , new jobs can't be added to the queue, but jobs already in the queue can finish.
|
|
8453
8632
|
:param tags: The tags that are applied to the job queue. For more information, see `Tagging your AWS Batch resources <https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html>`_ in *AWS Batch User Guide* .
|
|
@@ -8460,6 +8639,7 @@ class CfnJobQueue(
|
|
|
8460
8639
|
compute_environment_order=compute_environment_order,
|
|
8461
8640
|
priority=priority,
|
|
8462
8641
|
job_queue_name=job_queue_name,
|
|
8642
|
+
job_state_time_limit_actions=job_state_time_limit_actions,
|
|
8463
8643
|
scheduling_policy_arn=scheduling_policy_arn,
|
|
8464
8644
|
state=state,
|
|
8465
8645
|
tags=tags,
|
|
@@ -8561,6 +8741,24 @@ class CfnJobQueue(
|
|
|
8561
8741
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
8562
8742
|
jsii.set(self, "jobQueueName", value)
|
|
8563
8743
|
|
|
8744
|
+
@builtins.property
|
|
8745
|
+
@jsii.member(jsii_name="jobStateTimeLimitActions")
|
|
8746
|
+
def job_state_time_limit_actions(
|
|
8747
|
+
self,
|
|
8748
|
+
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobQueue.JobStateTimeLimitActionProperty"]]]]:
|
|
8749
|
+
'''The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.'''
|
|
8750
|
+
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobQueue.JobStateTimeLimitActionProperty"]]]], jsii.get(self, "jobStateTimeLimitActions"))
|
|
8751
|
+
|
|
8752
|
+
@job_state_time_limit_actions.setter
|
|
8753
|
+
def job_state_time_limit_actions(
|
|
8754
|
+
self,
|
|
8755
|
+
value: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnJobQueue.JobStateTimeLimitActionProperty"]]]],
|
|
8756
|
+
) -> None:
|
|
8757
|
+
if __debug__:
|
|
8758
|
+
type_hints = typing.get_type_hints(_typecheckingstub__6e248d0029fc3043fabb974edf0f06b8f9f721a8f13ce794fd6c39b5ae3bb91e)
|
|
8759
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
8760
|
+
jsii.set(self, "jobStateTimeLimitActions", value)
|
|
8761
|
+
|
|
8564
8762
|
@builtins.property
|
|
8565
8763
|
@jsii.member(jsii_name="schedulingPolicyArn")
|
|
8566
8764
|
def scheduling_policy_arn(self) -> typing.Optional[builtins.str]:
|
|
@@ -8681,6 +8879,118 @@ class CfnJobQueue(
|
|
|
8681
8879
|
k + "=" + repr(v) for k, v in self._values.items()
|
|
8682
8880
|
)
|
|
8683
8881
|
|
|
8882
|
+
@jsii.data_type(
|
|
8883
|
+
jsii_type="aws-cdk-lib.aws_batch.CfnJobQueue.JobStateTimeLimitActionProperty",
|
|
8884
|
+
jsii_struct_bases=[],
|
|
8885
|
+
name_mapping={
|
|
8886
|
+
"action": "action",
|
|
8887
|
+
"max_time_seconds": "maxTimeSeconds",
|
|
8888
|
+
"reason": "reason",
|
|
8889
|
+
"state": "state",
|
|
8890
|
+
},
|
|
8891
|
+
)
|
|
8892
|
+
class JobStateTimeLimitActionProperty:
|
|
8893
|
+
def __init__(
|
|
8894
|
+
self,
|
|
8895
|
+
*,
|
|
8896
|
+
action: builtins.str,
|
|
8897
|
+
max_time_seconds: jsii.Number,
|
|
8898
|
+
reason: builtins.str,
|
|
8899
|
+
state: builtins.str,
|
|
8900
|
+
) -> None:
|
|
8901
|
+
'''Specifies an action that AWS Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.
|
|
8902
|
+
|
|
8903
|
+
:param action: The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is ``CANCEL`` , which will cancel the job.
|
|
8904
|
+
:param max_time_seconds: The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
|
|
8905
|
+
:param reason: The reason to log for the action being taken.
|
|
8906
|
+
:param state: The state of the job needed to trigger the action. The only supported value is ``RUNNABLE`` .
|
|
8907
|
+
|
|
8908
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html
|
|
8909
|
+
:exampleMetadata: fixture=_generated
|
|
8910
|
+
|
|
8911
|
+
Example::
|
|
8912
|
+
|
|
8913
|
+
# The code below shows an example of how to instantiate this type.
|
|
8914
|
+
# The values are placeholders you should change.
|
|
8915
|
+
from aws_cdk import aws_batch as batch
|
|
8916
|
+
|
|
8917
|
+
job_state_time_limit_action_property = batch.CfnJobQueue.JobStateTimeLimitActionProperty(
|
|
8918
|
+
action="action",
|
|
8919
|
+
max_time_seconds=123,
|
|
8920
|
+
reason="reason",
|
|
8921
|
+
state="state"
|
|
8922
|
+
)
|
|
8923
|
+
'''
|
|
8924
|
+
if __debug__:
|
|
8925
|
+
type_hints = typing.get_type_hints(_typecheckingstub__78ff35092216cfb2ffd2106f7da574c86c17494e3404a6f2ccdc020cc2de0437)
|
|
8926
|
+
check_type(argname="argument action", value=action, expected_type=type_hints["action"])
|
|
8927
|
+
check_type(argname="argument max_time_seconds", value=max_time_seconds, expected_type=type_hints["max_time_seconds"])
|
|
8928
|
+
check_type(argname="argument reason", value=reason, expected_type=type_hints["reason"])
|
|
8929
|
+
check_type(argname="argument state", value=state, expected_type=type_hints["state"])
|
|
8930
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
8931
|
+
"action": action,
|
|
8932
|
+
"max_time_seconds": max_time_seconds,
|
|
8933
|
+
"reason": reason,
|
|
8934
|
+
"state": state,
|
|
8935
|
+
}
|
|
8936
|
+
|
|
8937
|
+
@builtins.property
|
|
8938
|
+
def action(self) -> builtins.str:
|
|
8939
|
+
'''The action to take when a job is at the head of the job queue in the specified state for the specified period of time.
|
|
8940
|
+
|
|
8941
|
+
The only supported value is ``CANCEL`` , which will cancel the job.
|
|
8942
|
+
|
|
8943
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-action
|
|
8944
|
+
'''
|
|
8945
|
+
result = self._values.get("action")
|
|
8946
|
+
assert result is not None, "Required property 'action' is missing"
|
|
8947
|
+
return typing.cast(builtins.str, result)
|
|
8948
|
+
|
|
8949
|
+
@builtins.property
|
|
8950
|
+
def max_time_seconds(self) -> jsii.Number:
|
|
8951
|
+
'''The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken.
|
|
8952
|
+
|
|
8953
|
+
The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
|
|
8954
|
+
|
|
8955
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-maxtimeseconds
|
|
8956
|
+
'''
|
|
8957
|
+
result = self._values.get("max_time_seconds")
|
|
8958
|
+
assert result is not None, "Required property 'max_time_seconds' is missing"
|
|
8959
|
+
return typing.cast(jsii.Number, result)
|
|
8960
|
+
|
|
8961
|
+
@builtins.property
|
|
8962
|
+
def reason(self) -> builtins.str:
|
|
8963
|
+
'''The reason to log for the action being taken.
|
|
8964
|
+
|
|
8965
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-reason
|
|
8966
|
+
'''
|
|
8967
|
+
result = self._values.get("reason")
|
|
8968
|
+
assert result is not None, "Required property 'reason' is missing"
|
|
8969
|
+
return typing.cast(builtins.str, result)
|
|
8970
|
+
|
|
8971
|
+
@builtins.property
|
|
8972
|
+
def state(self) -> builtins.str:
|
|
8973
|
+
'''The state of the job needed to trigger the action.
|
|
8974
|
+
|
|
8975
|
+
The only supported value is ``RUNNABLE`` .
|
|
8976
|
+
|
|
8977
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-state
|
|
8978
|
+
'''
|
|
8979
|
+
result = self._values.get("state")
|
|
8980
|
+
assert result is not None, "Required property 'state' is missing"
|
|
8981
|
+
return typing.cast(builtins.str, result)
|
|
8982
|
+
|
|
8983
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
8984
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
8985
|
+
|
|
8986
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
8987
|
+
return not (rhs == self)
|
|
8988
|
+
|
|
8989
|
+
def __repr__(self) -> str:
|
|
8990
|
+
return "JobStateTimeLimitActionProperty(%s)" % ", ".join(
|
|
8991
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
8992
|
+
)
|
|
8993
|
+
|
|
8684
8994
|
|
|
8685
8995
|
@jsii.data_type(
|
|
8686
8996
|
jsii_type="aws-cdk-lib.aws_batch.CfnJobQueueProps",
|
|
@@ -8689,6 +8999,7 @@ class CfnJobQueue(
|
|
|
8689
8999
|
"compute_environment_order": "computeEnvironmentOrder",
|
|
8690
9000
|
"priority": "priority",
|
|
8691
9001
|
"job_queue_name": "jobQueueName",
|
|
9002
|
+
"job_state_time_limit_actions": "jobStateTimeLimitActions",
|
|
8692
9003
|
"scheduling_policy_arn": "schedulingPolicyArn",
|
|
8693
9004
|
"state": "state",
|
|
8694
9005
|
"tags": "tags",
|
|
@@ -8701,6 +9012,7 @@ class CfnJobQueueProps:
|
|
|
8701
9012
|
compute_environment_order: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnJobQueue.ComputeEnvironmentOrderProperty, typing.Dict[builtins.str, typing.Any]]]]],
|
|
8702
9013
|
priority: jsii.Number,
|
|
8703
9014
|
job_queue_name: typing.Optional[builtins.str] = None,
|
|
9015
|
+
job_state_time_limit_actions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnJobQueue.JobStateTimeLimitActionProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
8704
9016
|
scheduling_policy_arn: typing.Optional[builtins.str] = None,
|
|
8705
9017
|
state: typing.Optional[builtins.str] = None,
|
|
8706
9018
|
tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
@@ -8710,6 +9022,7 @@ class CfnJobQueueProps:
|
|
|
8710
9022
|
:param compute_environment_order: The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the ``VALID`` state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 ( ``EC2`` or ``SPOT`` ) or Fargate ( ``FARGATE`` or ``FARGATE_SPOT`` ); EC2 and Fargate compute environments can't be mixed. .. epigraph:: All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
|
|
8711
9023
|
:param priority: The priority of the job queue. Job queues with a higher priority (or a higher integer value for the ``priority`` parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of ``10`` is given scheduling preference over a job queue with a priority value of ``1`` . All of the compute environments must be either EC2 ( ``EC2`` or ``SPOT`` ) or Fargate ( ``FARGATE`` or ``FARGATE_SPOT`` ); EC2 and Fargate compute environments can't be mixed.
|
|
8712
9024
|
:param job_queue_name: The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
|
|
9025
|
+
:param job_state_time_limit_actions: The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after ``maxTimeSeconds`` has passed.
|
|
8713
9026
|
:param scheduling_policy_arn: The Amazon Resource Name (ARN) of the scheduling policy. The format is ``aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name*`` . For example, ``aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`` .
|
|
8714
9027
|
:param state: The state of the job queue. If the job queue state is ``ENABLED`` , it is able to accept jobs. If the job queue state is ``DISABLED`` , new jobs can't be added to the queue, but jobs already in the queue can finish.
|
|
8715
9028
|
:param tags: The tags that are applied to the job queue. For more information, see `Tagging your AWS Batch resources <https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html>`_ in *AWS Batch User Guide* .
|
|
@@ -8732,6 +9045,12 @@ class CfnJobQueueProps:
|
|
|
8732
9045
|
|
|
8733
9046
|
# the properties below are optional
|
|
8734
9047
|
job_queue_name="jobQueueName",
|
|
9048
|
+
job_state_time_limit_actions=[batch.CfnJobQueue.JobStateTimeLimitActionProperty(
|
|
9049
|
+
action="action",
|
|
9050
|
+
max_time_seconds=123,
|
|
9051
|
+
reason="reason",
|
|
9052
|
+
state="state"
|
|
9053
|
+
)],
|
|
8735
9054
|
scheduling_policy_arn="schedulingPolicyArn",
|
|
8736
9055
|
state="state",
|
|
8737
9056
|
tags={
|
|
@@ -8744,6 +9063,7 @@ class CfnJobQueueProps:
|
|
|
8744
9063
|
check_type(argname="argument compute_environment_order", value=compute_environment_order, expected_type=type_hints["compute_environment_order"])
|
|
8745
9064
|
check_type(argname="argument priority", value=priority, expected_type=type_hints["priority"])
|
|
8746
9065
|
check_type(argname="argument job_queue_name", value=job_queue_name, expected_type=type_hints["job_queue_name"])
|
|
9066
|
+
check_type(argname="argument job_state_time_limit_actions", value=job_state_time_limit_actions, expected_type=type_hints["job_state_time_limit_actions"])
|
|
8747
9067
|
check_type(argname="argument scheduling_policy_arn", value=scheduling_policy_arn, expected_type=type_hints["scheduling_policy_arn"])
|
|
8748
9068
|
check_type(argname="argument state", value=state, expected_type=type_hints["state"])
|
|
8749
9069
|
check_type(argname="argument tags", value=tags, expected_type=type_hints["tags"])
|
|
@@ -8753,6 +9073,8 @@ class CfnJobQueueProps:
|
|
|
8753
9073
|
}
|
|
8754
9074
|
if job_queue_name is not None:
|
|
8755
9075
|
self._values["job_queue_name"] = job_queue_name
|
|
9076
|
+
if job_state_time_limit_actions is not None:
|
|
9077
|
+
self._values["job_state_time_limit_actions"] = job_state_time_limit_actions
|
|
8756
9078
|
if scheduling_policy_arn is not None:
|
|
8757
9079
|
self._values["scheduling_policy_arn"] = scheduling_policy_arn
|
|
8758
9080
|
if state is not None:
|
|
@@ -8800,6 +9122,19 @@ class CfnJobQueueProps:
|
|
|
8800
9122
|
result = self._values.get("job_queue_name")
|
|
8801
9123
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
8802
9124
|
|
|
9125
|
+
@builtins.property
|
|
9126
|
+
def job_state_time_limit_actions(
|
|
9127
|
+
self,
|
|
9128
|
+
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnJobQueue.JobStateTimeLimitActionProperty]]]]:
|
|
9129
|
+
'''The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.
|
|
9130
|
+
|
|
9131
|
+
AWS Batch will perform each action after ``maxTimeSeconds`` has passed.
|
|
9132
|
+
|
|
9133
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobstatetimelimitactions
|
|
9134
|
+
'''
|
|
9135
|
+
result = self._values.get("job_state_time_limit_actions")
|
|
9136
|
+
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnJobQueue.JobStateTimeLimitActionProperty]]]], result)
|
|
9137
|
+
|
|
8803
9138
|
@builtins.property
|
|
8804
9139
|
def scheduling_policy_arn(self) -> typing.Optional[builtins.str]:
|
|
8805
9140
|
'''The Amazon Resource Name (ARN) of the scheduling policy.
|
|
@@ -23015,6 +23350,7 @@ def _typecheckingstub__6480ab252bc515b2cdb6dc0c833877438fd473fd39eadf6b8a064969a
|
|
|
23015
23350
|
compute_environment_order: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnJobQueue.ComputeEnvironmentOrderProperty, typing.Dict[builtins.str, typing.Any]]]]],
|
|
23016
23351
|
priority: jsii.Number,
|
|
23017
23352
|
job_queue_name: typing.Optional[builtins.str] = None,
|
|
23353
|
+
job_state_time_limit_actions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnJobQueue.JobStateTimeLimitActionProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
23018
23354
|
scheduling_policy_arn: typing.Optional[builtins.str] = None,
|
|
23019
23355
|
state: typing.Optional[builtins.str] = None,
|
|
23020
23356
|
tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
@@ -23052,6 +23388,12 @@ def _typecheckingstub__3b88e27e62b46f1049263a61bb14f62674a8121083de64c2db32d5856
|
|
|
23052
23388
|
"""Type checking stubs"""
|
|
23053
23389
|
pass
|
|
23054
23390
|
|
|
23391
|
+
def _typecheckingstub__6e248d0029fc3043fabb974edf0f06b8f9f721a8f13ce794fd6c39b5ae3bb91e(
|
|
23392
|
+
value: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnJobQueue.JobStateTimeLimitActionProperty]]]],
|
|
23393
|
+
) -> None:
|
|
23394
|
+
"""Type checking stubs"""
|
|
23395
|
+
pass
|
|
23396
|
+
|
|
23055
23397
|
def _typecheckingstub__48a6952b4a8d4426554895a52085bf8c88701735f3f94a3426e81e56ab8a5761(
|
|
23056
23398
|
value: typing.Optional[builtins.str],
|
|
23057
23399
|
) -> None:
|
|
@@ -23078,11 +23420,22 @@ def _typecheckingstub__939623842116ecc366f7e36591fb2bdd35bd47aacc55c0a794ff81ec2
|
|
|
23078
23420
|
"""Type checking stubs"""
|
|
23079
23421
|
pass
|
|
23080
23422
|
|
|
23423
|
+
def _typecheckingstub__78ff35092216cfb2ffd2106f7da574c86c17494e3404a6f2ccdc020cc2de0437(
|
|
23424
|
+
*,
|
|
23425
|
+
action: builtins.str,
|
|
23426
|
+
max_time_seconds: jsii.Number,
|
|
23427
|
+
reason: builtins.str,
|
|
23428
|
+
state: builtins.str,
|
|
23429
|
+
) -> None:
|
|
23430
|
+
"""Type checking stubs"""
|
|
23431
|
+
pass
|
|
23432
|
+
|
|
23081
23433
|
def _typecheckingstub__009d6d384b1b723169e64875095e05fe852ae3931adf5ba2004d22475a76caa9(
|
|
23082
23434
|
*,
|
|
23083
23435
|
compute_environment_order: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnJobQueue.ComputeEnvironmentOrderProperty, typing.Dict[builtins.str, typing.Any]]]]],
|
|
23084
23436
|
priority: jsii.Number,
|
|
23085
23437
|
job_queue_name: typing.Optional[builtins.str] = None,
|
|
23438
|
+
job_state_time_limit_actions: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnJobQueue.JobStateTimeLimitActionProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
23086
23439
|
scheduling_policy_arn: typing.Optional[builtins.str] = None,
|
|
23087
23440
|
state: typing.Optional[builtins.str] = None,
|
|
23088
23441
|
tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|