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;
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
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. |
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 .
DestinationLocationArn
The Amazon Resource Name (ARN) of an AWS storage resource's location.
string DestinationLocationArn { get; }
Property Value
System.String
Remarks
Excludes
Specifies a list of filter rules that exclude specific data during your transfer.
virtual object Excludes { get; }
Property Value
System.Object
Remarks
For more information and examples, see Filtering data transferred by DataSync .
Includes
Specifies a list of filter rules that include specific data during your transfer.
virtual object Includes { get; }
Property Value
System.Object
Remarks
For more information and examples, see Filtering data transferred by DataSync .
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.
Options
Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.
virtual object Options { get; }
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 .
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 .
SourceLocationArn
The Amazon Resource Name (ARN) of the source location for the task.
string SourceLocationArn { get; }
Property Value
System.String
Remarks
Tags
Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.