Package com.pulumi.aws.datasync
Class Task
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.datasync.Task
-
public class Task extends com.pulumi.resources.CustomResourceManages an AWS DataSync Task, which represents a configuration for synchronization. Starting an execution of these DataSync Tasks (actually synchronizing files) is performed outside of this resource. ## Example Usage
### Example Usage with Schedulingpackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.datasync.Task; import com.pulumi.aws.datasync.TaskArgs; import com.pulumi.aws.datasync.inputs.TaskOptionsArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Task("example", TaskArgs.builder() .options(TaskOptionsArgs.builder() .bytesPerSecond(-1) .build()) .destinationLocationArn(destination.arn()) .name("example") .sourceLocationArn(source.arn()) .build()); } }
### Example Usage with Filteringpackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.datasync.Task; import com.pulumi.aws.datasync.TaskArgs; import com.pulumi.aws.datasync.inputs.TaskScheduleArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Task("example", TaskArgs.builder() .schedule(TaskScheduleArgs.builder() .scheduleExpression("cron(0 12 ? * SUN,WED *)") .build()) .destinationLocationArn(destination.arn()) .name("example") .sourceLocationArn(source.arn()) .build()); } }
### Example Usage with Enhanced Task Modepackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.datasync.Task; import com.pulumi.aws.datasync.TaskArgs; import com.pulumi.aws.datasync.inputs.TaskExcludesArgs; import com.pulumi.aws.datasync.inputs.TaskIncludesArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Task("example", TaskArgs.builder() .excludes(TaskExcludesArgs.builder() .filterType("SIMPLE_PATTERN") .value("/folder1|/folder2") .build()) .includes(TaskIncludesArgs.builder() .filterType("SIMPLE_PATTERN") .value("/folder1|/folder2") .build()) .destinationLocationArn(destination.arn()) .name("example") .sourceLocationArn(source.arn()) .build()); } }
## Import ### Identity Schema #### Required - `arn` (String) ARN of the DataSync task. Using `pulumi import`, import `aws.datasync.Task` using the DataSync Task ARN. For example: ```sh $ pulumi import aws:datasync/task:Task example arn:aws:datasync:us-east-1:123456789012:task/task-12345678901234567 ```package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.datasync.Task; import com.pulumi.aws.datasync.TaskArgs; import com.pulumi.aws.datasync.inputs.TaskOptionsArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Task("example", TaskArgs.builder() .options(TaskOptionsArgs.builder() .gid("NONE") .posixPermissions("NONE") .uid("NONE") .verifyMode("ONLY_FILES_TRANSFERRED") .build()) .destinationLocationArn(destination.arn()) .name("example") .sourceLocationArn(source.arn()) .taskMode("ENHANCED") .build()); } }
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.lang.String>arn()com.pulumi.core.Output<java.util.Optional<java.lang.String>>cloudwatchLogGroupArn()com.pulumi.core.Output<java.lang.String>destinationLocationArn()com.pulumi.core.Output<java.util.Optional<TaskExcludes>>excludes()static Taskget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TaskState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.util.Optional<TaskIncludes>>includes()com.pulumi.core.Output<java.lang.String>name()com.pulumi.core.Output<java.util.Optional<TaskOptions>>options()com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.util.Optional<TaskSchedule>>schedule()com.pulumi.core.Output<java.lang.String>sourceLocationArn()com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>tags()com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>tagsAll()com.pulumi.core.Output<java.lang.String>taskMode()com.pulumi.core.Output<java.util.Optional<TaskTaskReportConfig>>taskReportConfig()
-
-
-
Constructor Detail
-
Task
public Task(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
Task
public Task(java.lang.String name, TaskArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
Task
public Task(java.lang.String name, TaskArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- ARN of the DataSync Task.
-
cloudwatchLogGroupArn
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> cloudwatchLogGroupArn()
- Returns:
- ARN of the CloudWatch Log Group that is used to monitor and log events in the sync task.
-
destinationLocationArn
public com.pulumi.core.Output<java.lang.String> destinationLocationArn()
- Returns:
- ARN of destination DataSync Location.
-
excludes
public com.pulumi.core.Output<java.util.Optional<TaskExcludes>> excludes()
- Returns:
- Filter rules that determines which files to exclude from a task.
-
includes
public com.pulumi.core.Output<java.util.Optional<TaskIncludes>> includes()
- Returns:
- Filter rules that determines which files to include in a task.
-
name
public com.pulumi.core.Output<java.lang.String> name()
- Returns:
- Name of the DataSync Task.
-
options
public com.pulumi.core.Output<java.util.Optional<TaskOptions>> options()
- Returns:
- Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
schedule
public com.pulumi.core.Output<java.util.Optional<TaskSchedule>> schedule()
- Returns:
- Specifies a schedule used to periodically transfer files from a source to a destination location.
-
sourceLocationArn
public com.pulumi.core.Output<java.lang.String> sourceLocationArn()
- Returns:
- ARN of source DataSync Location.
-
tags
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
taskMode
public com.pulumi.core.Output<java.lang.String> taskMode()
- Returns:
- One of the following task modes for your data transfer: * `BASIC` (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage. * `ENHANCED` - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
-
taskReportConfig
public com.pulumi.core.Output<java.util.Optional<TaskTaskReportConfig>> taskReportConfig()
- Returns:
- Configuration block containing the configuration of a DataSync Task Report. See `taskReportConfig` below.
-
get
public static Task get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable TaskState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-