MDAA TS Docs
    Preparing search index...

    Interface TaskProps

    DataSync task configuration for automated data transfer between source and destination locations. Tasks can reference MDAA-generated locations by name or external locations by ARN. Supports scheduling via cron expressions, include/exclude file filtering, and transfer options (e.g. preserveDeletedFiles, transferMode, verifyMode). MDAA automatically creates a CloudWatch log group with KMS encryption for task logging.

    Use cases: Scheduled data synchronization; One-time data migration; Incremental transfers with filtering

    AWS: DataSync Task resource (CfnTask) with CloudWatch logging

    Validation: One of sourceLocationName/sourceLocationArn required; one of destinationLocationName/destinationLocationArn required

    interface TaskProps {
        destinationLocationArn?: string;
        destinationLocationName?: string;
        excludes?: FilterRuleProperty[];
        includes?: FilterRuleProperty[];
        logGroupEncryptionKeyArn?: string;
        options?: OptionsProperty | IResolvable;
        schedule?: IResolvable | TaskScheduleProperty;
        sourceLocationArn?: string;
        sourceLocationName?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    destinationLocationArn? destinationLocationName? excludes? includes? logGroupEncryptionKeyArn? options? schedule? sourceLocationArn? sourceLocationName?

    Properties

    destinationLocationArn?: string

    ARN of an existing DataSync destination location created outside MDAA. Accepts static ARNs or dynamic references (e.g. SSM parameters). Mutually exclusive with destinationLocationName.

    Use cases: Externally managed destination locations; Pre-existing DataSync locations

    AWS: DataSync destination location ARN for task configuration

    Validation: Optional; mutually exclusive with destinationLocationName; must be valid location ARN or dynamic reference

    destinationLocationName?: string

    Name of an MDAA-generated destination location from the locations config section. Resolved to the location ARN automatically. Mutually exclusive with destinationLocationArn.

    Use cases: Referencing MDAA-managed locations by name; Simplified task configuration

    AWS: Resolved to DataSync location ARN for task destination

    Validation: Optional; mutually exclusive with destinationLocationArn; must reference valid generated location name

    excludes?: FilterRuleProperty[]

    Filter rules to exclude specific files/directories from the transfer. Uses SIMPLE_PATTERN filterType with pipe-delimited values (e.g. ".tmp|.temp"). CloudFormation accepts only one member in the excludes list.

    Use cases: Excluding temporary files; Skipping specific directories; Transfer scope reduction

    AWS: DataSync task exclude filter rules (CfnTask.FilterRuleProperty)

    Validation: Optional; must follow DataSync SIMPLE_PATTERN filtering syntax

    includes?: FilterRuleProperty[]

    Filter rules to include specific files/directories in the transfer. Uses SIMPLE_PATTERN filterType with pipe-delimited values (e.g. "/data*|/ingestion*"). Values must begin with / and only accept asterisk at the rightmost position. CloudFormation accepts only one member in the includes list.

    Use cases: Targeted data migration; Selective directory transfer; Transfer scope control

    AWS: DataSync task include filter rules (CfnTask.FilterRuleProperty)

    Validation: Optional; must follow DataSync SIMPLE_PATTERN filtering syntax; values begin with /

    logGroupEncryptionKeyArn?: string

    ARN of a KMS key for encrypting the task's CloudWatch log group. If omitted, MDAA creates a new KMS key automatically.

    Use cases: Custom encryption key management; Shared KMS key across resources

    AWS: KMS key ARN for CloudWatch log group encryption

    Validation: Optional; must be valid KMS key ARN if provided

    options?: OptionsProperty | IResolvable

    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/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-options

    schedule?: IResolvable | TaskScheduleProperty

    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/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-schedule

    sourceLocationArn?: string

    ARN of an existing DataSync source location created outside MDAA. Accepts static ARNs or dynamic references (e.g. SSM parameters). Mutually exclusive with sourceLocationName.

    Use cases: Externally managed source locations; Pre-existing DataSync locations

    AWS: DataSync source location ARN for task configuration

    Validation: Optional; mutually exclusive with sourceLocationName; must be valid location ARN or dynamic reference

    sourceLocationName?: string

    Name of an MDAA-generated source location from the locations config section. Resolved to the location ARN automatically. Mutually exclusive with sourceLocationArn.

    Use cases: Referencing MDAA-managed locations by name; Simplified task configuration

    AWS: Resolved to DataSync location ARN for task source

    Validation: Optional; mutually exclusive with sourceLocationArn; must reference valid generated location name

    Settings

    Member Visibility

    On This Page

    Properties