software.amazon.awscdk.services.glue

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.glue.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:39.595Z")
 @Stability(value=Stable)
public class CfnWorkflow
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Glue::Workflow`.

The AWS::Glue::Workflow is an AWS Glue resource type that manages AWS Glue workflows. A workflow is a container for a set of related jobs, crawlers, and triggers in AWS Glue . Using a workflow, you can design a complex multi-job extract, transform, and load (ETL) activity that AWS Glue can execute and track as single entity.

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.glue.*;
 Object defaultRunProperties;
 Object tags;
 CfnWorkflow cfnWorkflow = CfnWorkflow.Builder.create(this, "MyCfnWorkflow")
         .defaultRunProperties(defaultRunProperties)
         .description("description")
         .name("name")
         .tags(tags)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnWorkflow.Builder A fluent builder for CfnWorkflow.

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) Create a new `AWS::Glue::Workflow`.
	CfnWorkflow(software.constructs.Construct scope, String id, CfnWorkflowProps props) Create a new `AWS::Glue::Workflow`.
protected	CfnWorkflow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkflow(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getDefaultRunProperties() A collection of properties to be used as part of each execution of the workflow.
String	getDescription() A description of the workflow.
String	getName() The name of the workflow representing the flow.
TagManager	getTags() The tags to use with this workflow.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDefaultRunProperties(Object value) A collection of properties to be used as part of each execution of the workflow.
void	setDescription(String value) A description of the workflow.
void	setName(String value) The name of the workflow representing the flow.

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,
                                            @Nullable
                                            CfnWorkflowProps props)

Create a new `AWS::Glue::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.

CfnWorkflow

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

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

Parameters:

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

id - - scoped id of the resource. 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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

The tags to use with this workflow.

getDefaultRunProperties

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

A collection of properties to be used as part of each execution of the workflow.

setDefaultRunProperties

@Stability(value=Stable)
public void setDefaultRunProperties(@NotNull
                                                             Object value)

A collection of properties to be used as part of each execution of the workflow.

getDescription

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

A description of the workflow.

setDescription

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

A description of the workflow.

getName

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

The name of the workflow representing the flow.

setName

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

The name of the workflow representing the flow.