Package software.amazon.awscdk.services.mwaaserverless

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.mwaaserverless.CfnWorkflow
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IWorkflowRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-03T13:58:26.826Z") @Stability(Stable) public class CfnWorkflow extends CfnResource implements IInspectable, IWorkflowRef, ITaggableV2
Resource Type definition for AWS::MWAAServerless::Workflow resource.

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.mwaaserverless.*;
 CfnWorkflow cfnWorkflow = CfnWorkflow.Builder.create(this, "MyCfnWorkflow")
         .definitionS3Location(S3LocationProperty.builder()
                 .bucket("bucket")
                 .objectKey("objectKey")
                 // the properties below are optional
                 .versionId("versionId")
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .description("description")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build())
         .loggingConfiguration(LoggingConfigurationProperty.builder()
                 .logGroupName("logGroupName")
                 .build())
         .name("name")
         .networkConfiguration(NetworkConfigurationProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .triggerMode("triggerMode")
         .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

    • CfnWorkflow

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

    • CfnWorkflow

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

    • CfnWorkflow

      @Stability(Stable) public CfnWorkflow(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWorkflowProps props)
      Create a new AWS::MWAAServerless::Workflow.

      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

    • arnForWorkflow

      @Stability(Stable) @NotNull public static String arnForWorkflow(@NotNull IWorkflowRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnWorkflow

      @Stability(Stable) @NotNull public static Boolean isCfnWorkflow(@NotNull Object x)
      Checks whether the given object is a CfnWorkflow.

      Parameters:
      x - This parameter is required.

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

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()

    • getAttrModifiedAt

      @Stability(Stable) @NotNull public String getAttrModifiedAt()

    • getAttrScheduleConfiguration

      @Stability(Stable) @NotNull public IResolvable getAttrScheduleConfiguration()

    • getAttrWorkflowArn

      @Stability(Stable) @NotNull public String getAttrWorkflowArn()

    • getAttrWorkflowStatus

      @Stability(Stable) @NotNull public String getAttrWorkflowStatus()

    • getAttrWorkflowVersion

      @Stability(Stable) @NotNull public String getAttrWorkflowVersion()

    • getCdkTagManager

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

    • getCfnProperties

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

    • getWorkflowRef

      @Stability(Stable) @NotNull public WorkflowReference getWorkflowRef()
      A reference to a Workflow resource.
      Specified by:
      getWorkflowRef in interface IWorkflowRef

    • getDefinitionS3Location

      @Stability(Stable) @NotNull public Object getDefinitionS3Location()
      Returns union: either IResolvable or CfnWorkflow.S3LocationProperty

    • setDefinitionS3Location

      @Stability(Stable) public void setDefinitionS3Location(@NotNull IResolvable value)

    • setDefinitionS3Location

      @Stability(Stable) public void setDefinitionS3Location(@NotNull CfnWorkflow.S3LocationProperty value)

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)

    • getDescription

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

    • setDescription

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

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getEncryptionConfiguration()
      Returns union: either IResolvable or CfnWorkflow.EncryptionConfigurationProperty

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable IResolvable value)

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnWorkflow.EncryptionConfigurationProperty value)

    • getLoggingConfiguration

      @Stability(Stable) @Nullable public Object getLoggingConfiguration()
      Returns union: either IResolvable or CfnWorkflow.LoggingConfigurationProperty

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@Nullable IResolvable value)

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@Nullable CfnWorkflow.LoggingConfigurationProperty value)

    • getName

      @Stability(Stable) @Nullable public String getName()

    • setName

      @Stability(Stable) public void setName(@Nullable String value)

    • getNetworkConfiguration

      @Stability(Stable) @Nullable public Object getNetworkConfiguration()
      Returns union: either IResolvable or CfnWorkflow.NetworkConfigurationProperty

    • setNetworkConfiguration

      @Stability(Stable) public void setNetworkConfiguration(@Nullable IResolvable value)

    • setNetworkConfiguration

      @Stability(Stable) public void setNetworkConfiguration(@Nullable CfnWorkflow.NetworkConfigurationProperty value)

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      A map of key-value pairs to be applied as tags.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      A map of key-value pairs to be applied as tags.

    • getTriggerMode

      @Stability(Stable) @Nullable public String getTriggerMode()

    • setTriggerMode

      @Stability(Stable) public void setTriggerMode(@Nullable String value)