Class CfnTask
The AWS::DataSync::Task
resource specifies a task.
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTask : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnTask
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
A task is a set of two locations (source and destination) and a set of Options
that you use to control the behavior of a task. If you don't specify Options
when you create a task, AWS DataSync populates them with service defaults.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html
CloudformationResource: AWS::DataSync::Task
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 cfnTask = new CfnTask(this, "MyCfnTask", 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"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
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
Constructors
CfnTask(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnTask(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnTask(Construct, String, ICfnTaskProps) |
Properties
AttrDestinationNetworkInterfaceArns | The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet. |
AttrSourceNetworkInterfaceArns | The ARNs of the source ENIs that were created for your subnet. |
AttrStatus | The status of the task that was described. |
AttrTaskArn | The ARN of the task. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
ManifestConfig | The configuration of the manifest that lists the files or objects to transfer. |
Name | The name of a task. |
Options | Specifies the configuration options for a task. |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task. |
TaskReportConfig | Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTask(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTask(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTask(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTask(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnTask(Construct, String, ICfnTaskProps)
public CfnTask(Construct scope, string id, ICfnTaskProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnTaskProps
Resource properties.
Properties
AttrDestinationNetworkInterfaceArns
The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
public virtual string[] AttrDestinationNetworkInterfaceArns { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: DestinationNetworkInterfaceArns
AttrSourceNetworkInterfaceArns
The ARNs of the source ENIs that were created for your subnet.
public virtual string[] AttrSourceNetworkInterfaceArns { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: SourceNetworkInterfaceArns
AttrStatus
The status of the task that was described.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
AttrTaskArn
The ARN of the task.
public virtual string AttrTaskArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: TaskArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CloudWatchLogGroupArn
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
public virtual string CloudWatchLogGroupArn { get; set; }
Property Value
System.String
DestinationLocationArn
The Amazon Resource Name (ARN) of an AWS storage resource's location.
public virtual string DestinationLocationArn { get; set; }
Property Value
System.String
Excludes
Specifies a list of filter rules that exclude specific data during your transfer.
public virtual object Excludes { get; set; }
Property Value
System.Object
Includes
Specifies a list of filter rules that include specific data during your transfer.
public virtual object Includes { get; set; }
Property Value
System.Object
ManifestConfig
The configuration of the manifest that lists the files or objects to transfer.
public virtual object ManifestConfig { get; set; }
Property Value
System.Object
Name
The name of a task.
public virtual string Name { get; set; }
Property Value
System.String
Options
Specifies the configuration options for a task.
public virtual object Options { get; set; }
Property Value
System.Object
Remarks
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.
public virtual object Schedule { get; set; }
Property Value
System.Object
SourceLocationArn
The Amazon Resource Name (ARN) of the source location for the task.
public virtual string SourceLocationArn { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TaskReportConfig
Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.
public virtual object TaskReportConfig { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>