aws-cdk-lib 2.147.3__py3-none-any.whl → 2.148.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 +7 -5
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.147.3.jsii.tgz → aws-cdk-lib@2.148.0.jsii.tgz} +0 -0
- aws_cdk/alexa_ask/__init__.py +1 -1
- aws_cdk/assertions/__init__.py +1 -1
- aws_cdk/aws_accessanalyzer/__init__.py +1 -1
- aws_cdk/aws_acmpca/__init__.py +1 -1
- aws_cdk/aws_amazonmq/__init__.py +1 -1
- aws_cdk/aws_amplify/__init__.py +1 -1
- aws_cdk/aws_amplifyuibuilder/__init__.py +1 -1
- aws_cdk/aws_apigateway/__init__.py +1 -1
- aws_cdk/aws_apigatewayv2/__init__.py +1 -1
- aws_cdk/aws_apigatewayv2_authorizers/__init__.py +1 -1
- aws_cdk/aws_apigatewayv2_integrations/__init__.py +1 -1
- aws_cdk/aws_appconfig/__init__.py +1 -1
- aws_cdk/aws_appflow/__init__.py +1 -1
- aws_cdk/aws_appintegrations/__init__.py +1 -1
- aws_cdk/aws_applicationautoscaling/__init__.py +1 -1
- aws_cdk/aws_applicationinsights/__init__.py +1 -1
- aws_cdk/aws_applicationsignals/__init__.py +143 -87
- aws_cdk/aws_appmesh/__init__.py +1 -1
- aws_cdk/aws_apprunner/__init__.py +1 -1
- aws_cdk/aws_appstream/__init__.py +1 -1
- aws_cdk/aws_appsync/__init__.py +1 -1
- aws_cdk/aws_apptest/__init__.py +3042 -0
- aws_cdk/aws_aps/__init__.py +1 -1
- aws_cdk/aws_arczonalshift/__init__.py +1 -1
- aws_cdk/aws_athena/__init__.py +1 -1
- aws_cdk/aws_auditmanager/__init__.py +1 -1
- aws_cdk/aws_autoscaling/__init__.py +1 -1
- aws_cdk/aws_autoscaling_common/__init__.py +1 -1
- aws_cdk/aws_autoscaling_hooktargets/__init__.py +1 -1
- aws_cdk/aws_autoscalingplans/__init__.py +1 -1
- aws_cdk/aws_b2bi/__init__.py +1 -1
- aws_cdk/aws_backup/__init__.py +4 -6
- aws_cdk/aws_backupgateway/__init__.py +1 -1
- aws_cdk/aws_batch/__init__.py +1 -216
- aws_cdk/aws_bcmdataexports/__init__.py +1 -1
- aws_cdk/aws_bedrock/__init__.py +178 -1
- aws_cdk/aws_billingconductor/__init__.py +1 -1
- aws_cdk/aws_budgets/__init__.py +1 -1
- aws_cdk/aws_cassandra/__init__.py +1 -1
- aws_cdk/aws_ce/__init__.py +1 -1
- aws_cdk/aws_certificatemanager/__init__.py +1 -1
- aws_cdk/aws_chatbot/__init__.py +1 -1
- aws_cdk/aws_cleanrooms/__init__.py +1 -1
- aws_cdk/aws_cleanroomsml/__init__.py +1 -1
- aws_cdk/aws_cloud9/__init__.py +1 -1
- aws_cdk/aws_cloudformation/__init__.py +1 -1
- aws_cdk/aws_cloudfront/__init__.py +1 -1
- aws_cdk/aws_cloudfront/experimental/__init__.py +44 -0
- aws_cdk/aws_cloudfront_origins/__init__.py +1 -1
- aws_cdk/aws_cloudtrail/__init__.py +20 -12
- aws_cdk/aws_cloudwatch/__init__.py +1 -1
- aws_cdk/aws_cloudwatch_actions/__init__.py +1 -1
- aws_cdk/aws_codeartifact/__init__.py +11 -9
- aws_cdk/aws_codebuild/__init__.py +193 -6
- aws_cdk/aws_codecommit/__init__.py +1 -1
- aws_cdk/aws_codeconnections/__init__.py +1 -1
- aws_cdk/aws_codedeploy/__init__.py +35 -4
- aws_cdk/aws_codeguruprofiler/__init__.py +1 -1
- aws_cdk/aws_codegurureviewer/__init__.py +1 -1
- aws_cdk/aws_codepipeline/__init__.py +1 -1
- aws_cdk/aws_codepipeline_actions/__init__.py +1 -1
- aws_cdk/aws_codestar/__init__.py +1 -1
- aws_cdk/aws_codestarconnections/__init__.py +1 -1
- aws_cdk/aws_codestarnotifications/__init__.py +1 -1
- aws_cdk/aws_cognito/__init__.py +56 -18
- aws_cdk/aws_comprehend/__init__.py +1 -1
- aws_cdk/aws_config/__init__.py +1 -1
- aws_cdk/aws_connect/__init__.py +1 -1
- aws_cdk/aws_connectcampaigns/__init__.py +1 -1
- aws_cdk/aws_controltower/__init__.py +1 -1
- aws_cdk/aws_cur/__init__.py +1 -1
- aws_cdk/aws_customerprofiles/__init__.py +1 -1
- aws_cdk/aws_databrew/__init__.py +1 -1
- aws_cdk/aws_datapipeline/__init__.py +1 -1
- aws_cdk/aws_datasync/__init__.py +12 -12
- aws_cdk/aws_datazone/__init__.py +1 -1
- aws_cdk/aws_dax/__init__.py +1 -1
- aws_cdk/aws_deadline/__init__.py +3 -2
- aws_cdk/aws_detective/__init__.py +1 -1
- aws_cdk/aws_devicefarm/__init__.py +1 -1
- aws_cdk/aws_devopsguru/__init__.py +1 -1
- aws_cdk/aws_directoryservice/__init__.py +1 -1
- aws_cdk/aws_dlm/__init__.py +1 -1
- aws_cdk/aws_dms/__init__.py +2 -2
- aws_cdk/aws_docdb/__init__.py +1 -1
- aws_cdk/aws_docdbelastic/__init__.py +1 -1
- aws_cdk/aws_dynamodb/__init__.py +1 -1
- aws_cdk/aws_ec2/__init__.py +24 -26
- aws_cdk/aws_ecr/__init__.py +1 -1
- aws_cdk/aws_ecr_assets/__init__.py +1 -1
- aws_cdk/aws_ecs/__init__.py +29 -25
- aws_cdk/aws_ecs_patterns/__init__.py +1 -1
- aws_cdk/aws_efs/__init__.py +1 -1
- aws_cdk/aws_eks/__init__.py +619 -31
- aws_cdk/aws_elasticache/__init__.py +29 -18
- aws_cdk/aws_elasticbeanstalk/__init__.py +1 -1
- aws_cdk/aws_elasticloadbalancing/__init__.py +1 -1
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +4 -4
- aws_cdk/aws_elasticloadbalancingv2_actions/__init__.py +1 -1
- aws_cdk/aws_elasticloadbalancingv2_targets/__init__.py +1 -1
- aws_cdk/aws_elasticsearch/__init__.py +1 -1
- aws_cdk/aws_emr/__init__.py +1 -1
- aws_cdk/aws_emrcontainers/__init__.py +1 -1
- aws_cdk/aws_emrserverless/__init__.py +34 -7
- aws_cdk/aws_entityresolution/__init__.py +1 -1
- aws_cdk/aws_events/__init__.py +1 -1
- aws_cdk/aws_events_targets/__init__.py +1 -1
- aws_cdk/aws_eventschemas/__init__.py +1 -1
- aws_cdk/aws_evidently/__init__.py +1 -1
- aws_cdk/aws_finspace/__init__.py +1 -1
- aws_cdk/aws_fis/__init__.py +1 -1
- aws_cdk/aws_fms/__init__.py +1 -1
- aws_cdk/aws_forecast/__init__.py +1 -1
- aws_cdk/aws_frauddetector/__init__.py +1 -1
- aws_cdk/aws_fsx/__init__.py +186 -2
- aws_cdk/aws_gamelift/__init__.py +10 -6
- aws_cdk/aws_globalaccelerator/__init__.py +1 -1
- aws_cdk/aws_globalaccelerator_endpoints/__init__.py +1 -1
- aws_cdk/aws_glue/__init__.py +18 -14
- aws_cdk/aws_grafana/__init__.py +9 -5
- aws_cdk/aws_greengrass/__init__.py +1 -1
- aws_cdk/aws_greengrassv2/__init__.py +1 -1
- aws_cdk/aws_groundstation/__init__.py +1 -1
- aws_cdk/aws_guardduty/__init__.py +171 -132
- aws_cdk/aws_healthimaging/__init__.py +1 -1
- aws_cdk/aws_healthlake/__init__.py +1 -1
- aws_cdk/aws_iam/__init__.py +1 -1
- aws_cdk/aws_identitystore/__init__.py +1 -1
- aws_cdk/aws_imagebuilder/__init__.py +1 -1
- aws_cdk/aws_inspector/__init__.py +1 -1
- aws_cdk/aws_inspectorv2/__init__.py +1 -1
- aws_cdk/aws_internetmonitor/__init__.py +1 -1
- aws_cdk/aws_iot/__init__.py +1 -1
- aws_cdk/aws_iot1click/__init__.py +1 -1
- aws_cdk/aws_iotanalytics/__init__.py +1 -1
- aws_cdk/aws_iotcoredeviceadvisor/__init__.py +1 -1
- aws_cdk/aws_iotevents/__init__.py +1 -1
- aws_cdk/aws_iotfleethub/__init__.py +1 -1
- aws_cdk/aws_iotfleetwise/__init__.py +1 -1
- aws_cdk/aws_iotsitewise/__init__.py +1 -1
- aws_cdk/aws_iotthingsgraph/__init__.py +1 -1
- aws_cdk/aws_iottwinmaker/__init__.py +1 -1
- aws_cdk/aws_iotwireless/__init__.py +1 -1
- aws_cdk/aws_ivs/__init__.py +1 -1
- aws_cdk/aws_ivschat/__init__.py +1 -1
- aws_cdk/aws_kafkaconnect/__init__.py +1 -1
- aws_cdk/aws_kendra/__init__.py +1 -1
- aws_cdk/aws_kendraranking/__init__.py +1 -1
- aws_cdk/aws_kinesis/__init__.py +1 -1
- aws_cdk/aws_kinesisanalytics/__init__.py +93 -1
- aws_cdk/aws_kinesisanalyticsv2/__init__.py +93 -1
- aws_cdk/aws_kinesisfirehose/__init__.py +301 -94
- aws_cdk/aws_kinesisvideo/__init__.py +1 -1
- aws_cdk/aws_kms/__init__.py +16 -15
- aws_cdk/aws_lakeformation/__init__.py +1 -1
- aws_cdk/aws_lambda/__init__.py +160 -1
- aws_cdk/aws_lambda_destinations/__init__.py +1 -1
- aws_cdk/aws_lambda_event_sources/__init__.py +1 -1
- aws_cdk/aws_lambda_nodejs/__init__.py +1 -1
- aws_cdk/aws_lex/__init__.py +1 -1
- aws_cdk/aws_licensemanager/__init__.py +1 -1
- aws_cdk/aws_lightsail/__init__.py +1 -1
- aws_cdk/aws_location/__init__.py +1 -1
- aws_cdk/aws_logs/__init__.py +1 -1
- aws_cdk/aws_logs_destinations/__init__.py +1 -1
- aws_cdk/aws_lookoutequipment/__init__.py +1 -1
- aws_cdk/aws_lookoutmetrics/__init__.py +1 -1
- aws_cdk/aws_lookoutvision/__init__.py +1 -1
- aws_cdk/aws_m2/__init__.py +1 -1
- aws_cdk/aws_macie/__init__.py +1 -1
- aws_cdk/aws_managedblockchain/__init__.py +1 -1
- aws_cdk/aws_mediaconnect/__init__.py +1 -1
- aws_cdk/aws_mediaconvert/__init__.py +1 -1
- aws_cdk/aws_medialive/__init__.py +1 -1
- aws_cdk/aws_mediapackage/__init__.py +1 -1
- aws_cdk/aws_mediapackagev2/__init__.py +33 -1
- aws_cdk/aws_mediastore/__init__.py +1 -1
- aws_cdk/aws_mediatailor/__init__.py +1 -1
- aws_cdk/aws_memorydb/__init__.py +1 -1
- aws_cdk/aws_msk/__init__.py +1 -1
- aws_cdk/aws_mwaa/__init__.py +1 -1
- aws_cdk/aws_neptune/__init__.py +1 -1
- aws_cdk/aws_neptunegraph/__init__.py +1 -1
- aws_cdk/aws_networkfirewall/__init__.py +1 -1
- aws_cdk/aws_networkmanager/__init__.py +10 -10
- aws_cdk/aws_nimblestudio/__init__.py +1 -1
- aws_cdk/aws_oam/__init__.py +1 -1
- aws_cdk/aws_omics/__init__.py +2 -2
- aws_cdk/aws_opensearchserverless/__init__.py +1 -1
- aws_cdk/aws_opensearchservice/__init__.py +1 -1
- aws_cdk/aws_opsworks/__init__.py +1 -1
- aws_cdk/aws_opsworkscm/__init__.py +8 -4
- aws_cdk/aws_organizations/__init__.py +1 -1
- aws_cdk/aws_osis/__init__.py +1 -1
- aws_cdk/aws_panorama/__init__.py +1 -1
- aws_cdk/aws_paymentcryptography/__init__.py +1 -1
- aws_cdk/aws_pcaconnectorad/__init__.py +1 -1
- aws_cdk/aws_personalize/__init__.py +1 -1
- aws_cdk/aws_pinpoint/__init__.py +1 -1
- aws_cdk/aws_pinpointemail/__init__.py +1 -1
- aws_cdk/aws_pipes/__init__.py +1 -1
- aws_cdk/aws_proton/__init__.py +1 -1
- aws_cdk/aws_qbusiness/__init__.py +1 -1
- aws_cdk/aws_qldb/__init__.py +1 -1
- aws_cdk/aws_quicksight/__init__.py +1 -1
- aws_cdk/aws_ram/__init__.py +1 -1
- aws_cdk/aws_rds/__init__.py +515 -34
- aws_cdk/aws_redshift/__init__.py +10 -10
- aws_cdk/aws_redshiftserverless/__init__.py +1 -1
- aws_cdk/aws_refactorspaces/__init__.py +1 -1
- aws_cdk/aws_rekognition/__init__.py +1 -1
- aws_cdk/aws_resiliencehub/__init__.py +1 -1
- aws_cdk/aws_resourceexplorer2/__init__.py +1 -1
- aws_cdk/aws_resourcegroups/__init__.py +1 -1
- aws_cdk/aws_robomaker/__init__.py +1 -1
- aws_cdk/aws_rolesanywhere/__init__.py +1 -1
- aws_cdk/aws_route53/__init__.py +1 -1
- aws_cdk/aws_route53_patterns/__init__.py +1 -1
- aws_cdk/aws_route53_targets/__init__.py +1 -1
- aws_cdk/aws_route53profiles/__init__.py +1 -1
- aws_cdk/aws_route53recoverycontrol/__init__.py +1 -1
- aws_cdk/aws_route53recoveryreadiness/__init__.py +1 -1
- aws_cdk/aws_route53resolver/__init__.py +1 -1
- aws_cdk/aws_rum/__init__.py +1 -1
- aws_cdk/aws_s3/__init__.py +30 -6
- aws_cdk/aws_s3_assets/__init__.py +1 -1
- aws_cdk/aws_s3_deployment/__init__.py +1 -1
- aws_cdk/aws_s3_notifications/__init__.py +1 -1
- aws_cdk/aws_s3express/__init__.py +1 -1
- aws_cdk/aws_s3objectlambda/__init__.py +1 -1
- aws_cdk/aws_s3outposts/__init__.py +1 -1
- aws_cdk/aws_sagemaker/__init__.py +1 -1
- aws_cdk/aws_sam/__init__.py +1 -1
- aws_cdk/aws_scheduler/__init__.py +1 -1
- aws_cdk/aws_sdb/__init__.py +1 -1
- aws_cdk/aws_secretsmanager/__init__.py +1 -1
- aws_cdk/aws_securityhub/__init__.py +1 -1
- aws_cdk/aws_securitylake/__init__.py +1 -1
- aws_cdk/aws_servicecatalog/__init__.py +1 -1
- aws_cdk/aws_servicecatalogappregistry/__init__.py +1 -1
- aws_cdk/aws_servicediscovery/__init__.py +21 -4
- aws_cdk/aws_ses/__init__.py +86 -1
- aws_cdk/aws_ses_actions/__init__.py +1 -1
- aws_cdk/aws_shield/__init__.py +1 -1
- aws_cdk/aws_signer/__init__.py +42 -1
- aws_cdk/aws_simspaceweaver/__init__.py +1 -1
- aws_cdk/aws_sns/__init__.py +1 -1
- aws_cdk/aws_sns_subscriptions/__init__.py +1 -1
- aws_cdk/aws_sqs/__init__.py +7 -9
- aws_cdk/aws_ssm/__init__.py +106 -37
- aws_cdk/aws_ssmcontacts/__init__.py +1 -1
- aws_cdk/aws_ssmincidents/__init__.py +1 -1
- aws_cdk/aws_sso/__init__.py +1 -1
- aws_cdk/aws_stepfunctions/__init__.py +1 -1
- aws_cdk/aws_stepfunctions_tasks/__init__.py +793 -152
- aws_cdk/aws_supportapp/__init__.py +1 -1
- aws_cdk/aws_synthetics/__init__.py +1 -1
- aws_cdk/aws_systemsmanagersap/__init__.py +1 -1
- aws_cdk/aws_timestream/__init__.py +1 -1
- aws_cdk/aws_transfer/__init__.py +1 -1
- aws_cdk/aws_verifiedpermissions/__init__.py +602 -9
- aws_cdk/aws_voiceid/__init__.py +1 -1
- aws_cdk/aws_vpclattice/__init__.py +1 -1
- aws_cdk/aws_waf/__init__.py +1 -1
- aws_cdk/aws_wafregional/__init__.py +1 -1
- aws_cdk/aws_wafv2/__init__.py +1 -1
- aws_cdk/aws_wisdom/__init__.py +1 -1
- aws_cdk/aws_workspaces/__init__.py +774 -1
- aws_cdk/aws_workspacesthinclient/__init__.py +1 -1
- aws_cdk/aws_workspacesweb/__init__.py +5 -5
- aws_cdk/aws_xray/__init__.py +1 -1
- aws_cdk/cloud_assembly_schema/__init__.py +1 -1
- aws_cdk/cloudformation_include/__init__.py +1 -1
- aws_cdk/custom_resources/__init__.py +1 -1
- aws_cdk/cx_api/__init__.py +19 -1
- aws_cdk/lambda_layer_awscli/__init__.py +1 -1
- aws_cdk/lambda_layer_kubectl/__init__.py +1 -1
- aws_cdk/lambda_layer_node_proxy_agent/__init__.py +1 -1
- aws_cdk/pipelines/__init__.py +2 -2
- aws_cdk/region_info/__init__.py +1 -1
- aws_cdk/triggers/__init__.py +1 -1
- {aws_cdk_lib-2.147.3.dist-info → aws_cdk_lib-2.148.0.dist-info}/METADATA +2 -2
- aws_cdk_lib-2.148.0.dist-info/RECORD +291 -0
- aws_cdk_lib-2.147.3.dist-info/RECORD +0 -290
- {aws_cdk_lib-2.147.3.dist-info → aws_cdk_lib-2.148.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.147.3.dist-info → aws_cdk_lib-2.148.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.147.3.dist-info → aws_cdk_lib-2.148.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.147.3.dist-info → aws_cdk_lib-2.148.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_dynamodb/__init__.py
CHANGED
aws_cdk/aws_ec2/__init__.py
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
'''
|
|
1
|
+
r'''
|
|
2
2
|
# Amazon EC2 Construct Library
|
|
3
3
|
|
|
4
4
|
The `aws-cdk-lib/aws-ec2` package contains primitives for setting up networking and
|
|
@@ -10232,7 +10232,7 @@ class CfnEC2Fleet(
|
|
|
10232
10232
|
):
|
|
10233
10233
|
'''Specifies the configuration information to launch a fleet--or group--of instances.
|
|
10234
10234
|
|
|
10235
|
-
An EC2 Fleet can launch multiple instance types across multiple Availability Zones, using the On-Demand Instance, Reserved Instance, and Spot Instance purchasing models together. Using EC2 Fleet, you can define separate On-Demand and Spot capacity targets, specify the instance types that work best for your applications, and specify how Amazon EC2 should distribute your fleet capacity within each purchasing model. For more information, see `Launching an EC2 Fleet <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html>`_ in the *Amazon EC2 User Guide
|
|
10235
|
+
An EC2 Fleet can launch multiple instance types across multiple Availability Zones, using the On-Demand Instance, Reserved Instance, and Spot Instance purchasing models together. Using EC2 Fleet, you can define separate On-Demand and Spot capacity targets, specify the instance types that work best for your applications, and specify how Amazon EC2 should distribute your fleet capacity within each purchasing model. For more information, see `Launching an EC2 Fleet <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html>`_ in the *Amazon EC2 User Guide* .
|
|
10236
10236
|
|
|
10237
10237
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html
|
|
10238
10238
|
:cloudformationResource: AWS::EC2::EC2Fleet
|
|
@@ -11680,7 +11680,7 @@ class CfnEC2Fleet(
|
|
|
11680
11680
|
:param instance_generations: Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see `Instance types <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html>`_ in the *Amazon EC2 User Guide* . For current generation instance types, specify ``current`` . For previous generation instance types, specify ``previous`` . Default: Current and previous generation instance types
|
|
11681
11681
|
:param local_storage: Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, `Amazon EC2 instance store <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html>`_ in the *Amazon EC2 User Guide* . - To include instance types with instance store volumes, specify ``included`` . - To require only instance types with instance store volumes, specify ``required`` . - To exclude instance types with instance store volumes, specify ``excluded`` . Default: ``included``
|
|
11682
11682
|
:param local_storage_types: The type of local storage that is required. - For instance types with hard disk drive (HDD) storage, specify ``hdd`` . - For instance types with solid state drive (SSD) storage, specify ``ssd`` . Default: ``hdd`` and ``ssd``
|
|
11683
|
-
:param max_spot_price_as_percentage_of_optimal_on_demand_price: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set ``
|
|
11683
|
+
:param max_spot_price_as_percentage_of_optimal_on_demand_price: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib`` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. .. epigraph:: Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999`` .
|
|
11684
11684
|
:param memory_gib_per_v_cpu: The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits
|
|
11685
11685
|
:param memory_mib: The minimum and maximum amount of memory, in MiB.
|
|
11686
11686
|
:param network_bandwidth_gbps: The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see `Amazon EC2 instance network bandwidth <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html>`_ in the *Amazon EC2 User Guide* . Default: No minimum or maximum limits
|
|
@@ -12078,7 +12078,7 @@ class CfnEC2Fleet(
|
|
|
12078
12078
|
|
|
12079
12079
|
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
|
|
12080
12080
|
|
|
12081
|
-
If you set ``
|
|
12081
|
+
If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib`` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.
|
|
12082
12082
|
.. epigraph::
|
|
12083
12083
|
|
|
12084
12084
|
Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999`` .
|
|
@@ -15855,7 +15855,7 @@ class CfnHost(
|
|
|
15855
15855
|
):
|
|
15856
15856
|
'''Allocates a fully dedicated physical server for launching EC2 instances.
|
|
15857
15857
|
|
|
15858
|
-
Because the host is fully dedicated for your use, it can help you address compliance requirements and reduce costs by allowing you to use your existing server-bound software licenses. For more information, see `Dedicated Hosts <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html>`_ in the *Amazon EC2 User Guide
|
|
15858
|
+
Because the host is fully dedicated for your use, it can help you address compliance requirements and reduce costs by allowing you to use your existing server-bound software licenses. For more information, see `Dedicated Hosts <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html>`_ in the *Amazon EC2 User Guide* .
|
|
15859
15859
|
|
|
15860
15860
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html
|
|
15861
15861
|
:cloudformationResource: AWS::EC2::Host
|
|
@@ -20804,7 +20804,7 @@ class CfnInstance(
|
|
|
20804
20804
|
|
|
20805
20805
|
For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
|
|
20806
20806
|
|
|
20807
|
-
Specifies the type of Elastic GPU. An Elastic GPU is a GPU resource that you can attach to your Amazon EC2 instance to accelerate the graphics performance of your applications.
|
|
20807
|
+
Specifies the type of Elastic GPU. An Elastic GPU is a GPU resource that you can attach to your Amazon EC2 instance to accelerate the graphics performance of your applications.
|
|
20808
20808
|
|
|
20809
20809
|
``ElasticGpuSpecification`` is a property of the `AWS::EC2::Instance <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html>`_ resource.
|
|
20810
20810
|
|
|
@@ -22045,7 +22045,7 @@ class CfnInstanceConnectEndpoint(
|
|
|
22045
22045
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
22046
22046
|
:param subnet_id: The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
|
|
22047
22047
|
:param client_token: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
|
22048
|
-
:param preserve_client_ip: Indicates whether
|
|
22048
|
+
:param preserve_client_ip: Indicates whether the client IP address is preserved as the source. The following are the possible values. - ``true`` - Use the client IP address as the source. - ``false`` - Use the network interface IP address as the source. Default: ``false``
|
|
22049
22049
|
:param security_group_ids: One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for your VPC will be associated with the endpoint.
|
|
22050
22050
|
:param tags: The tags to apply to the EC2 Instance Connect Endpoint during creation.
|
|
22051
22051
|
'''
|
|
@@ -22144,9 +22144,9 @@ class CfnInstanceConnectEndpoint(
|
|
|
22144
22144
|
def preserve_client_ip(
|
|
22145
22145
|
self,
|
|
22146
22146
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
22147
|
-
'''Indicates whether
|
|
22147
|
+
'''Indicates whether the client IP address is preserved as the source.
|
|
22148
22148
|
|
|
22149
|
-
The
|
|
22149
|
+
The following are the possible values.
|
|
22150
22150
|
'''
|
|
22151
22151
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "preserveClientIp"))
|
|
22152
22152
|
|
|
@@ -22215,7 +22215,7 @@ class CfnInstanceConnectEndpointProps:
|
|
|
22215
22215
|
|
|
22216
22216
|
:param subnet_id: The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
|
|
22217
22217
|
:param client_token: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
|
22218
|
-
:param preserve_client_ip: Indicates whether
|
|
22218
|
+
:param preserve_client_ip: Indicates whether the client IP address is preserved as the source. The following are the possible values. - ``true`` - Use the client IP address as the source. - ``false`` - Use the network interface IP address as the source. Default: ``false``
|
|
22219
22219
|
:param security_group_ids: One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for your VPC will be associated with the endpoint.
|
|
22220
22220
|
:param tags: The tags to apply to the EC2 Instance Connect Endpoint during creation.
|
|
22221
22221
|
|
|
@@ -22283,12 +22283,12 @@ class CfnInstanceConnectEndpointProps:
|
|
|
22283
22283
|
def preserve_client_ip(
|
|
22284
22284
|
self,
|
|
22285
22285
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
22286
|
-
'''Indicates whether
|
|
22286
|
+
'''Indicates whether the client IP address is preserved as the source. The following are the possible values.
|
|
22287
22287
|
|
|
22288
|
-
-
|
|
22289
|
-
-
|
|
22288
|
+
- ``true`` - Use the client IP address as the source.
|
|
22289
|
+
- ``false`` - Use the network interface IP address as the source.
|
|
22290
22290
|
|
|
22291
|
-
Default: ``
|
|
22291
|
+
Default: ``false``
|
|
22292
22292
|
|
|
22293
22293
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-preserveclientip
|
|
22294
22294
|
'''
|
|
@@ -25511,7 +25511,7 @@ class CfnLaunchTemplate(
|
|
|
25511
25511
|
:param instance_generations: Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see `Instance types <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html>`_ in the *Amazon EC2 User Guide* . For current generation instance types, specify ``current`` . For previous generation instance types, specify ``previous`` . Default: Current and previous generation instance types
|
|
25512
25512
|
:param local_storage: Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, `Amazon EC2 instance store <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html>`_ in the *Amazon EC2 User Guide* . - To include instance types with instance store volumes, specify ``included`` . - To require only instance types with instance store volumes, specify ``required`` . - To exclude instance types with instance store volumes, specify ``excluded`` . Default: ``included``
|
|
25513
25513
|
:param local_storage_types: The type of local storage that is required. - For instance types with hard disk drive (HDD) storage, specify ``hdd`` . - For instance types with solid state drive (SSD) storage, specify ``ssd`` . Default: ``hdd`` and ``ssd``
|
|
25514
|
-
:param max_spot_price_as_percentage_of_optimal_on_demand_price: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set ``
|
|
25514
|
+
:param max_spot_price_as_percentage_of_optimal_on_demand_price: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib`` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. .. epigraph:: Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999`` .
|
|
25515
25515
|
:param memory_gib_per_v_cpu: The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits
|
|
25516
25516
|
:param memory_mib: The minimum and maximum amount of memory, in MiB.
|
|
25517
25517
|
:param network_bandwidth_gbps: The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits
|
|
@@ -25909,7 +25909,7 @@ class CfnLaunchTemplate(
|
|
|
25909
25909
|
|
|
25910
25910
|
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
|
|
25911
25911
|
|
|
25912
|
-
If you set ``
|
|
25912
|
+
If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib`` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.
|
|
25913
25913
|
.. epigraph::
|
|
25914
25914
|
|
|
25915
25915
|
Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999`` .
|
|
@@ -26351,7 +26351,7 @@ class CfnLaunchTemplate(
|
|
|
26351
26351
|
:param security_group_ids: The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template. If you specify a network interface, you must specify any security groups as part of the network interface instead.
|
|
26352
26352
|
:param security_groups: The names of the security groups. For a nondefault VPC, you must use security group IDs instead. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
|
|
26353
26353
|
:param tag_specifications: The tags to apply to the resources that are created during instance launch. To tag a resource after it has been created, see `CreateTags <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html>`_ . To tag the launch template itself, use `TagSpecifications <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications>`_ .
|
|
26354
|
-
:param user_data: The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see `Run commands on your
|
|
26354
|
+
:param user_data: The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see `Run commands on your Amazon EC2 instance at launch <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html>`_ in the *Amazon EC2 User Guide* . If you are creating the launch template for use with AWS Batch , the user data must be provided in the `MIME multi-part archive format <https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive>`_ . For more information, see `Amazon EC2 user data in launch templates <https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html>`_ in the *AWS Batch User Guide* .
|
|
26355
26355
|
|
|
26356
26356
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html
|
|
26357
26357
|
:exampleMetadata: fixture=_generated
|
|
@@ -27070,7 +27070,7 @@ class CfnLaunchTemplate(
|
|
|
27070
27070
|
def user_data(self) -> typing.Optional[builtins.str]:
|
|
27071
27071
|
'''The user data to make available to the instance.
|
|
27072
27072
|
|
|
27073
|
-
You must provide base64-encoded text. User data is limited to 16 KB. For more information, see `Run commands on your
|
|
27073
|
+
You must provide base64-encoded text. User data is limited to 16 KB. For more information, see `Run commands on your Amazon EC2 instance at launch <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html>`_ in the *Amazon EC2 User Guide* .
|
|
27074
27074
|
|
|
27075
27075
|
If you are creating the launch template for use with AWS Batch , the user data must be provided in the `MIME multi-part archive format <https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive>`_ . For more information, see `Amazon EC2 user data in launch templates <https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html>`_ in the *AWS Batch User Guide* .
|
|
27076
27076
|
|
|
@@ -40791,7 +40791,7 @@ class CfnSecurityGroup(
|
|
|
40791
40791
|
@builtins.property
|
|
40792
40792
|
@jsii.member(jsii_name="attrGroupId")
|
|
40793
40793
|
def attr_group_id(self) -> builtins.str:
|
|
40794
|
-
'''The
|
|
40794
|
+
'''The ID of the security group, such as ``sg-94b3a1f6`` .
|
|
40795
40795
|
|
|
40796
40796
|
:cloudformationAttribute: GroupId
|
|
40797
40797
|
'''
|
|
@@ -40809,9 +40809,7 @@ class CfnSecurityGroup(
|
|
|
40809
40809
|
@builtins.property
|
|
40810
40810
|
@jsii.member(jsii_name="attrVpcId")
|
|
40811
40811
|
def attr_vpc_id(self) -> builtins.str:
|
|
40812
|
-
'''The
|
|
40813
|
-
|
|
40814
|
-
You can obtain the physical ID by using a reference to an `AWS::EC2::VPC <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html>`_ , such as: ``{ "Ref" : "myVPC" }`` .
|
|
40812
|
+
'''The ID of the VPC, such as ``vpc-0669f8f9`` .
|
|
40815
40813
|
|
|
40816
40814
|
:cloudformationAttribute: VpcId
|
|
40817
40815
|
'''
|
|
@@ -44361,7 +44359,7 @@ class CfnSpotFleet(
|
|
|
44361
44359
|
:param instance_generations: Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see `Instance types <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html>`_ in the *Amazon EC2 User Guide* . For current generation instance types, specify ``current`` . For previous generation instance types, specify ``previous`` . Default: Current and previous generation instance types
|
|
44362
44360
|
:param local_storage: Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, `Amazon EC2 instance store <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html>`_ in the *Amazon EC2 User Guide* . - To include instance types with instance store volumes, specify ``included`` . - To require only instance types with instance store volumes, specify ``required`` . - To exclude instance types with instance store volumes, specify ``excluded`` . Default: ``included``
|
|
44363
44361
|
:param local_storage_types: The type of local storage that is required. - For instance types with hard disk drive (HDD) storage, specify ``hdd`` . - For instance types with solid state drive (SSD) storage, specify ``ssd`` . Default: ``hdd`` and ``ssd``
|
|
44364
|
-
:param max_spot_price_as_percentage_of_optimal_on_demand_price: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set ``
|
|
44362
|
+
:param max_spot_price_as_percentage_of_optimal_on_demand_price: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib`` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. .. epigraph:: Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999`` .
|
|
44365
44363
|
:param memory_gib_per_v_cpu: The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits
|
|
44366
44364
|
:param memory_mib: The minimum and maximum amount of memory, in MiB.
|
|
44367
44365
|
:param network_bandwidth_gbps: The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see `Amazon EC2 instance network bandwidth <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html>`_ in the *Amazon EC2 User Guide* . Default: No minimum or maximum limits
|
|
@@ -44759,7 +44757,7 @@ class CfnSpotFleet(
|
|
|
44759
44757
|
|
|
44760
44758
|
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
|
|
44761
44759
|
|
|
44762
|
-
If you set ``
|
|
44760
|
+
If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib`` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.
|
|
44763
44761
|
.. epigraph::
|
|
44764
44762
|
|
|
44765
44763
|
Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999`` .
|
|
@@ -46447,7 +46445,7 @@ class CfnSpotFleet(
|
|
|
46447
46445
|
|
|
46448
46446
|
You must specify either ``LaunchSpecifications`` or ``LaunchTemplateConfigs`` .
|
|
46449
46447
|
|
|
46450
|
-
:param iam_fleet_role: The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see `Spot Fleet Prerequisites <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites>`_ in the *Amazon EC2 User Guide
|
|
46448
|
+
:param iam_fleet_role: The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see `Spot Fleet Prerequisites <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites>`_ in the *Amazon EC2 User Guide* . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request or when the Spot Fleet request expires, if you set ``TerminateInstancesWithExpiration`` .
|
|
46451
46449
|
:param target_capacity: The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is ``maintain`` , you can specify a target capacity of 0 and add capacity later.
|
|
46452
46450
|
:param allocation_strategy: The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see `Allocation strategies for Spot Instances <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html>`_ in the *Amazon EC2 User Guide* . - **priceCapacityOptimized (recommended)** - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools. - **capacityOptimized** - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use ``capacityOptimizedPrioritized`` . Set a priority for each instance type by using the ``Priority`` parameter for ``LaunchTemplateOverrides`` . You can assign the same priority to different ``LaunchTemplateOverrides`` . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. ``capacityOptimizedPrioritized`` is supported only if your Spot Fleet uses a launch template. Note that if the ``OnDemandAllocationStrategy`` is set to ``prioritized`` , the same priority is applied when fulfilling On-Demand capacity. - **diversified** - Spot Fleet requests instances from all of the Spot Instance pools that you specify. - **lowestPrice (not recommended)** - > We don't recommend the ``lowestPrice`` allocation strategy because it has the highest risk of interruption for your Spot Instances. Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates. Default: ``lowestPrice``
|
|
46453
46451
|
:param context: Reserved.
|
|
@@ -46797,7 +46795,7 @@ class CfnSpotFleet(
|
|
|
46797
46795
|
def iam_fleet_role(self) -> builtins.str:
|
|
46798
46796
|
'''The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf.
|
|
46799
46797
|
|
|
46800
|
-
For more information, see `Spot Fleet Prerequisites <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites>`_ in the *Amazon EC2 User Guide
|
|
46798
|
+
For more information, see `Spot Fleet Prerequisites <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites>`_ in the *Amazon EC2 User Guide* . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request or when the Spot Fleet request expires, if you set ``TerminateInstancesWithExpiration`` .
|
|
46801
46799
|
|
|
46802
46800
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-iamfleetrole
|
|
46803
46801
|
'''
|
aws_cdk/aws_ecr/__init__.py
CHANGED
aws_cdk/aws_ecs/__init__.py
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
'''
|
|
1
|
+
r'''
|
|
2
2
|
# Amazon ECS Construct Library
|
|
3
3
|
|
|
4
4
|
This package contains constructs for working with **Amazon Elastic Container
|
|
@@ -3290,7 +3290,7 @@ class AsgCapacityProvider(
|
|
|
3290
3290
|
'''
|
|
3291
3291
|
:param scope: -
|
|
3292
3292
|
:param id: -
|
|
3293
|
-
:param auto_scaling_group: The autoscaling group to add as a Capacity Provider.
|
|
3293
|
+
:param auto_scaling_group: The autoscaling group to add as a Capacity Provider. Warning: When passing an imported resource using ``AutoScalingGroup.fromAutoScalingGroupName`` along with ``enableManagedTerminationProtection: true``, the ``AsgCapacityProvider`` construct will not be able to enforce the option ``newInstancesProtectedFromScaleIn`` of the ``AutoScalingGroup``. In this case the constructor of ``AsgCapacityProvider`` will throw an exception.
|
|
3294
3294
|
:param capacity_provider_name: The name of the capacity provider. If a name is specified, it cannot start with ``aws``, ``ecs``, or ``fargate``. If no name is specified, a default name in the CFNStackName-CFNResourceName-RandomString format is used. If the stack name starts with ``aws``, ``ecs``, or ``fargate``, a unique resource name is generated that starts with ``cp-``. Default: CloudFormation-generated name
|
|
3295
3295
|
:param enable_managed_draining: Managed instance draining facilitates graceful termination of Amazon ECS instances. This allows your service workloads to stop safely and be rescheduled to non-terminating instances. Infrastructure maintenance and updates are preformed without disruptions to workloads. To use managed instance draining, set enableManagedDraining to true. Default: true
|
|
3296
3296
|
:param enable_managed_scaling: When enabled the scale-in and scale-out actions of the cluster's Auto Scaling Group will be managed for you. This means your cluster will automatically scale instances based on the load your tasks put on the cluster. For more information, see `Using Managed Scaling <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling>`_ in the ECS Developer Guide. Default: true
|
|
@@ -3412,7 +3412,7 @@ class AsgCapacityProviderProps(AddAutoScalingGroupCapacityOptions):
|
|
|
3412
3412
|
:param machine_image_type: What type of machine image this is. Depending on the setting, different UserData will automatically be added to the ``AutoScalingGroup`` to configure it properly for use with ECS. If you create an ``AutoScalingGroup`` yourself and are adding it via ``addAutoScalingGroup()``, you must specify this value. If you are adding an ``autoScalingGroup`` via ``addCapacity``, this value will be determined from the ``machineImage`` you pass. Default: - Automatically determined from ``machineImage``, if available, otherwise ``MachineImageType.AMAZON_LINUX_2``.
|
|
3413
3413
|
:param spot_instance_draining: Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services. For more information, see `Using Spot Instances <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-spot.html>`_. Default: false
|
|
3414
3414
|
:param topic_encryption_key: If ``AddAutoScalingGroupCapacityOptions.taskDrainTime`` is non-zero, then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut down. If this property is provided, then this key will be used to encrypt the contents of that SNS Topic. See `SNS Data Encryption <https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html>`_ for more information. Default: The SNS Topic will not be encrypted.
|
|
3415
|
-
:param auto_scaling_group: The autoscaling group to add as a Capacity Provider.
|
|
3415
|
+
:param auto_scaling_group: The autoscaling group to add as a Capacity Provider. Warning: When passing an imported resource using ``AutoScalingGroup.fromAutoScalingGroupName`` along with ``enableManagedTerminationProtection: true``, the ``AsgCapacityProvider`` construct will not be able to enforce the option ``newInstancesProtectedFromScaleIn`` of the ``AutoScalingGroup``. In this case the constructor of ``AsgCapacityProvider`` will throw an exception.
|
|
3416
3416
|
:param capacity_provider_name: The name of the capacity provider. If a name is specified, it cannot start with ``aws``, ``ecs``, or ``fargate``. If no name is specified, a default name in the CFNStackName-CFNResourceName-RandomString format is used. If the stack name starts with ``aws``, ``ecs``, or ``fargate``, a unique resource name is generated that starts with ``cp-``. Default: CloudFormation-generated name
|
|
3417
3417
|
:param enable_managed_draining: Managed instance draining facilitates graceful termination of Amazon ECS instances. This allows your service workloads to stop safely and be rescheduled to non-terminating instances. Infrastructure maintenance and updates are preformed without disruptions to workloads. To use managed instance draining, set enableManagedDraining to true. Default: true
|
|
3418
3418
|
:param enable_managed_scaling: When enabled the scale-in and scale-out actions of the cluster's Auto Scaling Group will be managed for you. This means your cluster will automatically scale instances based on the load your tasks put on the cluster. For more information, see `Using Managed Scaling <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling>`_ in the ECS Developer Guide. Default: true
|
|
@@ -3544,7 +3544,12 @@ class AsgCapacityProviderProps(AddAutoScalingGroupCapacityOptions):
|
|
|
3544
3544
|
|
|
3545
3545
|
@builtins.property
|
|
3546
3546
|
def auto_scaling_group(self) -> _IAutoScalingGroup_360f1cde:
|
|
3547
|
-
'''The autoscaling group to add as a Capacity Provider.
|
|
3547
|
+
'''The autoscaling group to add as a Capacity Provider.
|
|
3548
|
+
|
|
3549
|
+
Warning: When passing an imported resource using ``AutoScalingGroup.fromAutoScalingGroupName`` along with ``enableManagedTerminationProtection: true``,
|
|
3550
|
+
the ``AsgCapacityProvider`` construct will not be able to enforce the option ``newInstancesProtectedFromScaleIn`` of the ``AutoScalingGroup``.
|
|
3551
|
+
In this case the constructor of ``AsgCapacityProvider`` will throw an exception.
|
|
3552
|
+
'''
|
|
3548
3553
|
result = self._values.get("auto_scaling_group")
|
|
3549
3554
|
assert result is not None, "Required property 'auto_scaling_group' is missing"
|
|
3550
3555
|
return typing.cast(_IAutoScalingGroup_360f1cde, result)
|
|
@@ -5412,7 +5417,7 @@ class BaseServiceProps(BaseServiceOptions):
|
|
|
5412
5417
|
|
|
5413
5418
|
:see:
|
|
5414
5419
|
|
|
5415
|
-
|
|
5420
|
+
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-capacityproviderstrategy
|
|
5416
5421
|
|
|
5417
5422
|
Valid values are: LaunchType.ECS or LaunchType.FARGATE or LaunchType.EXTERNAL
|
|
5418
5423
|
'''
|
|
@@ -9594,13 +9599,13 @@ class CfnService(
|
|
|
9594
9599
|
|
|
9595
9600
|
For tasks on AWS Fargate , the supported log drivers are ``awslogs`` , ``splunk`` , and ``awsfirelens`` .
|
|
9596
9601
|
|
|
9597
|
-
For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``
|
|
9602
|
+
For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``syslog`` , ``splunk`` , and ``awsfirelens`` .
|
|
9598
9603
|
|
|
9599
9604
|
- This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
|
|
9600
9605
|
- For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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* .
|
|
9601
9606
|
- For tasks that are on AWS Fargate , because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
|
|
9602
9607
|
|
|
9603
|
-
:param log_driver: The log driver to use for the container. For tasks on AWS Fargate , the supported log drivers are ``awslogs`` , ``splunk`` , and ``awsfirelens`` . For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``logentries`` , ``syslog`` , ``splunk`` , and ``awsfirelens`` . For more information about using the ``awslogs`` log driver, see `
|
|
9608
|
+
:param log_driver: The log driver to use for the container. For tasks on AWS Fargate , the supported log drivers are ``awslogs`` , ``splunk`` , and ``awsfirelens`` . For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``logentries`` , ``syslog`` , ``splunk`` , and ``awsfirelens`` . For more information about using the ``awslogs`` log driver, see `Send Amazon ECS logs to CloudWatch <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html>`_ in the *Amazon Elastic Container Service Developer Guide* . For more information about using the ``awsfirelens`` log driver, see `Send Amazon ECS logs to an AWS service or AWS Partner <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html>`_ . .. epigraph:: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's `available on GitHub <https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent>`_ and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.
|
|
9604
9609
|
:param options: The configuration options to send to the log driver. This parameter requires version 1.19 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}}'``
|
|
9605
9610
|
:param secret_options: The secrets to pass to the log configuration. 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* .
|
|
9606
9611
|
|
|
@@ -9645,9 +9650,9 @@ class CfnService(
|
|
|
9645
9650
|
|
|
9646
9651
|
For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``logentries`` , ``syslog`` , ``splunk`` , and ``awsfirelens`` .
|
|
9647
9652
|
|
|
9648
|
-
For more information about using the ``awslogs`` log driver, see `
|
|
9653
|
+
For more information about using the ``awslogs`` log driver, see `Send Amazon ECS logs to CloudWatch <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
9649
9654
|
|
|
9650
|
-
For more information about using the ``awsfirelens`` log driver, see `
|
|
9655
|
+
For more information about using the ``awsfirelens`` log driver, see `Send Amazon ECS logs to an AWS service or AWS Partner <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html>`_ .
|
|
9651
9656
|
.. epigraph::
|
|
9652
9657
|
|
|
9653
9658
|
If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's `available on GitHub <https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent>`_ and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.
|
|
@@ -10113,7 +10118,7 @@ class CfnService(
|
|
|
10113
10118
|
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see `Service Connect <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
10114
10119
|
|
|
10115
10120
|
:param enabled: Specifies whether to use Service Connect with this service.
|
|
10116
|
-
:param log_configuration: The log configuration 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/commandline/run/>`_ . By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. 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. Understand the following when specifying a log configuration for your containers. - Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on AWS Fargate , the supported log drivers are ``awslogs`` , ``splunk`` , and ``awsfirelens`` . For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``
|
|
10121
|
+
:param log_configuration: The log configuration 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/commandline/run/>`_ . By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. 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. Understand the following when specifying a log configuration for your containers. - Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on AWS Fargate , the supported log drivers are ``awslogs`` , ``splunk`` , and ``awsfirelens`` . For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``syslog`` , ``splunk`` , and ``awsfirelens`` . - This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. - For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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* . - For tasks that are on AWS Fargate , because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
|
|
10117
10122
|
:param namespace: The namespace name or full Amazon Resource Name (ARN) of the AWS Cloud Map namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about AWS Cloud Map , see `Working with Services <https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html>`_ in the *AWS Cloud Map Developer Guide* .
|
|
10118
10123
|
:param services: The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means. An object selects a port from the task definition, assigns a name for the AWS Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
|
|
10119
10124
|
|
|
@@ -10211,7 +10216,7 @@ class CfnService(
|
|
|
10211
10216
|
|
|
10212
10217
|
For tasks on AWS Fargate , the supported log drivers are ``awslogs`` , ``splunk`` , and ``awsfirelens`` .
|
|
10213
10218
|
|
|
10214
|
-
For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``
|
|
10219
|
+
For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``syslog`` , ``splunk`` , and ``awsfirelens`` .
|
|
10215
10220
|
|
|
10216
10221
|
- This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
|
|
10217
10222
|
- For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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* .
|
|
@@ -12087,7 +12092,7 @@ class CfnTaskDefinition(
|
|
|
12087
12092
|
:param container_definitions: A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see `Amazon ECS Task Definitions <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
12088
12093
|
:param cpu: The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. - 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments This option requires Linux platform ``1.4.0`` or later. - 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments This option requires Linux platform ``1.4.0`` or later.
|
|
12089
12094
|
:param ephemeral_storage: The ephemeral storage settings to use for tasks run with the task definition.
|
|
12090
|
-
:param execution_role_arn: The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.
|
|
12095
|
+
:param execution_role_arn: The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see `IAM roles for Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
12091
12096
|
:param family: The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. .. epigraph:: To use revision numbers when you update a task definition, specify this property. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it.
|
|
12092
12097
|
:param inference_accelerators: The Elastic Inference accelerators to use for the containers in the task.
|
|
12093
12098
|
: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, then 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, then IPC resources within the containers of a task are private and 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* . If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see `Docker security <https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/>`_ . If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see `System Controls <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html>`_ in the *Amazon Elastic Container Service Developer Guide* . - For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported. - For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task. .. epigraph:: This parameter is not supported for Windows containers or tasks run on AWS Fargate .
|
|
@@ -12099,7 +12104,7 @@ class CfnTaskDefinition(
|
|
|
12099
12104
|
:param requires_compatibilities: The task launch types the task definition was validated against. The valid values are ``EC2`` , ``FARGATE`` , and ``EXTERNAL`` . For more information, see `Amazon ECS launch types <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
12100
12105
|
:param runtime_platform: The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
|
|
12101
12106
|
:param tags: The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: - Maximum number of tags per resource - 50 - For each resource, each tag key must be unique, and each tag key can have only one value. - Maximum key length - 128 Unicode characters in UTF-8 - Maximum value length - 256 Unicode characters in UTF-8 - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
|
|
12102
|
-
:param task_role_arn: The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf. For
|
|
12107
|
+
:param task_role_arn: The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see `IAM roles for Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
12103
12108
|
:param volumes: The list of data volume definitions for the task. For more information, see `Using data volumes in tasks <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html>`_ in the *Amazon Elastic Container Service Developer Guide* . .. epigraph:: The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on AWS Fargate .
|
|
12104
12109
|
'''
|
|
12105
12110
|
if __debug__:
|
|
@@ -12609,7 +12614,7 @@ class CfnTaskDefinition(
|
|
|
12609
12614
|
: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 `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ . - When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. - Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest`` . For example, ``012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest`` or ``012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE`` . - Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo`` ). - Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent`` ). - Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu`` ).
|
|
12610
12615
|
:param name: The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` 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 ``--name`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ .
|
|
12611
12616
|
: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.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``COMMAND`` parameter to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ . For more information, see `https://docs.docker.com/engine/reference/builder/#cmd <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd>`_ . If there are multiple arguments, each argument is a separated string in the array.
|
|
12612
|
-
:param cpu: The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` 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 ``--cpu-shares`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ . This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value. .. epigraph:: You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the `Amazon EC2 Instances <https://docs.aws.amazon.com/ec2/instance-types/>`_ detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see `CPU share constraint <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint>`_ in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: - *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. - *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0`` , which Windows interprets as 1% of one CPU.
|
|
12617
|
+
:param cpu: The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` 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 ``--cpu-shares`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ . This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value. .. epigraph:: You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the `Amazon EC2 Instances <https://docs.aws.amazon.com/ec2/instance-types/>`_ detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see `CPU share constraint <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint>`_ in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 (including null) or above 262144, the behavior varies based on your Amazon ECS container agent version: - *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. - *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2. - *Agent versions greater than or equal to 1.84.0:* CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0`` , which Windows interprets as 1% of one CPU.
|
|
12613
12618
|
:param credential_specs: A list of ARNs in SSM or Amazon S3 to a credential spec ( ``CredSpec`` ) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions`` . The maximum number of ARNs is 1. There are two formats for each ARN. - **credentialspecdomainless:MyARN** - You use ``credentialspecdomainless:MyARN`` to provide a ``CredSpec`` with an additional section for a secret in AWS Secrets Manager . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. - **credentialspec:MyARN** - You use ``credentialspec:MyARN`` to provide a ``CredSpec`` for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3. If you provide a ``credentialspecdomainless:MyARN`` , the ``credspec`` must provide a ARN in AWS Secrets Manager for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see `Using gMSAs for Windows Containers <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html>`_ and `Using gMSAs for Linux Containers <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html>`_ .
|
|
12614
12619
|
:param depends_on: The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see `Updating the Amazon ECS Container Agent <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html>`_ in the *Amazon Elastic Container Service Developer Guide* . If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init`` . For more information, see `Amazon ECS-optimized Linux AMI <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html>`_ in the *Amazon Elastic Container Service Developer Guide* . For tasks using the Fargate launch type, the task or service requires the following platforms: - Linux platform version ``1.3.0`` or later. - Windows platform version ``1.0.0`` or later. If the task definition is used in a blue/green deployment that uses `AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html>`_ , the ``dependsOn`` parameter is not supported. For more information see `Issue #680 <https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680>`_ on the on the GitHub website.
|
|
12615
12620
|
:param disable_networking: When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` 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/>`_ . .. epigraph:: This parameter is not supported for Windows containers.
|
|
@@ -12964,10 +12969,11 @@ class CfnTaskDefinition(
|
|
|
12964
12969
|
|
|
12965
12970
|
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
|
|
12966
12971
|
|
|
12967
|
-
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see `CPU share constraint <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint>`_ in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
|
|
12972
|
+
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see `CPU share constraint <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint>`_ in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 (including null) or above 262144, the behavior varies based on your Amazon ECS container agent version:
|
|
12968
12973
|
|
|
12969
12974
|
- *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
|
|
12970
12975
|
- *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2.
|
|
12976
|
+
- *Agent versions greater than or equal to 1.84.0:* CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares.
|
|
12971
12977
|
|
|
12972
12978
|
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0`` , which Windows interprets as 1% of one CPU.
|
|
12973
12979
|
|
|
@@ -15190,7 +15196,7 @@ class CfnTaskDefinition(
|
|
|
15190
15196
|
) -> None:
|
|
15191
15197
|
'''The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container.
|
|
15192
15198
|
|
|
15193
|
-
:param log_driver: The log driver to use for the container. For tasks on AWS Fargate , the supported log drivers are ``awslogs`` , ``splunk`` , and ``awsfirelens`` . For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``logentries`` , ``syslog`` , ``splunk`` , and ``awsfirelens`` . For more information about using the ``awslogs`` log driver, see `
|
|
15199
|
+
:param log_driver: The log driver to use for the container. For tasks on AWS Fargate , the supported log drivers are ``awslogs`` , ``splunk`` , and ``awsfirelens`` . For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``logentries`` , ``syslog`` , ``splunk`` , and ``awsfirelens`` . For more information about using the ``awslogs`` log driver, see `Send Amazon ECS logs to CloudWatch <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html>`_ in the *Amazon Elastic Container Service Developer Guide* . For more information about using the ``awsfirelens`` log driver, see `Send Amazon ECS logs to an AWS service or AWS Partner <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html>`_ . .. epigraph:: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's `available on GitHub <https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent>`_ and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.
|
|
15194
15200
|
:param options: The configuration options to send to the log driver. This parameter requires version 1.19 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}}'``
|
|
15195
15201
|
:param secret_options: The secrets to pass to the log configuration. 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* .
|
|
15196
15202
|
|
|
@@ -15237,9 +15243,9 @@ class CfnTaskDefinition(
|
|
|
15237
15243
|
|
|
15238
15244
|
For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs`` , ``fluentd`` , ``gelf`` , ``json-file`` , ``journald`` , ``logentries`` , ``syslog`` , ``splunk`` , and ``awsfirelens`` .
|
|
15239
15245
|
|
|
15240
|
-
For more information about using the ``awslogs`` log driver, see `
|
|
15246
|
+
For more information about using the ``awslogs`` log driver, see `Send Amazon ECS logs to CloudWatch <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
15241
15247
|
|
|
15242
|
-
For more information about using the ``awsfirelens`` log driver, see `
|
|
15248
|
+
For more information about using the ``awsfirelens`` log driver, see `Send Amazon ECS logs to an AWS service or AWS Partner <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html>`_ .
|
|
15243
15249
|
.. epigraph::
|
|
15244
15250
|
|
|
15245
15251
|
If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's `available on GitHub <https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent>`_ and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.
|
|
@@ -16262,7 +16268,7 @@ class CfnTaskDefinition(
|
|
|
16262
16268
|
) -> None:
|
|
16263
16269
|
'''The ``ulimit`` settings to pass to the container.
|
|
16264
16270
|
|
|
16265
|
-
Amazon ECS tasks hosted on AWS Fargate use the default resource limit values set by the operating system with the exception of the ``nofile`` resource limit parameter which AWS 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 ``
|
|
16271
|
+
Amazon ECS tasks hosted on AWS Fargate use the default resource limit values set by the operating system with the exception of the ``nofile`` resource limit parameter which AWS 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 ``65535`` and the default hard limit is ``65535`` .
|
|
16266
16272
|
|
|
16267
16273
|
You can specify the ``ulimit`` settings for a container in a task definition.
|
|
16268
16274
|
|
|
@@ -16662,7 +16668,7 @@ class CfnTaskDefinitionProps:
|
|
|
16662
16668
|
:param container_definitions: A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see `Amazon ECS Task Definitions <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
16663
16669
|
:param cpu: The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. - 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments This option requires Linux platform ``1.4.0`` or later. - 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments This option requires Linux platform ``1.4.0`` or later.
|
|
16664
16670
|
:param ephemeral_storage: The ephemeral storage settings to use for tasks run with the task definition.
|
|
16665
|
-
:param execution_role_arn: The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.
|
|
16671
|
+
:param execution_role_arn: The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see `IAM roles for Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
16666
16672
|
:param family: The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. .. epigraph:: To use revision numbers when you update a task definition, specify this property. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it.
|
|
16667
16673
|
:param inference_accelerators: The Elastic Inference accelerators to use for the containers in the task.
|
|
16668
16674
|
: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, then 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, then IPC resources within the containers of a task are private and 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* . If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see `Docker security <https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/>`_ . If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see `System Controls <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html>`_ in the *Amazon Elastic Container Service Developer Guide* . - For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported. - For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task. .. epigraph:: This parameter is not supported for Windows containers or tasks run on AWS Fargate .
|
|
@@ -16674,7 +16680,7 @@ class CfnTaskDefinitionProps:
|
|
|
16674
16680
|
:param requires_compatibilities: The task launch types the task definition was validated against. The valid values are ``EC2`` , ``FARGATE`` , and ``EXTERNAL`` . For more information, see `Amazon ECS launch types <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
16675
16681
|
:param runtime_platform: The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
|
|
16676
16682
|
:param tags: The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: - Maximum number of tags per resource - 50 - For each resource, each tag key must be unique, and each tag key can have only one value. - Maximum key length - 128 Unicode characters in UTF-8 - Maximum value length - 256 Unicode characters in UTF-8 - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
|
|
16677
|
-
:param task_role_arn: The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf. For
|
|
16683
|
+
:param task_role_arn: The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see `IAM roles for Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
16678
16684
|
:param volumes: The list of data volume definitions for the task. For more information, see `Using data volumes in tasks <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html>`_ in the *Amazon Elastic Container Service Developer Guide* . .. epigraph:: The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on AWS Fargate .
|
|
16679
16685
|
|
|
16680
16686
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html
|
|
@@ -17008,7 +17014,7 @@ class CfnTaskDefinitionProps:
|
|
|
17008
17014
|
def execution_role_arn(self) -> typing.Optional[builtins.str]:
|
|
17009
17015
|
'''The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.
|
|
17010
17016
|
|
|
17011
|
-
|
|
17017
|
+
For informationabout the required IAM roles for Amazon ECS, see `IAM roles for Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
17012
17018
|
|
|
17013
17019
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-executionrolearn
|
|
17014
17020
|
'''
|
|
@@ -17217,9 +17223,7 @@ class CfnTaskDefinitionProps:
|
|
|
17217
17223
|
def task_role_arn(self) -> typing.Optional[builtins.str]:
|
|
17218
17224
|
'''The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf.
|
|
17219
17225
|
|
|
17220
|
-
For
|
|
17221
|
-
|
|
17222
|
-
IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see `Windows IAM roles for tasks <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
17226
|
+
For informationabout the required IAM roles for Amazon ECS, see `IAM roles for Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
17223
17227
|
|
|
17224
17228
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-taskrolearn
|
|
17225
17229
|
'''
|
aws_cdk/aws_efs/__init__.py
CHANGED