Package com.pulumi.aws.transfer

Class Workflow

  • public class Workflow
extends com.pulumi.resources.CustomResource
    Provides a AWS Transfer Workflow resource. ## Example Usage ### Basic single step example 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.transfer.Workflow;
 import com.pulumi.aws.transfer.WorkflowArgs;
 import com.pulumi.aws.transfer.inputs.WorkflowStepArgs;
 import com.pulumi.aws.transfer.inputs.WorkflowStepDeleteStepDetailsArgs;
 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 Workflow("example", WorkflowArgs.builder()
             .steps(WorkflowStepArgs.builder()
                 .deleteStepDetails(WorkflowStepDeleteStepDetailsArgs.builder()
                     .name("example")
                     .sourceFileLocation("${original.file}")
                     .build())
                 .type("DELETE")
                 .build())
             .build());
 
     }
 }
    ### Multistep example 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.transfer.Workflow;
 import com.pulumi.aws.transfer.WorkflowArgs;
 import com.pulumi.aws.transfer.inputs.WorkflowStepArgs;
 import com.pulumi.aws.transfer.inputs.WorkflowStepCustomStepDetailsArgs;
 import com.pulumi.aws.transfer.inputs.WorkflowStepTagStepDetailsArgs;
 import com.pulumi.aws.transfer.inputs.WorkflowStepTagStepDetailsTagArgs;
 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 Workflow("example", WorkflowArgs.builder()
             .steps(            
                 WorkflowStepArgs.builder()
                     .customStepDetails(WorkflowStepCustomStepDetailsArgs.builder()
                         .name("example")
                         .sourceFileLocation("${original.file}")
                         .target(exampleAwsLambdaFunction.arn())
                         .timeoutSeconds(60)
                         .build())
                     .type("CUSTOM")
                     .build(),
                 WorkflowStepArgs.builder()
                     .tagStepDetails(WorkflowStepTagStepDetailsArgs.builder()
                         .tags(WorkflowStepTagStepDetailsTagArgs.builder()
                             .key("Name")
                             .value("Hello World")
                             .build())
                         .name("example")
                         .sourceFileLocation("${original.file}")
                         .build())
                     .type("TAG")
                     .build())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Transfer Workflows using the `worflowId`. For example: ```sh $ pulumi import aws:transfer/workflow:Workflow example example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Workflow​(java.lang.String name)  
      Workflow​(java.lang.String name, WorkflowArgs args)  
      Workflow​(java.lang.String name, WorkflowArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • 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>> description()  
      static Workflow get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, WorkflowState 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<java.util.List<WorkflowOnExceptionStep>>> onExceptionSteps()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<WorkflowStep>> steps()  
      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()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Workflow

        public Workflow​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Workflow

        public Workflow​(java.lang.String name,
                WorkflowArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Workflow

        public Workflow​(java.lang.String name,
                WorkflowArgs 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:
        Workflow ARN.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Textual description for the workflow.

      • onExceptionSteps

        public com.pulumi.core.Output<java.util.Optional<java.util.List<WorkflowOnExceptionStep>>> onExceptionSteps()
        Returns:
        Steps (actions) to take if errors are encountered during execution of the workflow. See `onExceptionSteps` Block below.

      • 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.

      • steps

        public com.pulumi.core.Output<java.util.List<WorkflowStep>> steps()
        Returns:
        Details for the steps that are in the specified workflow. See `steps` Block below.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. 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:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Workflow get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           WorkflowState 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.