software.amazon.awscdk.services.datasync

Class CfnTask

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.datasync.CfnTask

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.776Z")
public class CfnTask
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DataSync::Task`.

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()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTask.Builder A fluent builder for CfnTask.
static interface	CfnTask.FilterRuleProperty Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
static interface	CfnTask.OptionsProperty Represents the options that are available to control the behavior of a [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) operation.
static interface	CfnTask.TaskScheduleProperty Specifies the schedule you want your task to use for repeated executions.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTask(Construct scope, java.lang.String id, CfnTaskProps props) Create a new `AWS::DataSync::Task`.
protected	CfnTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTask(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAttrDestinationNetworkInterfaceArns() The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
java.util.List<java.lang.String>	getAttrSourceNetworkInterfaceArns() The ARNs of the source ENIs that were created for your subnet.
java.lang.String	getAttrStatus() The status of the task that was described.
java.lang.String	getAttrTaskArn() The ARN of the task.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getCloudWatchLogGroupArn() The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
java.lang.String	getDestinationLocationArn() The Amazon Resource Name (ARN) of an AWS storage resource's location.
java.lang.Object	getExcludes() Specifies a list of filter rules that exclude specific data during your transfer.
java.lang.Object	getIncludes() Specifies a list of filter rules that include specific data during your transfer.
java.lang.String	getName() The name of a task.
java.lang.Object	getOptions() Specifies the configuration options for a task.
java.lang.Object	getSchedule() Specifies a schedule used to periodically transfer files from a source to a destination location.
java.lang.String	getSourceLocationArn() The Amazon Resource Name (ARN) of the source location for the task.
TagManager	getTags() Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCloudWatchLogGroupArn(java.lang.String value) The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
void	setDestinationLocationArn(java.lang.String value) The Amazon Resource Name (ARN) of an AWS storage resource's location.
void	setExcludes(IResolvable value) Specifies a list of filter rules that exclude specific data during your transfer.
void	setExcludes(java.util.List<java.lang.Object> value) Specifies a list of filter rules that exclude specific data during your transfer.
void	setIncludes(IResolvable value) Specifies a list of filter rules that include specific data during your transfer.
void	setIncludes(java.util.List<java.lang.Object> value) Specifies a list of filter rules that include specific data during your transfer.
void	setName(java.lang.String value) The name of a task.
void	setOptions(CfnTask.OptionsProperty value) Specifies the configuration options for a task.
void	setOptions(IResolvable value) Specifies the configuration options for a task.
void	setSchedule(CfnTask.TaskScheduleProperty value) Specifies a schedule used to periodically transfer files from a source to a destination location.
void	setSchedule(IResolvable value) Specifies a schedule used to periodically transfer files from a source to a destination location.
void	setSourceLocationArn(java.lang.String value) The Amazon Resource Name (ARN) of the source location for the task.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTask

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

CfnTask

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

CfnTask

public CfnTask(Construct scope,
               java.lang.String id,
               CfnTaskProps props)

Create a new `AWS::DataSync::Task`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDestinationNetworkInterfaceArns

public java.util.List<java.lang.String> getAttrDestinationNetworkInterfaceArns()

The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.

getAttrSourceNetworkInterfaceArns

public java.util.List<java.lang.String> getAttrSourceNetworkInterfaceArns()

The ARNs of the source ENIs that were created for your subnet.

getAttrStatus

public java.lang.String getAttrStatus()

The status of the task that was described.

getAttrTaskArn

public java.lang.String getAttrTaskArn()

The ARN of the task.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

getDestinationLocationArn

public java.lang.String getDestinationLocationArn()

The Amazon Resource Name (ARN) of an AWS storage resource's location.

setDestinationLocationArn

public void setDestinationLocationArn(java.lang.String value)

The Amazon Resource Name (ARN) of an AWS storage resource's location.

getSourceLocationArn

public java.lang.String getSourceLocationArn()

The Amazon Resource Name (ARN) of the source location for the task.

setSourceLocationArn

public void setSourceLocationArn(java.lang.String value)

The Amazon Resource Name (ARN) of the source location for the task.

getCloudWatchLogGroupArn

public java.lang.String getCloudWatchLogGroupArn()

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

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 .

setCloudWatchLogGroupArn

public void setCloudWatchLogGroupArn(java.lang.String value)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

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 .

getExcludes

public java.lang.Object getExcludes()

Specifies a list of filter rules that exclude specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

setExcludes

public void setExcludes(IResolvable value)

Specifies a list of filter rules that exclude specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

setExcludes

public void setExcludes(java.util.List<java.lang.Object> value)

Specifies a list of filter rules that exclude specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

getIncludes

public java.lang.Object getIncludes()

Specifies a list of filter rules that include specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

setIncludes

public void setIncludes(IResolvable value)

Specifies a list of filter rules that include specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

setIncludes

public void setIncludes(java.util.List<java.lang.Object> value)

Specifies a list of filter rules that include specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

getName

public java.lang.String getName()

The name of a task.

This value is a text reference that is used to identify the task in the console.

setName

public void setName(java.lang.String value)

The name of a task.

This value is a text reference that is used to identify the task in the console.

getOptions

public java.lang.Object getOptions()

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

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 .

setOptions

public void setOptions(IResolvable value)

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

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 .

setOptions

public void setOptions(CfnTask.OptionsProperty value)

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

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 .

getSchedule

public java.lang.Object getSchedule()

Specifies a schedule used to periodically transfer files from a source to a destination location.

The schedule should be specified in UTC time. For more information, see Scheduling your task .

setSchedule

public void setSchedule(IResolvable value)

Specifies a schedule used to periodically transfer files from a source to a destination location.

The schedule should be specified in UTC time. For more information, see Scheduling your task .

setSchedule

public void setSchedule(CfnTask.TaskScheduleProperty value)

Specifies a schedule used to periodically transfer files from a source to a destination location.

The schedule should be specified in UTC time. For more information, see Scheduling your task .