Package software.amazon.awscdk.services.datasync

Class CfnTask

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.datasync.CfnTask
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-03-01T20:58:22.264Z") @Stability(Stable) public class CfnTask extends CfnResource implements IInspectable, ITaggable
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datasync.*;
 CfnTask cfnTask = CfnTask.Builder.create(this, "MyCfnTask")
         .destinationLocationArn("destinationLocationArn")
         .sourceLocationArn("sourceLocationArn")
         // the properties below are optional
         .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
         .excludes(List.of(FilterRuleProperty.builder()
                 .filterType("filterType")
                 .value("value")
                 .build()))
         .includes(List.of(FilterRuleProperty.builder()
                 .filterType("filterType")
                 .value("value")
                 .build()))
         .name("name")
         .options(OptionsProperty.builder()
                 .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")
                 .build())
         .schedule(TaskScheduleProperty.builder()
                 .scheduleExpression("scheduleExpression")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .taskReportConfig(TaskReportConfigProperty.builder()
                 .destination(DestinationProperty.builder()
                         .s3(S3Property.builder()
                                 .bucketAccessRoleArn("bucketAccessRoleArn")
                                 .s3BucketArn("s3BucketArn")
                                 .subdirectory("subdirectory")
                                 .build())
                         .build())
                 .outputType("outputType")
                 // the properties below are optional
                 .objectVersionIds("objectVersionIds")
                 .overrides(OverridesProperty.builder()
                         .deleted(DeletedProperty.builder()
                                 .reportLevel("reportLevel")
                                 .build())
                         .skipped(SkippedProperty.builder()
                                 .reportLevel("reportLevel")
                                 .build())
                         .transferred(TransferredProperty.builder()
                                 .reportLevel("reportLevel")
                                 .build())
                         .verified(VerifiedProperty.builder()
                                 .reportLevel("reportLevel")
                                 .build())
                         .build())
                 .reportLevel("reportLevel")
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTask

      protected CfnTask(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTask

      protected CfnTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTask

      @Stability(Stable) public CfnTask(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTaskProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDestinationNetworkInterfaceArns

      @Stability(Stable) @NotNull public List<String> getAttrDestinationNetworkInterfaceArns()
      The Amazon Resource Names (ARNs) of the destination ENIs (Elastic Network Interfaces) that were created for your subnet.

    • getAttrSourceNetworkInterfaceArns

      @Stability(Stable) @NotNull public List<String> getAttrSourceNetworkInterfaceArns()
      The Amazon Resource Names (ARNs) of the source ENIs (Elastic Network Interfaces) that were created for your subnet.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the task that was described.

    • getAttrTaskArn

      @Stability(Stable) @NotNull public String getAttrTaskArn()
      The ARN of the task.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDestinationLocationArn

      @Stability(Stable) @NotNull public String getDestinationLocationArn()
      The Amazon Resource Name (ARN) of an AWS storage resource's location.

    • setDestinationLocationArn

      @Stability(Stable) public void setDestinationLocationArn(@NotNull String value)
      The Amazon Resource Name (ARN) of an AWS storage resource's location.

    • getSourceLocationArn

      @Stability(Stable) @NotNull public String getSourceLocationArn()
      The Amazon Resource Name (ARN) of the source location for the task.

    • setSourceLocationArn

      @Stability(Stable) public void setSourceLocationArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the source location for the task.

    • getCloudWatchLogGroupArn

      @Stability(Stable) @Nullable public String getCloudWatchLogGroupArn()
      The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

    • setCloudWatchLogGroupArn

      @Stability(Stable) public void setCloudWatchLogGroupArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

    • getExcludes

      @Stability(Stable) @Nullable public Object getExcludes()
      Specifies a list of filter rules that exclude specific data during your transfer.

    • setExcludes

      @Stability(Stable) public void setExcludes(@Nullable IResolvable value)
      Specifies a list of filter rules that exclude specific data during your transfer.

    • setExcludes

      @Stability(Stable) public void setExcludes(@Nullable List<Object> value)
      Specifies a list of filter rules that exclude specific data during your transfer.

    • getIncludes

      @Stability(Stable) @Nullable public Object getIncludes()
      Specifies a list of filter rules that include specific data during your transfer.

    • setIncludes

      @Stability(Stable) public void setIncludes(@Nullable IResolvable value)
      Specifies a list of filter rules that include specific data during your transfer.

    • setIncludes

      @Stability(Stable) public void setIncludes(@Nullable List<Object> value)
      Specifies a list of filter rules that include specific data during your transfer.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of a task.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of a task.

    • getOptions

      @Stability(Stable) @Nullable public Object getOptions()
      Specifies the configuration options for a task.

      Some options include preserving file or object metadata and verifying data integrity.

    • setOptions

      @Stability(Stable) public void setOptions(@Nullable IResolvable value)
      Specifies the configuration options for a task.

      Some options include preserving file or object metadata and verifying data integrity.

    • setOptions

      @Stability(Stable) public void setOptions(@Nullable CfnTask.OptionsProperty value)
      Specifies the configuration options for a task.

      Some options include preserving file or object metadata and verifying data integrity.

    • getSchedule

      @Stability(Stable) @Nullable public Object getSchedule()
      Specifies a schedule used to periodically transfer files from a source to a destination location.

    • setSchedule

      @Stability(Stable) public void setSchedule(@Nullable IResolvable value)
      Specifies a schedule used to periodically transfer files from a source to a destination location.

    • setSchedule

      @Stability(Stable) public void setSchedule(@Nullable CfnTask.TaskScheduleProperty value)
      Specifies a schedule used to periodically transfer files from a source to a destination location.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

    • getTaskReportConfig

      @Stability(Stable) @Nullable public Object getTaskReportConfig()
      Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

    • setTaskReportConfig

      @Stability(Stable) public void setTaskReportConfig(@Nullable IResolvable value)
      Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

    • setTaskReportConfig

      @Stability(Stable) public void setTaskReportConfig(@Nullable CfnTask.TaskReportConfigProperty value)
      Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.