aws-cdk-lib 2.140.0__py3-none-any.whl → 2.141.0__py3-none-any.whl

aws_cdk/aws_datasync/__init__.py

@@ -6819,15 +6819,15 @@ class CfnTask(
         :param scope: Scope in which this resource is defined.
         :param id: Construct identifier for this resource (unique in its scope).
         :param destination_location_arn: The Amazon Resource Name (ARN) of an AWS storage resource's location.
-        :param source_location_arn: The Amazon Resource Name (ARN) of the source location for the task.
-        :param cloud_watch_log_group_arn: The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. For more information about how to use CloudWatch Logs with DataSync, see `Monitoring Your Task <https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html#cloudwatchlogs>`_ in the *AWS DataSync User Guide.* For more information about these groups, see `Working with Log Groups and Log Streams <https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html>`_ in the *Amazon CloudWatch Logs User Guide* .
-        :param excludes: Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see `Filtering data transferred by DataSync <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
-        :param includes: Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see `Filtering data transferred by DataSync <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
-        :param manifest_config: The configuration of the manifest that lists the files or objects to transfer. For more information, see `Specifying what DataSync transfers by using a manifest <https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html>`_ .
-        :param name: The name of a task. This value is a text reference that is used to identify the task in the console.
-        :param options: Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity. You can also override these options before starting an individual run of a task (also known as a *task execution* ). For more information, see `StartTaskExecution <https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html>`_ .
-        :param schedule: Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see `Scheduling your task <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html>`_ .
-        :param tags: Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task. *Tags* are key-value pairs that help you manage, filter, and search for your DataSync resources.
+        :param source_location_arn: Specifies the ARN of your transfer's source location.
+        :param cloud_watch_log_group_arn: Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task. For more information, see `Monitoring DataSync with Amazon CloudWatch <https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html>`_ .
+        :param excludes: Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see `Specifying what DataSync transfers by using filters <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
+        :param includes: Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see `Specifying what DataSync transfers by using filters <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
+        :param manifest_config: The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see `Specifying what DataSync transfers by using a manifest <https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html>`_ .
+        :param name: Specifies the name of your task.
+        :param options: Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
+        :param schedule: Specifies a schedule for when you want your task to run. For more information, see `Scheduling your task <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html>`_ .
+        :param tags: Specifies the tags that you want to apply to your task. *Tags* are key-value pairs that help you manage, filter, and search for your DataSync resources.
         :param task_report_config: Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see `Monitoring your DataSync transfers with task reports <https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html>`_ . When using this parameter, your caller identity (the role that you're using DataSync with) must have the ``iam:PassRole`` permission. The `AWSDataSyncFullAccess <https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess>`_ policy includes this permission.
         '''
         if __debug__:
@@ -6943,7 +6943,7 @@ class CfnTask(
     @builtins.property
     @jsii.member(jsii_name="sourceLocationArn")
     def source_location_arn(self) -> builtins.str:
-        '''The Amazon Resource Name (ARN) of the source location for the task.'''
+        '''Specifies the ARN of your transfer's source location.'''
         return typing.cast(builtins.str, jsii.get(self, "sourceLocationArn"))
 
     @source_location_arn.setter
@@ -6956,7 +6956,7 @@ class CfnTask(
     @builtins.property
     @jsii.member(jsii_name="cloudWatchLogGroupArn")
     def cloud_watch_log_group_arn(self) -> typing.Optional[builtins.str]:
-        '''The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.'''
+        '''Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "cloudWatchLogGroupArn"))
 
     @cloud_watch_log_group_arn.setter
@@ -6971,7 +6971,7 @@ class CfnTask(
     def excludes(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnTask.FilterRuleProperty"]]]]:
-        '''Specifies a list of filter rules that exclude specific data during your transfer.'''
+        '''Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnTask.FilterRuleProperty"]]]], jsii.get(self, "excludes"))
 
     @excludes.setter
@@ -6989,7 +6989,7 @@ class CfnTask(
     def includes(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnTask.FilterRuleProperty"]]]]:
-        '''Specifies a list of filter rules that include specific data during your transfer.'''
+        '''Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnTask.FilterRuleProperty"]]]], jsii.get(self, "includes"))
 
     @includes.setter
@@ -7007,7 +7007,7 @@ class CfnTask(
     def manifest_config(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.ManifestConfigProperty"]]:
-        '''The configuration of the manifest that lists the files or objects to transfer.'''
+        '''The configuration of the manifest that lists the files or objects that you want DataSync to transfer.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.ManifestConfigProperty"]], jsii.get(self, "manifestConfig"))
 
     @manifest_config.setter
@@ -7023,7 +7023,7 @@ class CfnTask(
     @builtins.property
     @jsii.member(jsii_name="name")
     def name(self) -> typing.Optional[builtins.str]:
-        '''The name of a task.'''
+        '''Specifies the name of your task.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "name"))
 
     @name.setter
@@ -7038,10 +7038,7 @@ class CfnTask(
     def options(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.OptionsProperty"]]:
-        '''Specifies the configuration options for a task.
-
-        Some options include preserving file or object metadata and verifying data integrity.
-        '''
+        '''Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.OptionsProperty"]], jsii.get(self, "options"))
 
     @options.setter
@@ -7059,7 +7056,7 @@ class CfnTask(
     def schedule(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.TaskScheduleProperty"]]:
-        '''Specifies a schedule used to periodically transfer files from a source to a destination location.'''
+        '''Specifies a schedule for when you want your task to run.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.TaskScheduleProperty"]], jsii.get(self, "schedule"))
 
     @schedule.setter
@@ -7075,7 +7072,7 @@ class CfnTask(
     @builtins.property
     @jsii.member(jsii_name="tagsRaw")
     def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
-        '''Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.'''
+        '''Specifies the tags that you want to apply to your task.'''
         return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
 
     @tags_raw.setter
@@ -8427,12 +8424,10 @@ class CfnTask(
             schedule_expression: typing.Optional[builtins.str] = None,
             status: typing.Optional[builtins.str] = None,
         ) -> None:
-            '''Specifies the schedule you want your task to use for repeated executions.
-
-            For more information, see `Schedule Expressions for Rules <https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html>`_ .
+            '''Configures your AWS DataSync task to run on a `schedule <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html>`_ (at a minimum interval of 1 hour).
 
-            :param schedule_expression: A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location.
-            :param status: Specifies status of a schedule.
+            :param schedule_expression: Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the `*Amazon EventBridge User Guide* <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html>`_ .
+            :param status: Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to perform maintenance on a storage system before you can begin a recurring DataSync transfer. DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see the `*DataSync User Guide* <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html#pause-task-schedule>`_ .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html
             :exampleMetadata: fixture=_generated
@@ -8460,7 +8455,9 @@ class CfnTask(
 
         @builtins.property
         def schedule_expression(self) -> typing.Optional[builtins.str]:
-            '''A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location.
+            '''Specifies your task schedule by using a cron expression in UTC time.
+
+            For information about cron expression syntax, see the `*Amazon EventBridge User Guide* <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html>`_ .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html#cfn-datasync-task-taskschedule-scheduleexpression
             '''
@@ -8469,7 +8466,11 @@ class CfnTask(
 
         @builtins.property
         def status(self) -> typing.Optional[builtins.str]:
-            '''Specifies status of a schedule.
+            '''Specifies whether to enable or disable your task schedule.
+
+            Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to perform maintenance on a storage system before you can begin a recurring DataSync transfer.
+
+            DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see the `*DataSync User Guide* <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html#pause-task-schedule>`_ .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html#cfn-datasync-task-taskschedule-status
             '''
@@ -8640,15 +8641,15 @@ class CfnTaskProps:
         '''Properties for defining a ``CfnTask``.
 
         :param destination_location_arn: The Amazon Resource Name (ARN) of an AWS storage resource's location.
-        :param source_location_arn: The Amazon Resource Name (ARN) of the source location for the task.
-        :param cloud_watch_log_group_arn: The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. For more information about how to use CloudWatch Logs with DataSync, see `Monitoring Your Task <https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html#cloudwatchlogs>`_ in the *AWS DataSync User Guide.* For more information about these groups, see `Working with Log Groups and Log Streams <https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html>`_ in the *Amazon CloudWatch Logs User Guide* .
-        :param excludes: Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see `Filtering data transferred by DataSync <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
-        :param includes: Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see `Filtering data transferred by DataSync <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
-        :param manifest_config: The configuration of the manifest that lists the files or objects to transfer. For more information, see `Specifying what DataSync transfers by using a manifest <https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html>`_ .
-        :param name: The name of a task. This value is a text reference that is used to identify the task in the console.
-        :param options: Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity. You can also override these options before starting an individual run of a task (also known as a *task execution* ). For more information, see `StartTaskExecution <https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html>`_ .
-        :param schedule: Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see `Scheduling your task <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html>`_ .
-        :param tags: Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task. *Tags* are key-value pairs that help you manage, filter, and search for your DataSync resources.
+        :param source_location_arn: Specifies the ARN of your transfer's source location.
+        :param cloud_watch_log_group_arn: Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task. For more information, see `Monitoring DataSync with Amazon CloudWatch <https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html>`_ .
+        :param excludes: Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see `Specifying what DataSync transfers by using filters <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
+        :param includes: Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see `Specifying what DataSync transfers by using filters <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
+        :param manifest_config: The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see `Specifying what DataSync transfers by using a manifest <https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html>`_ .
+        :param name: Specifies the name of your task.
+        :param options: Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
+        :param schedule: Specifies a schedule for when you want your task to run. For more information, see `Scheduling your task <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html>`_ .
+        :param tags: Specifies the tags that you want to apply to your task. *Tags* are key-value pairs that help you manage, filter, and search for your DataSync resources.
         :param task_report_config: Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see `Monitoring your DataSync transfers with task reports <https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html>`_ . When using this parameter, your caller identity (the role that you're using DataSync with) must have the ``iam:PassRole`` permission. The `AWSDataSyncFullAccess <https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess>`_ policy includes this permission.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html
@@ -8792,7 +8793,7 @@ class CfnTaskProps:
 
     @builtins.property
     def source_location_arn(self) -> builtins.str:
-        '''The Amazon Resource Name (ARN) of the source location for the task.
+        '''Specifies the ARN of your transfer's source location.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-sourcelocationarn
         '''
@@ -8802,11 +8803,9 @@ class CfnTaskProps:
 
     @builtins.property
     def cloud_watch_log_group_arn(self) -> typing.Optional[builtins.str]:
-        '''The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
-
-        For more information about how to use CloudWatch Logs with DataSync, see `Monitoring Your Task <https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html#cloudwatchlogs>`_ in the *AWS DataSync User Guide.*
+        '''Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
 
-        For more information about these groups, see `Working with Log Groups and Log Streams <https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html>`_ in the *Amazon CloudWatch Logs User Guide* .
+        For more information, see `Monitoring DataSync with Amazon CloudWatch <https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html>`_ .
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-cloudwatchloggrouparn
         '''
@@ -8817,9 +8816,9 @@ class CfnTaskProps:
     def excludes(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnTask.FilterRuleProperty]]]]:
-        '''Specifies a list of filter rules that exclude specific data during your transfer.
+        '''Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
 
-        For more information and examples, see `Filtering data transferred by DataSync <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
+        For more information and examples, see `Specifying what DataSync transfers by using filters <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-excludes
         '''
@@ -8830,9 +8829,9 @@ class CfnTaskProps:
     def includes(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnTask.FilterRuleProperty]]]]:
-        '''Specifies a list of filter rules that include specific data during your transfer.
+        '''Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.
 
-        For more information and examples, see `Filtering data transferred by DataSync <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
+        For more information and examples, see `Specifying what DataSync transfers by using filters <https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html>`_ .
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-includes
         '''
@@ -8843,7 +8842,7 @@ class CfnTaskProps:
     def manifest_config(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnTask.ManifestConfigProperty]]:
-        '''The configuration of the manifest that lists the files or objects to transfer.
+        '''The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
 
         For more information, see `Specifying what DataSync transfers by using a manifest <https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html>`_ .
 
@@ -8854,9 +8853,7 @@ class CfnTaskProps:
 
     @builtins.property
     def name(self) -> typing.Optional[builtins.str]:
-        '''The name of a task.
-
-        This value is a text reference that is used to identify the task in the console.
+        '''Specifies the name of your task.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-name
         '''
@@ -8867,9 +8864,7 @@ class CfnTaskProps:
     def options(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnTask.OptionsProperty]]:
-        '''Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.
-
-        You can also override these options before starting an individual run of a task (also known as a *task execution* ). For more information, see `StartTaskExecution <https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html>`_ .
+        '''Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-options
         '''
@@ -8880,9 +8875,9 @@ class CfnTaskProps:
     def schedule(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnTask.TaskScheduleProperty]]:
-        '''Specifies a schedule used to periodically transfer files from a source to a destination location.
+        '''Specifies a schedule for when you want your task to run.
 
-        The schedule should be specified in UTC time. For more information, see `Scheduling your task <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html>`_ .
+        For more information, see `Scheduling your task <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html>`_ .
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-schedule
         '''
@@ -8891,7 +8886,7 @@ class CfnTaskProps:
 
     @builtins.property
     def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
-        '''Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.
+        '''Specifies the tags that you want to apply to your task.
 
         *Tags* are key-value pairs that help you manage, filter, and search for your DataSync resources.