Class CfnTask

A CloudFormation AWS::DataSync::Task.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnTask

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.AWS.DataSync.dll

Syntax (csharp)

public class CfnTask : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnTask
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

Remarks

The AWS::DataSync::Task resource specifies a task. 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.

CloudformationResource: AWS::DataSync::Task

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;

CfnTask 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"
    } },
    Name = "name",
    Options = new OptionsProperty {
        Atime = "atime",
        BytesPerSecond = 123,
        Gid = "gid",
        LogLevel = "logLevel",
        Mtime = "mtime",
        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

CfnTask(Construct, String, ICfnTaskProps)	Create a new `AWS::DataSync::Task`.
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

Properties

AttrDestinationNetworkInterfaceArns	The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
AttrErrorCode	Errors encountered during task execution.
AttrErrorDetail	Detailed description of an error that was encountered during the task execution.
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	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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnTask(Construct, String, ICfnTaskProps)

Create a new AWS::DataSync::Task.

public CfnTask(Construct scope, string id, ICfnTaskProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnTaskProps

resource properties.

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

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

AttrErrorCode

Errors encountered during task execution.

public virtual string AttrErrorCode { get; }

Property Value

System.String

Remarks

Troubleshoot issues with this error code.

CloudformationAttribute: ErrorCode

AttrErrorDetail

Detailed description of an error that was encountered during the task execution.

public virtual string AttrErrorDetail { get; }

Property Value

System.String

Remarks

You can use this information to help troubleshoot issues.

CloudformationAttribute: ErrorDetail

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

CfnResource.CfnProperties

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

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 virtual 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

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

public virtual object Excludes { get; set; }

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.

public virtual object Includes { get; set; }

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.

public virtual 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

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

public virtual object Options { get; set; }

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.

public virtual 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 virtual 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

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable