Interface ICfnTaskProps

Properties for defining a CfnTask.

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnTaskProps

Syntax (vb)

Public Interface ICfnTaskProps

Remarks

See: 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"
                 } },
                 ManifestConfig = new ManifestConfigProperty {
                     Source = new SourceProperty {
                         S3 = new ManifestConfigSourceS3Property {
                             BucketAccessRoleArn = "bucketAccessRoleArn",
                             ManifestObjectPath = "manifestObjectPath",
                             ManifestObjectVersionId = "manifestObjectVersionId",
                             S3BucketArn = "s3BucketArn"
                         }
                     },

                     // the properties below are optional
                     Action = "action",
                     Format = "format"
                 },
                 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",
                     Status = "status"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TaskMode = "taskMode",
                 TaskReportConfig = new TaskReportConfigProperty {
                     Destination = new DestinationProperty {
                         S3 = new S3Property {
                             BucketAccessRoleArn = "bucketAccessRoleArn",
                             S3BucketArn = "s3BucketArn",
                             Subdirectory = "subdirectory"
                         }
                     },
                     OutputType = "outputType",

                     // the properties below are optional
                     ObjectVersionIds = "objectVersionIds",
                     Overrides = new OverridesProperty {
                         Deleted = new DeletedProperty {
                             ReportLevel = "reportLevel"
                         },
                         Skipped = new SkippedProperty {
                             ReportLevel = "reportLevel"
                         },
                         Transferred = new TransferredProperty {
                             ReportLevel = "reportLevel"
                         },
                         Verified = new VerifiedProperty {
                             ReportLevel = "reportLevel"
                         }
                     },
                     ReportLevel = "reportLevel"
                 }
             };

Synopsis

Properties

CloudWatchLogGroupArn	Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
DestinationLocationArn	The Amazon Resource Name (ARN) of an AWS storage resource's location.
Excludes	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
Includes	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
ManifestConfig	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
Name	Specifies the name of your task.
Options	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
Schedule	Specifies a schedule for when you want your task to run.
SourceLocationArn	Specifies the ARN of your transfer's source location.
Tags	Specifies the tags that you want to apply to your task.
TaskMode	The task mode that you're using.
TaskReportConfig	The configuration of your task report, which provides detailed information about your DataSync transfer.