CfnTaskProps

class aws_cdk.aws_datasync.CfnTaskProps(*, destination_location_arn, source_location_arn, cloud_watch_log_group_arn=None, excludes=None, includes=None, manifest_config=None, name=None, options=None, schedule=None, tags=None, task_report_config=None)

Bases: object

Properties for defining a CfnTask.

Parameters:

destination_location_arn (str) – The Amazon Resource Name (ARN) of an AWS storage resource’s location.
source_location_arn (str) – The Amazon Resource Name (ARN) of the source location for the task.
cloud_watch_log_group_arn (Optional[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 in the AWS DataSync User Guide. For more information about these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch Logs User Guide .
excludes (Union[IResolvable, Sequence[Union[IResolvable, FilterRuleProperty, Dict[str, Any]]], None]) – Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync .
includes (Union[IResolvable, Sequence[Union[IResolvable, FilterRuleProperty, Dict[str, Any]]], None]) –
Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync .
manifest_config (Union[IResolvable, ManifestConfigProperty, Dict[str, Any], None]) – 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 .
name (Optional[str]) – The name of a task. This value is a text reference that is used to identify the task in the console.
options (Union[IResolvable, OptionsProperty, Dict[str, Any], None]) – 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 .
schedule (Union[IResolvable, TaskScheduleProperty, Dict[str, Any], None]) – 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 .
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.
task_report_config (Union[IResolvable, TaskReportConfigProperty, Dict[str, Any], None]) – 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 . When using this parameter, your caller identity (the role that you’re using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datasync as datasync

cfn_task_props = datasync.CfnTaskProps(
    destination_location_arn="destinationLocationArn",
    source_location_arn="sourceLocationArn",

    # the properties below are optional
    cloud_watch_log_group_arn="cloudWatchLogGroupArn",
    excludes=[datasync.CfnTask.FilterRuleProperty(
        filter_type="filterType",
        value="value"
    )],
    includes=[datasync.CfnTask.FilterRuleProperty(
        filter_type="filterType",
        value="value"
    )],
    manifest_config=datasync.CfnTask.ManifestConfigProperty(
        source=datasync.CfnTask.SourceProperty(
            s3=datasync.CfnTask.ManifestConfigSourceS3Property(
                bucket_access_role_arn="bucketAccessRoleArn",
                manifest_object_path="manifestObjectPath",
                manifest_object_version_id="manifestObjectVersionId",
                s3_bucket_arn="s3BucketArn"
            )
        ),

        # the properties below are optional
        action="action",
        format="format"
    ),
    name="name",
    options=datasync.CfnTask.OptionsProperty(
        atime="atime",
        bytes_per_second=123,
        gid="gid",
        log_level="logLevel",
        mtime="mtime",
        object_tags="objectTags",
        overwrite_mode="overwriteMode",
        posix_permissions="posixPermissions",
        preserve_deleted_files="preserveDeletedFiles",
        preserve_devices="preserveDevices",
        security_descriptor_copy_flags="securityDescriptorCopyFlags",
        task_queueing="taskQueueing",
        transfer_mode="transferMode",
        uid="uid",
        verify_mode="verifyMode"
    ),
    schedule=datasync.CfnTask.TaskScheduleProperty(
        schedule_expression="scheduleExpression"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    task_report_config=datasync.CfnTask.TaskReportConfigProperty(
        destination=datasync.CfnTask.DestinationProperty(
            s3=datasync.CfnTask.S3Property(
                bucket_access_role_arn="bucketAccessRoleArn",
                s3_bucket_arn="s3BucketArn",
                subdirectory="subdirectory"
            )
        ),
        output_type="outputType",

        # the properties below are optional
        object_version_ids="objectVersionIds",
        overrides=datasync.CfnTask.OverridesProperty(
            deleted=datasync.CfnTask.DeletedProperty(
                report_level="reportLevel"
            ),
            skipped=datasync.CfnTask.SkippedProperty(
                report_level="reportLevel"
            ),
            transferred=datasync.CfnTask.TransferredProperty(
                report_level="reportLevel"
            ),
            verified=datasync.CfnTask.VerifiedProperty(
                report_level="reportLevel"
            )
        ),
        report_level="reportLevel"
    )
)

Attributes

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 in the AWS DataSync User Guide.

For more information about these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch Logs User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-cloudwatchloggrouparn

destination_location_arn

The Amazon Resource Name (ARN) of an AWS storage resource’s location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-destinationlocationarn

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-excludes

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-includes

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-manifestconfig

name

The name of a task.

This value is a text reference that is used to identify the task in the console.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-name

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-options

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-schedule

source_location_arn

The Amazon Resource Name (ARN) of the source location for the task.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-sourcelocationarn

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-tags

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 .

When using this parameter, your caller identity (the role that you’re using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskreportconfig