aws-cdk-lib 2.205.0__py3-none-any.whl → 2.207.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +96 -15
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.205.0.jsii.tgz → aws-cdk-lib@2.207.0.jsii.tgz} +0 -0
- aws_cdk/aws_aiops/__init__.py +66 -76
- aws_cdk/aws_autoscaling/__init__.py +20 -0
- aws_cdk/aws_bedrock/__init__.py +126 -70
- aws_cdk/aws_certificatemanager/__init__.py +3 -3
- aws_cdk/aws_cleanrooms/__init__.py +6 -2
- aws_cdk/aws_cloudformation/__init__.py +28 -15
- aws_cdk/aws_cloudwatch/__init__.py +574 -33
- aws_cdk/aws_datasync/__init__.py +14 -15
- aws_cdk/aws_ec2/__init__.py +6 -2
- aws_cdk/aws_ecs/__init__.py +773 -212
- aws_cdk/aws_iotsitewise/__init__.py +13 -9
- aws_cdk/aws_kms/__init__.py +19 -17
- aws_cdk/aws_logs/__init__.py +4725 -763
- aws_cdk/aws_mediapackagev2/__init__.py +69 -48
- aws_cdk/aws_opsworkscm/__init__.py +2 -4
- aws_cdk/aws_rds/__init__.py +150 -17
- aws_cdk/aws_s3/__init__.py +9 -6
- aws_cdk/aws_sagemaker/__init__.py +3 -3
- aws_cdk/aws_ssm/__init__.py +58 -33
- aws_cdk/aws_transfer/__init__.py +21 -11
- aws_cdk/custom_resources/__init__.py +32 -4
- {aws_cdk_lib-2.205.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.205.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/RECORD +30 -30
- {aws_cdk_lib-2.205.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.205.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.205.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.205.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_s3/__init__.py
CHANGED
|
@@ -4435,7 +4435,7 @@ class CfnBucket(
|
|
|
4435
4435
|
:param bucket_name: A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow `Amazon S3 bucket restrictions and limitations <https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html>`_ . For more information, see `Rules for naming Amazon S3 buckets <https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html>`_ in the *Amazon S3 User Guide* . .. epigraph:: If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
|
|
4436
4436
|
:param cors_configuration: Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see `Enabling Cross-Origin Resource Sharing <https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html>`_ in the *Amazon S3 User Guide* .
|
|
4437
4437
|
:param intelligent_tiering_configurations: Defines how Amazon S3 handles Intelligent-Tiering storage.
|
|
4438
|
-
:param inventory_configurations: Specifies the
|
|
4438
|
+
:param inventory_configurations: Specifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see `GET Bucket inventory <https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html>`_ in the *Amazon S3 API Reference* .
|
|
4439
4439
|
:param lifecycle_configuration: Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see `Object Lifecycle Management <https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html>`_ in the *Amazon S3 User Guide* .
|
|
4440
4440
|
:param logging_configuration: Settings that define where logs are stored.
|
|
4441
4441
|
:param metadata_table_configuration: The metadata table configuration of an Amazon S3 general purpose bucket.
|
|
@@ -4729,7 +4729,7 @@ class CfnBucket(
|
|
|
4729
4729
|
def inventory_configurations(
|
|
4730
4730
|
self,
|
|
4731
4731
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnBucket.InventoryConfigurationProperty"]]]]:
|
|
4732
|
-
'''Specifies the
|
|
4732
|
+
'''Specifies the S3 Inventory configuration for an Amazon S3 bucket.'''
|
|
4733
4733
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnBucket.InventoryConfigurationProperty"]]]], jsii.get(self, "inventoryConfigurations"))
|
|
4734
4734
|
|
|
4735
4735
|
@inventory_configurations.setter
|
|
@@ -6265,7 +6265,7 @@ class CfnBucket(
|
|
|
6265
6265
|
optional_fields: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
6266
6266
|
prefix: typing.Optional[builtins.str] = None,
|
|
6267
6267
|
) -> None:
|
|
6268
|
-
'''Specifies the
|
|
6268
|
+
'''Specifies the S3 Inventory configuration for an Amazon S3 bucket.
|
|
6269
6269
|
|
|
6270
6270
|
For more information, see `GET Bucket inventory <https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html>`_ in the *Amazon S3 API Reference* .
|
|
6271
6271
|
|
|
@@ -9828,9 +9828,12 @@ class CfnBucket(
|
|
|
9828
9828
|
table_arn: typing.Optional[builtins.str] = None,
|
|
9829
9829
|
table_namespace: typing.Optional[builtins.str] = None,
|
|
9830
9830
|
) -> None:
|
|
9831
|
-
'''The destination information for
|
|
9831
|
+
'''The destination information for a V1 S3 Metadata configuration.
|
|
9832
9832
|
|
|
9833
9833
|
The destination table bucket must be in the same Region and AWS account as the general purpose bucket. The specified metadata table name must be unique within the ``aws_s3_metadata`` namespace in the destination table bucket.
|
|
9834
|
+
.. epigraph::
|
|
9835
|
+
|
|
9836
|
+
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using `CreateBucketMetadataConfiguration <https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html>`_ so that you can expire journal table records and create a live inventory table.
|
|
9834
9837
|
|
|
9835
9838
|
:param table_bucket_arn: The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket.
|
|
9836
9839
|
:param table_name: The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the ``aws_s3_metadata`` namespace in the destination table bucket.
|
|
@@ -11244,7 +11247,7 @@ class CfnBucketProps:
|
|
|
11244
11247
|
:param bucket_name: A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow `Amazon S3 bucket restrictions and limitations <https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html>`_ . For more information, see `Rules for naming Amazon S3 buckets <https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html>`_ in the *Amazon S3 User Guide* . .. epigraph:: If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
|
|
11245
11248
|
:param cors_configuration: Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see `Enabling Cross-Origin Resource Sharing <https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html>`_ in the *Amazon S3 User Guide* .
|
|
11246
11249
|
:param intelligent_tiering_configurations: Defines how Amazon S3 handles Intelligent-Tiering storage.
|
|
11247
|
-
:param inventory_configurations: Specifies the
|
|
11250
|
+
:param inventory_configurations: Specifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see `GET Bucket inventory <https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html>`_ in the *Amazon S3 API Reference* .
|
|
11248
11251
|
:param lifecycle_configuration: Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see `Object Lifecycle Management <https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html>`_ in the *Amazon S3 User Guide* .
|
|
11249
11252
|
:param logging_configuration: Settings that define where logs are stored.
|
|
11250
11253
|
:param metadata_table_configuration: The metadata table configuration of an Amazon S3 general purpose bucket.
|
|
@@ -11439,7 +11442,7 @@ class CfnBucketProps:
|
|
|
11439
11442
|
def inventory_configurations(
|
|
11440
11443
|
self,
|
|
11441
11444
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnBucket.InventoryConfigurationProperty]]]]:
|
|
11442
|
-
'''Specifies the
|
|
11445
|
+
'''Specifies the S3 Inventory configuration for an Amazon S3 bucket.
|
|
11443
11446
|
|
|
11444
11447
|
For more information, see `GET Bucket inventory <https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html>`_ in the *Amazon S3 API Reference* .
|
|
11445
11448
|
|
|
@@ -9228,7 +9228,7 @@ class CfnDomain(
|
|
|
9228
9228
|
:param environment_id: The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.
|
|
9229
9229
|
:param project_id: The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.
|
|
9230
9230
|
:param project_s3_path: The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.
|
|
9231
|
-
:param single_sign_on_application_arn: The ARN of the
|
|
9231
|
+
:param single_sign_on_application_arn: The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the AWS IAM Identity Center.
|
|
9232
9232
|
:param studio_web_portal_access: Sets whether you can access the domain in Amazon SageMaker Studio:. - **ENABLED** - You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces. - **DISABLED** - You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface. To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.
|
|
9233
9233
|
|
|
9234
9234
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html
|
|
@@ -9339,7 +9339,7 @@ class CfnDomain(
|
|
|
9339
9339
|
|
|
9340
9340
|
@builtins.property
|
|
9341
9341
|
def single_sign_on_application_arn(self) -> typing.Optional[builtins.str]:
|
|
9342
|
-
'''The ARN of the
|
|
9342
|
+
'''The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the AWS IAM Identity Center.
|
|
9343
9343
|
|
|
9344
9344
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-singlesignonapplicationarn
|
|
9345
9345
|
'''
|
|
@@ -27090,7 +27090,7 @@ class CfnModelCard(
|
|
|
27090
27090
|
user_profile_arn: typing.Optional[builtins.str] = None,
|
|
27091
27091
|
user_profile_name: typing.Optional[builtins.str] = None,
|
|
27092
27092
|
) -> None:
|
|
27093
|
-
'''Information about the user who created or modified
|
|
27093
|
+
'''Information about the user who created or modified a SageMaker resource.
|
|
27094
27094
|
|
|
27095
27095
|
:param domain_id: The domain associated with the user. Default: - "UnsetValue"
|
|
27096
27096
|
:param user_profile_arn: The Amazon Resource Name (ARN) of the user's profile. Default: - "UnsetValue"
|
aws_cdk/aws_ssm/__init__.py
CHANGED
|
@@ -352,7 +352,7 @@ class CfnAssociation(
|
|
|
352
352
|
:param calendar_names: The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see `AWS Systems Manager Change Calendar <https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar>`_ in the *AWS Systems Manager User Guide* .
|
|
353
353
|
:param compliance_severity: The severity level that is assigned to the association.
|
|
354
354
|
:param document_version: The version of the SSM document to associate with the target. .. epigraph:: Note the following important information. - State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the ``default`` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to ``default`` . - ``DocumentVersion`` is not valid for documents owned by AWS , such as ``AWS-RunPatchBaseline`` or ``AWS-UpdateSSMAgent`` . If you specify ``DocumentVersion`` for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken: , HandlerErrorCode: GeneralServiceException).
|
|
355
|
-
:param instance_id:
|
|
355
|
+
:param instance_id: .. epigraph:: ``InstanceId`` has been deprecated. To specify an instance ID for an association, use the ``Targets`` parameter. If you use the parameter ``InstanceId`` , you cannot use the parameters ``AssociationName`` , ``DocumentVersion`` , ``MaxErrors`` , ``MaxConcurrency`` , ``OutputLocation`` , or ``ScheduleExpression`` . To use these parameters, you must use the ``Targets`` parameter. .. epigraph:: Note that in some examples later in this page, ``InstanceIds`` is used as the tag-key name in a ``Targets`` filter. ``InstanceId`` is not used as a parameter. The ID of the instance that the SSM document is associated with. You must specify the ``InstanceId`` or ``Targets`` property.
|
|
356
356
|
:param max_concurrency: The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new managed node starts and attempts to run an association while Systems Manager is running ``MaxConcurrency`` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for ``MaxConcurrency`` .
|
|
357
357
|
:param max_errors: The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set ``MaxError`` to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when ``MaxErrors`` is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set ``MaxConcurrency`` to 1 so that executions proceed one at a time.
|
|
358
358
|
:param output_location: An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
|
|
@@ -535,7 +535,9 @@ class CfnAssociation(
|
|
|
535
535
|
@builtins.property
|
|
536
536
|
@jsii.member(jsii_name="instanceId")
|
|
537
537
|
def instance_id(self) -> typing.Optional[builtins.str]:
|
|
538
|
-
'''
|
|
538
|
+
'''.. epigraph::
|
|
539
|
+
|
|
540
|
+
``InstanceId`` has been deprecated.'''
|
|
539
541
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "instanceId"))
|
|
540
542
|
|
|
541
543
|
@instance_id.setter
|
|
@@ -957,7 +959,7 @@ class CfnAssociationProps:
|
|
|
957
959
|
:param calendar_names: The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see `AWS Systems Manager Change Calendar <https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar>`_ in the *AWS Systems Manager User Guide* .
|
|
958
960
|
:param compliance_severity: The severity level that is assigned to the association.
|
|
959
961
|
:param document_version: The version of the SSM document to associate with the target. .. epigraph:: Note the following important information. - State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the ``default`` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to ``default`` . - ``DocumentVersion`` is not valid for documents owned by AWS , such as ``AWS-RunPatchBaseline`` or ``AWS-UpdateSSMAgent`` . If you specify ``DocumentVersion`` for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken: , HandlerErrorCode: GeneralServiceException).
|
|
960
|
-
:param instance_id:
|
|
962
|
+
:param instance_id: .. epigraph:: ``InstanceId`` has been deprecated. To specify an instance ID for an association, use the ``Targets`` parameter. If you use the parameter ``InstanceId`` , you cannot use the parameters ``AssociationName`` , ``DocumentVersion`` , ``MaxErrors`` , ``MaxConcurrency`` , ``OutputLocation`` , or ``ScheduleExpression`` . To use these parameters, you must use the ``Targets`` parameter. .. epigraph:: Note that in some examples later in this page, ``InstanceIds`` is used as the tag-key name in a ``Targets`` filter. ``InstanceId`` is not used as a parameter. The ID of the instance that the SSM document is associated with. You must specify the ``InstanceId`` or ``Targets`` property.
|
|
961
963
|
:param max_concurrency: The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new managed node starts and attempts to run an association while Systems Manager is running ``MaxConcurrency`` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for ``MaxConcurrency`` .
|
|
962
964
|
:param max_errors: The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set ``MaxError`` to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when ``MaxErrors`` is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set ``MaxConcurrency`` to 1 so that executions proceed one at a time.
|
|
963
965
|
:param output_location: An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
|
|
@@ -1154,12 +1156,16 @@ class CfnAssociationProps:
|
|
|
1154
1156
|
|
|
1155
1157
|
@builtins.property
|
|
1156
1158
|
def instance_id(self) -> typing.Optional[builtins.str]:
|
|
1157
|
-
'''
|
|
1159
|
+
'''.. epigraph::
|
|
1160
|
+
|
|
1161
|
+
``InstanceId`` has been deprecated.
|
|
1158
1162
|
|
|
1159
|
-
|
|
1163
|
+
To specify an instance ID for an association, use the ``Targets`` parameter. If you use the parameter ``InstanceId`` , you cannot use the parameters ``AssociationName`` , ``DocumentVersion`` , ``MaxErrors`` , ``MaxConcurrency`` , ``OutputLocation`` , or ``ScheduleExpression`` . To use these parameters, you must use the ``Targets`` parameter.
|
|
1160
1164
|
.. epigraph::
|
|
1161
1165
|
|
|
1162
|
-
|
|
1166
|
+
Note that in some examples later in this page, ``InstanceIds`` is used as the tag-key name in a ``Targets`` filter. ``InstanceId`` is not used as a parameter.
|
|
1167
|
+
|
|
1168
|
+
The ID of the instance that the SSM document is associated with. You must specify the ``InstanceId`` or ``Targets`` property.
|
|
1163
1169
|
|
|
1164
1170
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid
|
|
1165
1171
|
'''
|
|
@@ -3048,14 +3054,14 @@ class CfnMaintenanceWindowTask(
|
|
|
3048
3054
|
:param window_id: The ID of the maintenance window where the task is registered.
|
|
3049
3055
|
:param cutoff_behavior: The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
|
|
3050
3056
|
:param description: A description of the task.
|
|
3051
|
-
:param logging_info:
|
|
3057
|
+
:param logging_info: .. epigraph:: ``LoggingInfo`` has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the ``OutputS3BucketName`` and ``OutputS3KeyPrefix`` options in the ``TaskInvocationParameters`` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see `AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html>`_ . Information about an Amazon S3 bucket to write Run Command task-level logs to.
|
|
3052
3058
|
:param max_concurrency: The maximum number of targets this task can be run for, in parallel. .. epigraph:: Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a `targetless task <https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html>`_ You must provide a value in all other cases. For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of ``1`` . This value doesn't affect the running of your task.
|
|
3053
3059
|
:param max_errors: The maximum number of errors allowed before this task stops being scheduled. .. epigraph:: Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a `targetless task <https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html>`_ You must provide a value in all other cases. For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of ``1`` . This value doesn't affect the running of your task.
|
|
3054
3060
|
:param name: The task name.
|
|
3055
3061
|
:param service_role_arn: The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run ``RegisterTaskWithMaintenanceWindow`` . However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see `Setting up Maintenance Windows <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html>`_ in the in the *AWS Systems Manager User Guide* .
|
|
3056
3062
|
:param targets: The targets, either instances or window target IDs. - Specify instances using ``Key=InstanceIds,Values= *instanceid1* , *instanceid2*`` . - Specify window target IDs using ``Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2*`` .
|
|
3057
3063
|
:param task_invocation_parameters: The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty. .. epigraph:: When you update a maintenance window task that has options specified in ``TaskInvocationParameters`` , you must provide again all the ``TaskInvocationParameters`` values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified ``TaskInvocationParameters`` values for ``Comment`` , ``NotificationConfig`` , and ``OutputS3BucketName`` . If you update the maintenance window task and specify only a different ``OutputS3BucketName`` value, the values for ``Comment`` and ``NotificationConfig`` are removed.
|
|
3058
|
-
:param task_parameters:
|
|
3064
|
+
:param task_parameters: .. epigraph:: ``TaskParameters`` has been deprecated. To specify parameters to pass to a task when it runs, instead use the ``Parameters`` option in the ``TaskInvocationParameters`` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see `MaintenanceWindowTaskInvocationParameters <https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_MaintenanceWindowTaskInvocationParameters.html>`_ . The parameters to pass to the task when it runs.
|
|
3059
3065
|
'''
|
|
3060
3066
|
if __debug__:
|
|
3061
3067
|
type_hints = typing.get_type_hints(_typecheckingstub__5ab957de8d8a36935188de8e7d81d523e1ab1253ec8aab9717d062cb647fc726)
|
|
@@ -3206,7 +3212,9 @@ class CfnMaintenanceWindowTask(
|
|
|
3206
3212
|
def logging_info(
|
|
3207
3213
|
self,
|
|
3208
3214
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnMaintenanceWindowTask.LoggingInfoProperty"]]:
|
|
3209
|
-
'''
|
|
3215
|
+
'''.. epigraph::
|
|
3216
|
+
|
|
3217
|
+
``LoggingInfo`` has been deprecated.'''
|
|
3210
3218
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnMaintenanceWindowTask.LoggingInfoProperty"]], jsii.get(self, "loggingInfo"))
|
|
3211
3219
|
|
|
3212
3220
|
@logging_info.setter
|
|
@@ -3310,7 +3318,9 @@ class CfnMaintenanceWindowTask(
|
|
|
3310
3318
|
@builtins.property
|
|
3311
3319
|
@jsii.member(jsii_name="taskParameters")
|
|
3312
3320
|
def task_parameters(self) -> typing.Any:
|
|
3313
|
-
'''
|
|
3321
|
+
'''.. epigraph::
|
|
3322
|
+
|
|
3323
|
+
``TaskParameters`` has been deprecated.'''
|
|
3314
3324
|
return typing.cast(typing.Any, jsii.get(self, "taskParameters"))
|
|
3315
3325
|
|
|
3316
3326
|
@task_parameters.setter
|
|
@@ -3416,12 +3426,15 @@ class CfnMaintenanceWindowTask(
|
|
|
3416
3426
|
s3_bucket: builtins.str,
|
|
3417
3427
|
s3_prefix: typing.Optional[builtins.str] = None,
|
|
3418
3428
|
) -> None:
|
|
3419
|
-
'''
|
|
3429
|
+
'''.. epigraph::
|
|
3420
3430
|
|
|
3421
|
-
|
|
3422
|
-
|
|
3431
|
+
``LoggingInfo`` has been deprecated.
|
|
3432
|
+
|
|
3433
|
+
To specify an Amazon S3 bucket to contain logs, instead use the ``OutputS3BucketName`` and ``OutputS3KeyPrefix`` options in the ``TaskInvocationParameters`` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see `AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html>`_ .
|
|
3434
|
+
|
|
3435
|
+
The ``LoggingInfo`` property type specifies information about the Amazon S3 bucket to write instance-level logs to.
|
|
3423
3436
|
|
|
3424
|
-
|
|
3437
|
+
``LoggingInfo`` is a property of the `AWS::SSM::MaintenanceWindowTask <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html>`_ resource.
|
|
3425
3438
|
|
|
3426
3439
|
:param region: The AWS Region where the S3 bucket is located.
|
|
3427
3440
|
:param s3_bucket: The name of an S3 bucket where execution logs are stored.
|
|
@@ -4383,14 +4396,14 @@ class CfnMaintenanceWindowTaskProps:
|
|
|
4383
4396
|
:param window_id: The ID of the maintenance window where the task is registered.
|
|
4384
4397
|
:param cutoff_behavior: The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
|
|
4385
4398
|
:param description: A description of the task.
|
|
4386
|
-
:param logging_info:
|
|
4399
|
+
:param logging_info: .. epigraph:: ``LoggingInfo`` has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the ``OutputS3BucketName`` and ``OutputS3KeyPrefix`` options in the ``TaskInvocationParameters`` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see `AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html>`_ . Information about an Amazon S3 bucket to write Run Command task-level logs to.
|
|
4387
4400
|
:param max_concurrency: The maximum number of targets this task can be run for, in parallel. .. epigraph:: Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a `targetless task <https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html>`_ You must provide a value in all other cases. For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of ``1`` . This value doesn't affect the running of your task.
|
|
4388
4401
|
:param max_errors: The maximum number of errors allowed before this task stops being scheduled. .. epigraph:: Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a `targetless task <https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html>`_ You must provide a value in all other cases. For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of ``1`` . This value doesn't affect the running of your task.
|
|
4389
4402
|
:param name: The task name.
|
|
4390
4403
|
:param service_role_arn: The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run ``RegisterTaskWithMaintenanceWindow`` . However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see `Setting up Maintenance Windows <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html>`_ in the in the *AWS Systems Manager User Guide* .
|
|
4391
4404
|
:param targets: The targets, either instances or window target IDs. - Specify instances using ``Key=InstanceIds,Values= *instanceid1* , *instanceid2*`` . - Specify window target IDs using ``Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2*`` .
|
|
4392
4405
|
:param task_invocation_parameters: The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty. .. epigraph:: When you update a maintenance window task that has options specified in ``TaskInvocationParameters`` , you must provide again all the ``TaskInvocationParameters`` values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified ``TaskInvocationParameters`` values for ``Comment`` , ``NotificationConfig`` , and ``OutputS3BucketName`` . If you update the maintenance window task and specify only a different ``OutputS3BucketName`` value, the values for ``Comment`` and ``NotificationConfig`` are removed.
|
|
4393
|
-
:param task_parameters:
|
|
4406
|
+
:param task_parameters: .. epigraph:: ``TaskParameters`` has been deprecated. To specify parameters to pass to a task when it runs, instead use the ``Parameters`` option in the ``TaskInvocationParameters`` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see `MaintenanceWindowTaskInvocationParameters <https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_MaintenanceWindowTaskInvocationParameters.html>`_ . The parameters to pass to the task when it runs.
|
|
4394
4407
|
|
|
4395
4408
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html
|
|
4396
4409
|
:exampleMetadata: fixture=_generated
|
|
@@ -4583,11 +4596,13 @@ class CfnMaintenanceWindowTaskProps:
|
|
|
4583
4596
|
def logging_info(
|
|
4584
4597
|
self,
|
|
4585
4598
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnMaintenanceWindowTask.LoggingInfoProperty]]:
|
|
4586
|
-
'''
|
|
4599
|
+
'''.. epigraph::
|
|
4587
4600
|
|
|
4588
|
-
|
|
4601
|
+
``LoggingInfo`` has been deprecated.
|
|
4602
|
+
|
|
4603
|
+
To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the ``OutputS3BucketName`` and ``OutputS3KeyPrefix`` options in the ``TaskInvocationParameters`` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see `AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html>`_ .
|
|
4589
4604
|
|
|
4590
|
-
|
|
4605
|
+
Information about an Amazon S3 bucket to write Run Command task-level logs to.
|
|
4591
4606
|
|
|
4592
4607
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo
|
|
4593
4608
|
'''
|
|
@@ -4678,11 +4693,13 @@ class CfnMaintenanceWindowTaskProps:
|
|
|
4678
4693
|
|
|
4679
4694
|
@builtins.property
|
|
4680
4695
|
def task_parameters(self) -> typing.Any:
|
|
4681
|
-
'''
|
|
4696
|
+
'''.. epigraph::
|
|
4682
4697
|
|
|
4683
|
-
|
|
4698
|
+
``TaskParameters`` has been deprecated.
|
|
4699
|
+
|
|
4700
|
+
To specify parameters to pass to a task when it runs, instead use the ``Parameters`` option in the ``TaskInvocationParameters`` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see `MaintenanceWindowTaskInvocationParameters <https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_MaintenanceWindowTaskInvocationParameters.html>`_ .
|
|
4684
4701
|
|
|
4685
|
-
|
|
4702
|
+
The parameters to pass to the task when it runs.
|
|
4686
4703
|
|
|
4687
4704
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters
|
|
4688
4705
|
'''
|
|
@@ -4713,12 +4730,9 @@ class CfnParameter(
|
|
|
4713
4730
|
|
|
4714
4731
|
To create an SSM parameter, you must have the AWS Identity and Access Management ( IAM ) permissions ``ssm:PutParameter`` and ``ssm:AddTagsToResource`` . On stack creation, AWS CloudFormation adds the following three tags to the parameter: ``aws:cloudformation:stack-name`` , ``aws:cloudformation:logical-id`` , and ``aws:cloudformation:stack-id`` , in addition to any custom tags you specify.
|
|
4715
4732
|
|
|
4716
|
-
To add, update, or remove tags during stack update, you must have IAM permissions for both ``ssm:AddTagsToResource`` and ``ssm:RemoveTagsFromResource`` . For more information, see `Managing
|
|
4733
|
+
To add, update, or remove tags during stack update, you must have IAM permissions for both ``ssm:AddTagsToResource`` and ``ssm:RemoveTagsFromResource`` . For more information, see `Managing access using policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage>`_ in the *AWS Systems Manager User Guide* .
|
|
4717
4734
|
|
|
4718
4735
|
For information about valid values for parameters, see `About requirements and constraints for parameter names <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints>`_ in the *AWS Systems Manager User Guide* and `PutParameter <https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html>`_ in the *AWS Systems Manager API Reference* .
|
|
4719
|
-
.. epigraph::
|
|
4720
|
-
|
|
4721
|
-
Parameters of type ``SecureString`` are not supported by AWS CloudFormation .
|
|
4722
4736
|
|
|
4723
4737
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html
|
|
4724
4738
|
:cloudformationResource: AWS::SSM::Parameter
|
|
@@ -4770,7 +4784,7 @@ class CfnParameter(
|
|
|
4770
4784
|
:param allowed_pattern: A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\\d+$``
|
|
4771
4785
|
:param data_type: The data type of the parameter, such as ``text`` or ``aws:ec2:image`` . The default is ``text`` .
|
|
4772
4786
|
:param description: Information about the parameter.
|
|
4773
|
-
:param name: The name of the parameter. .. epigraph:: The maximum length
|
|
4787
|
+
:param name: The name of the parameter. .. epigraph:: The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager . The maximum length for a parameter name that you specify is 1011 characters. This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: ``arn:aws:ssm:us-east-2:111122223333:parameter/`` .
|
|
4774
4788
|
:param policies: Information about the policies assigned to a parameter. `Assigning parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`_ in the *AWS Systems Manager User Guide* .
|
|
4775
4789
|
:param tags: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
|
|
4776
4790
|
:param tier: The parameter tier.
|
|
@@ -5011,7 +5025,7 @@ class CfnParameterProps:
|
|
|
5011
5025
|
:param allowed_pattern: A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\\d+$``
|
|
5012
5026
|
:param data_type: The data type of the parameter, such as ``text`` or ``aws:ec2:image`` . The default is ``text`` .
|
|
5013
5027
|
:param description: Information about the parameter.
|
|
5014
|
-
:param name: The name of the parameter. .. epigraph:: The maximum length
|
|
5028
|
+
:param name: The name of the parameter. .. epigraph:: The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager . The maximum length for a parameter name that you specify is 1011 characters. This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: ``arn:aws:ssm:us-east-2:111122223333:parameter/`` .
|
|
5015
5029
|
:param policies: Information about the policies assigned to a parameter. `Assigning parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`_ in the *AWS Systems Manager User Guide* .
|
|
5016
5030
|
:param tags: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
|
|
5017
5031
|
:param tier: The parameter tier.
|
|
@@ -5136,7 +5150,9 @@ class CfnParameterProps:
|
|
|
5136
5150
|
|
|
5137
5151
|
.. epigraph::
|
|
5138
5152
|
|
|
5139
|
-
The maximum length
|
|
5153
|
+
The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager . The maximum length for a parameter name that you specify is 1011 characters.
|
|
5154
|
+
|
|
5155
|
+
This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: ``arn:aws:ssm:us-east-2:111122223333:parameter/`` .
|
|
5140
5156
|
|
|
5141
5157
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name
|
|
5142
5158
|
'''
|
|
@@ -5741,7 +5757,7 @@ class CfnPatchBaseline(
|
|
|
5741
5757
|
|
|
5742
5758
|
The AWS CloudFormation ``AWS::SSM::PatchSource`` resource is used to provide information about the patches to use to update target instances, including target operating systems and source repository. Applies to Linux managed nodes only.
|
|
5743
5759
|
|
|
5744
|
-
:param configuration: The value of the
|
|
5760
|
+
:param configuration: The value of the repo configuration. *Example for yum repositories* ``[main]`` ``name=MyCustomRepository`` ``baseurl=https://my-custom-repository`` ``enabled=1`` For information about other options available for your yum repository configuration, see `dnf.conf(5) <https://docs.aws.amazon.com/https://man7.org/linux/man-pages/man5/dnf.conf.5.html>`_ on the *man7.org* website. *Examples for Ubuntu Server and Debian Server* ``deb http://security.ubuntu.com/ubuntu jammy main`` ``deb https://site.example.com/debian distribution component1 component2 component3`` Repo information for Ubuntu Server repositories must be specifed in a single line. For more examples and information, see `jammy (5) sources.list.5.gz <https://docs.aws.amazon.com/https://manpages.ubuntu.com/manpages/jammy/man5/sources.list.5.html>`_ on the *Ubuntu Server Manuals* website and `sources.list format <https://docs.aws.amazon.com/https://wiki.debian.org/SourcesList#sources.list_format>`_ on the *Debian Wiki* .
|
|
5745
5761
|
:param name: The name specified to identify the patch source.
|
|
5746
5762
|
:param products: The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see `PatchFilter <https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html>`_ in the *AWS Systems Manager API Reference* .
|
|
5747
5763
|
|
|
@@ -5775,7 +5791,9 @@ class CfnPatchBaseline(
|
|
|
5775
5791
|
|
|
5776
5792
|
@builtins.property
|
|
5777
5793
|
def configuration(self) -> typing.Optional[builtins.str]:
|
|
5778
|
-
'''The value of the
|
|
5794
|
+
'''The value of the repo configuration.
|
|
5795
|
+
|
|
5796
|
+
*Example for yum repositories*
|
|
5779
5797
|
|
|
5780
5798
|
``[main]``
|
|
5781
5799
|
|
|
@@ -5784,9 +5802,16 @@ class CfnPatchBaseline(
|
|
|
5784
5802
|
``baseurl=https://my-custom-repository``
|
|
5785
5803
|
|
|
5786
5804
|
``enabled=1``
|
|
5787
|
-
.. epigraph::
|
|
5788
5805
|
|
|
5789
|
-
|
|
5806
|
+
For information about other options available for your yum repository configuration, see `dnf.conf(5) <https://docs.aws.amazon.com/https://man7.org/linux/man-pages/man5/dnf.conf.5.html>`_ on the *man7.org* website.
|
|
5807
|
+
|
|
5808
|
+
*Examples for Ubuntu Server and Debian Server*
|
|
5809
|
+
|
|
5810
|
+
``deb http://security.ubuntu.com/ubuntu jammy main``
|
|
5811
|
+
|
|
5812
|
+
``deb https://site.example.com/debian distribution component1 component2 component3``
|
|
5813
|
+
|
|
5814
|
+
Repo information for Ubuntu Server repositories must be specifed in a single line. For more examples and information, see `jammy (5) sources.list.5.gz <https://docs.aws.amazon.com/https://manpages.ubuntu.com/manpages/jammy/man5/sources.list.5.html>`_ on the *Ubuntu Server Manuals* website and `sources.list format <https://docs.aws.amazon.com/https://wiki.debian.org/SourcesList#sources.list_format>`_ on the *Debian Wiki* .
|
|
5790
5815
|
|
|
5791
5816
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-configuration
|
|
5792
5817
|
'''
|
aws_cdk/aws_transfer/__init__.py
CHANGED
|
@@ -1752,7 +1752,7 @@ class CfnConnector(
|
|
|
1752
1752
|
) -> None:
|
|
1753
1753
|
'''A structure that contains the parameters for an SFTP connector object.
|
|
1754
1754
|
|
|
1755
|
-
:param max_concurrent_connections:
|
|
1755
|
+
:param max_concurrent_connections: Specify the number of concurrent connections that your connector creates to the remote server. The default value is ``1`` . The maximum values is ``5`` . .. epigraph:: If you are using the AWS Management Console , the default value is ``5`` . This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations. Default: - 1
|
|
1756
1756
|
:param trusted_host_keys: The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the ``ssh-keyscan`` command against the SFTP server to retrieve the necessary key. .. epigraph:: ``TrustedHostKeys`` is optional for ``CreateConnector`` . If not provided, you can use ``TestConnection`` to retrieve the server host key during the initial connection attempt, and subsequently update the connector with the observed host key. The three standard SSH public key format elements are ``<key type>`` , ``<body base64>`` , and an optional ``<comment>`` , with spaces between each element. Specify only the ``<key type>`` and ``<body base64>`` : do not enter the ``<comment>`` portion of the key. For the trusted host key, AWS Transfer Family accepts RSA and ECDSA keys. - For RSA keys, the ``<key type>`` string is ``ssh-rsa`` . - For ECDSA keys, the ``<key type>`` string is either ``ecdsa-sha2-nistp256`` , ``ecdsa-sha2-nistp384`` , or ``ecdsa-sha2-nistp521`` , depending on the size of the key you generated. Run this command to retrieve the SFTP server host key, where your SFTP server name is ``ftp.host.com`` . ``ssh-keyscan ftp.host.com`` This prints the public host key to standard output. ``ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key`` Copy and paste this string into the ``TrustedHostKeys`` field for the ``create-connector`` command or into the *Trusted host keys* field in the console.
|
|
1757
1757
|
:param user_secret_id: The identifier for the secret (in AWS Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret. .. epigraph:: - Required when creating an SFTP connector - Optional when updating an existing SFTP connector
|
|
1758
1758
|
|
|
@@ -1786,7 +1786,14 @@ class CfnConnector(
|
|
|
1786
1786
|
|
|
1787
1787
|
@builtins.property
|
|
1788
1788
|
def max_concurrent_connections(self) -> typing.Optional[jsii.Number]:
|
|
1789
|
-
'''
|
|
1789
|
+
'''Specify the number of concurrent connections that your connector creates to the remote server.
|
|
1790
|
+
|
|
1791
|
+
The default value is ``1`` . The maximum values is ``5`` .
|
|
1792
|
+
.. epigraph::
|
|
1793
|
+
|
|
1794
|
+
If you are using the AWS Management Console , the default value is ``5`` .
|
|
1795
|
+
|
|
1796
|
+
This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations.
|
|
1790
1797
|
|
|
1791
1798
|
:default: - 1
|
|
1792
1799
|
|
|
@@ -2435,7 +2442,7 @@ class CfnServer(
|
|
|
2435
2442
|
:param pre_authentication_login_banner: Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system: ``This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.``
|
|
2436
2443
|
:param protocol_details: The protocol settings that are configured for your server. - To indicate passive mode (for FTP and FTPS protocols), use the ``PassiveIp`` parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. - To ignore the error that is generated when the client attempts to use the ``SETSTAT`` command on a file that you are uploading to an Amazon S3 bucket, use the ``SetStatOption`` parameter. To have the AWS Transfer Family server ignore the ``SETSTAT`` command and upload files without needing to make any changes to your SFTP client, set the value to ``ENABLE_NO_OP`` . If you set the ``SetStatOption`` parameter to ``ENABLE_NO_OP`` , Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a ``SETSTAT`` call. - To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the ``TlsSessionResumptionMode`` parameter. - ``As2Transports`` indicates the transport method for the AS2 messages. Currently, only HTTP is supported. The ``Protocols`` parameter is an array of strings. *Allowed values* : One or more of ``SFTP`` , ``FTPS`` , ``FTP`` , ``AS2``
|
|
2437
2444
|
:param protocols: Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are: - ``SFTP`` (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH - ``FTPS`` (File Transfer Protocol Secure): File transfer with TLS encryption - ``FTP`` (File Transfer Protocol): Unencrypted file transfer - ``AS2`` (Applicability Statement 2): used for transporting structured business-to-business data .. epigraph:: - If you select ``FTPS`` , you must choose a certificate stored in AWS Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. - If ``Protocol`` includes either ``FTP`` or ``FTPS`` , then the ``EndpointType`` must be ``VPC`` and the ``IdentityProviderType`` must be either ``AWS_DIRECTORY_SERVICE`` , ``AWS_LAMBDA`` , or ``API_GATEWAY`` . - If ``Protocol`` includes ``FTP`` , then ``AddressAllocationIds`` cannot be associated. - If ``Protocol`` is set only to ``SFTP`` , the ``EndpointType`` can be set to ``PUBLIC`` and the ``IdentityProviderType`` can be set any of the supported identity types: ``SERVICE_MANAGED`` , ``AWS_DIRECTORY_SERVICE`` , ``AWS_LAMBDA`` , or ``API_GATEWAY`` . - If ``Protocol`` includes ``AS2`` , then the ``EndpointType`` must be ``VPC`` , and domain must be Amazon S3. The ``Protocols`` parameter is an array of strings. *Allowed values* : One or more of ``SFTP`` , ``FTPS`` , ``FTP`` , ``AS2``
|
|
2438
|
-
:param s3_storage_options: Specifies whether or not performance for your Amazon S3 directories is optimized.
|
|
2445
|
+
:param s3_storage_options: Specifies whether or not performance for your Amazon S3 directories is optimized. - If using the console, this is enabled by default. - If using the API or CLI, this is disabled by default. By default, home directory mappings have a ``TYPE`` of ``DIRECTORY`` . If you enable this option, you would then need to explicitly set the ``HomeDirectoryMapEntry`` ``Type`` to ``FILE`` if you want a mapping to have a file target.
|
|
2439
2446
|
:param security_policy_name: Specifies the name of the security policy for the server.
|
|
2440
2447
|
:param structured_log_destinations: Specifies the log groups to which your server logs are sent. To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows: ``arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*`` For example, ``arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*`` If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an ``update-server`` call. For example: ``update-server --server-id s-1234567890abcdef0 --structured-log-destinations``
|
|
2441
2448
|
:param tags: Key-value pairs that can be used to group and search for servers.
|
|
@@ -2723,10 +2730,7 @@ class CfnServer(
|
|
|
2723
2730
|
def s3_storage_options(
|
|
2724
2731
|
self,
|
|
2725
2732
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnServer.S3StorageOptionsProperty"]]:
|
|
2726
|
-
'''Specifies whether or not performance for your Amazon S3 directories is optimized.
|
|
2727
|
-
|
|
2728
|
-
This is disabled by default.
|
|
2729
|
-
'''
|
|
2733
|
+
'''Specifies whether or not performance for your Amazon S3 directories is optimized.'''
|
|
2730
2734
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnServer.S3StorageOptionsProperty"]], jsii.get(self, "s3StorageOptions"))
|
|
2731
2735
|
|
|
2732
2736
|
@s3_storage_options.setter
|
|
@@ -3240,7 +3244,7 @@ class CfnServer(
|
|
|
3240
3244
|
) -> None:
|
|
3241
3245
|
'''The Amazon S3 storage options that are configured for your server.
|
|
3242
3246
|
|
|
3243
|
-
:param directory_listing_optimization: Specifies whether or not performance for your Amazon S3 directories is optimized.
|
|
3247
|
+
:param directory_listing_optimization: Specifies whether or not performance for your Amazon S3 directories is optimized. - If using the console, this is enabled by default. - If using the API or CLI, this is disabled by default. By default, home directory mappings have a ``TYPE`` of ``DIRECTORY`` . If you enable this option, you would then need to explicitly set the ``HomeDirectoryMapEntry`` ``Type`` to ``FILE`` if you want a mapping to have a file target.
|
|
3244
3248
|
|
|
3245
3249
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-s3storageoptions.html
|
|
3246
3250
|
:exampleMetadata: fixture=_generated
|
|
@@ -3264,7 +3268,10 @@ class CfnServer(
|
|
|
3264
3268
|
|
|
3265
3269
|
@builtins.property
|
|
3266
3270
|
def directory_listing_optimization(self) -> typing.Optional[builtins.str]:
|
|
3267
|
-
'''Specifies whether or not performance for your Amazon S3 directories is optimized.
|
|
3271
|
+
'''Specifies whether or not performance for your Amazon S3 directories is optimized.
|
|
3272
|
+
|
|
3273
|
+
- If using the console, this is enabled by default.
|
|
3274
|
+
- If using the API or CLI, this is disabled by default.
|
|
3268
3275
|
|
|
3269
3276
|
By default, home directory mappings have a ``TYPE`` of ``DIRECTORY`` . If you enable this option, you would then need to explicitly set the ``HomeDirectoryMapEntry`` ``Type`` to ``FILE`` if you want a mapping to have a file target.
|
|
3270
3277
|
|
|
@@ -3510,7 +3517,7 @@ class CfnServerProps:
|
|
|
3510
3517
|
:param pre_authentication_login_banner: Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system: ``This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.``
|
|
3511
3518
|
:param protocol_details: The protocol settings that are configured for your server. - To indicate passive mode (for FTP and FTPS protocols), use the ``PassiveIp`` parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. - To ignore the error that is generated when the client attempts to use the ``SETSTAT`` command on a file that you are uploading to an Amazon S3 bucket, use the ``SetStatOption`` parameter. To have the AWS Transfer Family server ignore the ``SETSTAT`` command and upload files without needing to make any changes to your SFTP client, set the value to ``ENABLE_NO_OP`` . If you set the ``SetStatOption`` parameter to ``ENABLE_NO_OP`` , Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a ``SETSTAT`` call. - To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the ``TlsSessionResumptionMode`` parameter. - ``As2Transports`` indicates the transport method for the AS2 messages. Currently, only HTTP is supported. The ``Protocols`` parameter is an array of strings. *Allowed values* : One or more of ``SFTP`` , ``FTPS`` , ``FTP`` , ``AS2``
|
|
3512
3519
|
:param protocols: Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are: - ``SFTP`` (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH - ``FTPS`` (File Transfer Protocol Secure): File transfer with TLS encryption - ``FTP`` (File Transfer Protocol): Unencrypted file transfer - ``AS2`` (Applicability Statement 2): used for transporting structured business-to-business data .. epigraph:: - If you select ``FTPS`` , you must choose a certificate stored in AWS Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. - If ``Protocol`` includes either ``FTP`` or ``FTPS`` , then the ``EndpointType`` must be ``VPC`` and the ``IdentityProviderType`` must be either ``AWS_DIRECTORY_SERVICE`` , ``AWS_LAMBDA`` , or ``API_GATEWAY`` . - If ``Protocol`` includes ``FTP`` , then ``AddressAllocationIds`` cannot be associated. - If ``Protocol`` is set only to ``SFTP`` , the ``EndpointType`` can be set to ``PUBLIC`` and the ``IdentityProviderType`` can be set any of the supported identity types: ``SERVICE_MANAGED`` , ``AWS_DIRECTORY_SERVICE`` , ``AWS_LAMBDA`` , or ``API_GATEWAY`` . - If ``Protocol`` includes ``AS2`` , then the ``EndpointType`` must be ``VPC`` , and domain must be Amazon S3. The ``Protocols`` parameter is an array of strings. *Allowed values* : One or more of ``SFTP`` , ``FTPS`` , ``FTP`` , ``AS2``
|
|
3513
|
-
:param s3_storage_options: Specifies whether or not performance for your Amazon S3 directories is optimized.
|
|
3520
|
+
:param s3_storage_options: Specifies whether or not performance for your Amazon S3 directories is optimized. - If using the console, this is enabled by default. - If using the API or CLI, this is disabled by default. By default, home directory mappings have a ``TYPE`` of ``DIRECTORY`` . If you enable this option, you would then need to explicitly set the ``HomeDirectoryMapEntry`` ``Type`` to ``FILE`` if you want a mapping to have a file target.
|
|
3514
3521
|
:param security_policy_name: Specifies the name of the security policy for the server.
|
|
3515
3522
|
:param structured_log_destinations: Specifies the log groups to which your server logs are sent. To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows: ``arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*`` For example, ``arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*`` If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an ``update-server`` call. For example: ``update-server --server-id s-1234567890abcdef0 --structured-log-destinations``
|
|
3516
3523
|
:param tags: Key-value pairs that can be used to group and search for servers.
|
|
@@ -3817,7 +3824,10 @@ class CfnServerProps:
|
|
|
3817
3824
|
def s3_storage_options(
|
|
3818
3825
|
self,
|
|
3819
3826
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnServer.S3StorageOptionsProperty]]:
|
|
3820
|
-
'''Specifies whether or not performance for your Amazon S3 directories is optimized.
|
|
3827
|
+
'''Specifies whether or not performance for your Amazon S3 directories is optimized.
|
|
3828
|
+
|
|
3829
|
+
- If using the console, this is enabled by default.
|
|
3830
|
+
- If using the API or CLI, this is disabled by default.
|
|
3821
3831
|
|
|
3822
3832
|
By default, home directory mappings have a ``TYPE`` of ``DIRECTORY`` . If you enable this option, you would then need to explicitly set the ``HomeDirectoryMapEntry`` ``Type`` to ``FILE`` if you want a mapping to have a file target.
|
|
3823
3833
|
|