Class CfnTaskProps

Properties for defining a CfnTask.

Inheritance

System.Object

CfnTaskProps

Implements

ICfnTaskProps

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.AWS.DataSync.dll

Syntax (csharp)

public class CfnTaskProps : Object, ICfnTaskProps

Syntax (vb)

Public Class CfnTaskProps
    Inherits Object
    Implements 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;

var 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

Constructors

CfnTaskProps()

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	Specifies a list of filter rules that exclude specific data during your transfer.
Includes	Specifies a list of filter rules that include specific data during your transfer.
Name	The name of a task.
Options	Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.
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	Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

Constructors

CfnTaskProps()

public CfnTaskProps()

Properties

CloudWatchLogGroupArn

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

public string CloudWatchLogGroupArn { get; set; }

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.

public string DestinationLocationArn { get; set; }

Property Value

System.String

Remarks

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

public object Excludes { get; set; }

Property Value

System.Object

Remarks

For more information and examples, see Filtering data transferred by DataSync .

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

public object Includes { get; set; }

Property Value

System.Object

Remarks

For more information and examples, see Filtering data transferred by DataSync .

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

Name

The name of a task.

public string Name { get; set; }

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

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

public object Options { get; set; }

Property Value

System.Object

Remarks

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 .

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.

public object Schedule { get; set; }

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.

public string SourceLocationArn { get; set; }

Property Value

System.String

Remarks

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

Implements

ICfnTaskProps