Interface ICfnTaskProps

Properties for defining a CfnTask.

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.AWS.DataSync.dll

Syntax (csharp)

public interface ICfnTaskProps

Syntax (vb)

Public Interface ICfnTaskProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataSync;

CfnTaskProps cfnTaskProps = new CfnTaskProps {
    DestinationLocationArn = "destinationLocationArn",
    SourceLocationArn = "sourceLocationArn",

    // the properties below are optional
    CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
    Excludes = new [] { new FilterRuleProperty {
        FilterType = "filterType",
        Value = "value"
    } },
    Includes = new [] { new FilterRuleProperty {
        FilterType = "filterType",
        Value = "value"
    } },
    Name = "name",
    Options = new OptionsProperty {
        Atime = "atime",
        BytesPerSecond = 123,
        Gid = "gid",
        LogLevel = "logLevel",
        Mtime = "mtime",
        ObjectTags = "objectTags",
        OverwriteMode = "overwriteMode",
        PosixPermissions = "posixPermissions",
        PreserveDeletedFiles = "preserveDeletedFiles",
        PreserveDevices = "preserveDevices",
        SecurityDescriptorCopyFlags = "securityDescriptorCopyFlags",
        TaskQueueing = "taskQueueing",
        TransferMode = "transferMode",
        Uid = "uid",
        VerifyMode = "verifyMode"
    },
    Schedule = new TaskScheduleProperty {
        ScheduleExpression = "scheduleExpression"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

CloudWatchLogGroupArn	The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
DestinationLocationArn	The Amazon Resource Name (ARN) of an AWS storage resource's location.
Excludes	A list of filter rules that determines which files to exclude from a task.
Includes	A list of filter rules that determines which files to include when running a task.
Name	The name of a task.
Options	The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution` .
Schedule	Specifies a schedule used to periodically transfer files from a source to a destination location.
SourceLocationArn	The Amazon Resource Name (ARN) of the source location for the task.
Tags	The key-value pair that represents the tag that you want to add to the resource.

Properties

CloudWatchLogGroupArn

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

virtual string CloudWatchLogGroupArn { get; }

Property Value

System.String

Remarks

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 .

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

DestinationLocationArn

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

string DestinationLocationArn { get; }

Property Value

System.String

Remarks

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

Excludes

A list of filter rules that determines which files to exclude from a task.

virtual object Excludes { get; }

Property Value

System.Object

Remarks

The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2" .

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

Includes

A list of filter rules that determines which files to include when running a task.

virtual object Includes { get; }

Property Value

System.Object

Remarks

The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2" .

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

Name

The name of a task.

virtual string Name { get; }

Property Value

System.String

Remarks

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

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

Options

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution .

virtual object Options { get; }

Property Value

System.Object

Remarks

You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

Link: 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.

virtual object Schedule { get; }

Property Value

System.Object

Remarks

The schedule should be specified in UTC time. For more information, see Scheduling your task .

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

SourceLocationArn

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

string SourceLocationArn { get; }

Property Value

System.String

Remarks

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