software.amazon.awscdk.services.transfer

Class CfnWorkflow

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.transfer.CfnWorkflow

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.614Z")
 @Stability(value=Stable)
public class CfnWorkflow
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Transfer::Workflow`.

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

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.transfer.*;
 Object copyStepDetails;
 Object customStepDetails;
 Object deleteStepDetails;
 Object tagStepDetails;
 CfnWorkflow cfnWorkflow = CfnWorkflow.Builder.create(this, "MyCfnWorkflow")
         .steps(List.of(WorkflowStepProperty.builder()
                 .copyStepDetails(copyStepDetails)
                 .customStepDetails(customStepDetails)
                 .deleteStepDetails(deleteStepDetails)
                 .tagStepDetails(tagStepDetails)
                 .type("type")
                 .build()))
         // the properties below are optional
         .description("description")
         .onExceptionSteps(List.of(WorkflowStepProperty.builder()
                 .copyStepDetails(copyStepDetails)
                 .customStepDetails(customStepDetails)
                 .deleteStepDetails(deleteStepDetails)
                 .tagStepDetails(tagStepDetails)
                 .type("type")
                 .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	CfnWorkflow.Builder A fluent builder for CfnWorkflow.
static interface	CfnWorkflow.WorkflowStepProperty The basic building block of a workflow.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWorkflow(software.constructs.Construct scope, String id, CfnWorkflowProps props) Create a new `AWS::Transfer::Workflow`.
protected	CfnWorkflow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkflow(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrWorkflowId() A unique identifier for a workflow.
protected Map<String,Object>	getCfnProperties()
String	getDescription() Specifies the text description for the workflow.
Object	getOnExceptionSteps() Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
Object	getSteps() Specifies the details for the steps that are in the specified workflow.
TagManager	getTags() Key-value pairs that can be used to group and search for workflows.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) Specifies the text description for the workflow.
void	setOnExceptionSteps(IResolvable value) Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
void	setOnExceptionSteps(List<Object> value) Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
void	setSteps(IResolvable value) Specifies the details for the steps that are in the specified workflow.
void	setSteps(List<Object> value) Specifies the details for the steps that are in the specified workflow.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnWorkflow

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

CfnWorkflow

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

CfnWorkflow

@Stability(value=Stable)
public CfnWorkflow(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnWorkflowProps props)

Create a new `AWS::Transfer::Workflow`.

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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrWorkflowId

@Stability(value=Stable)
 @NotNull
public String getAttrWorkflowId()

A unique identifier for a workflow.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Key-value pairs that can be used to group and search for workflows.

Tags are metadata attached to workflows for any purpose.

getSteps

@Stability(value=Stable)
 @NotNull
public Object getSteps()

Specifies the details for the steps that are in the specified workflow.

setSteps

@Stability(value=Stable)
public void setSteps(@NotNull
                                              IResolvable value)

Specifies the details for the steps that are in the specified workflow.

setSteps

@Stability(value=Stable)
public void setSteps(@NotNull
                                              List<Object> value)

Specifies the details for the steps that are in the specified workflow.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

Specifies the text description for the workflow.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

Specifies the text description for the workflow.

getOnExceptionSteps

@Stability(value=Stable)
 @Nullable
public Object getOnExceptionSteps()

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

setOnExceptionSteps

@Stability(value=Stable)
public void setOnExceptionSteps(@Nullable
                                                         IResolvable value)

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

setOnExceptionSteps

@Stability(value=Stable)
public void setOnExceptionSteps(@Nullable
                                                         List<Object> value)

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.