software.amazon.awscdk.services.iotthingsgraph

Class CfnFlowTemplate

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.iotthingsgraph.CfnFlowTemplate

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

A CloudFormation `AWS::IoTThingsGraph::FlowTemplate`.

Represents a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

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.iotthingsgraph.*;
 CfnFlowTemplate cfnFlowTemplate = CfnFlowTemplate.Builder.create(this, "MyCfnFlowTemplate")
         .definition(DefinitionDocumentProperty.builder()
                 .language("language")
                 .text("text")
                 .build())
         // the properties below are optional
         .compatibleNamespaceVersion(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFlowTemplate.Builder A fluent builder for CfnFlowTemplate.
static interface	CfnFlowTemplate.DefinitionDocumentProperty A document that defines an entity.

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

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Number	getCompatibleNamespaceVersion() The version of the user's namespace against which the workflow was validated.
Object	getDefinition() A workflow's definition document.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCompatibleNamespaceVersion(Number value) The version of the user's namespace against which the workflow was validated.
void	setDefinition(CfnFlowTemplate.DefinitionDocumentProperty value) A workflow's definition document.
void	setDefinition(IResolvable value) A workflow's definition document.

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

CfnFlowTemplate

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

CfnFlowTemplate

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

CfnFlowTemplate

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

Create a new `AWS::IoTThingsGraph::FlowTemplate`.

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDefinition

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

A workflow's definition document.

setDefinition

@Stability(value=Stable)
public void setDefinition(@NotNull
                                                   CfnFlowTemplate.DefinitionDocumentProperty value)

A workflow's definition document.

setDefinition

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

A workflow's definition document.

getCompatibleNamespaceVersion

@Stability(value=Stable)
 @Nullable
public Number getCompatibleNamespaceVersion()

The version of the user's namespace against which the workflow was validated.

Use this value in your system instance.

setCompatibleNamespaceVersion

@Stability(value=Stable)
public void setCompatibleNamespaceVersion(@Nullable
                                                                   Number value)

The version of the user's namespace against which the workflow was validated.

Use this value in your system instance.