software.amazon.awscdk.services.stepfunctions

Class CfnStateMachine

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.stepfunctions.CfnStateMachine

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.5.0 (build 46538f8)",
           date="2020-05-15T23:35:58.907Z")
 @Stability(value=External)
public class CfnStateMachine
extends CfnResource
implements IInspectable

A CloudFormation `AWS::StepFunctions::StateMachine`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStateMachine.Builder A fluent builder for CfnStateMachine.
static interface	CfnStateMachine.CloudWatchLogsLogGroupProperty
static interface	CfnStateMachine.LogDestinationProperty
static interface	CfnStateMachine.LoggingConfigurationProperty
static interface	CfnStateMachine.TagsEntryProperty

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Proxy

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
	CfnStateMachine(Construct scope, String id, CfnStateMachineProps props) Create a new `AWS::StepFunctions::StateMachine`.
protected	CfnStateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStateMachine(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static CfnStateMachine	fromCloudFormation(Construct scope, String id, Object resourceAttributes) A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource.
String	getAttrName()
protected Map<String,Object>	getCfnProperties()
String	getDefinitionString() `AWS::StepFunctions::StateMachine.DefinitionString`.
Object	getLoggingConfiguration() `AWS::StepFunctions::StateMachine.LoggingConfiguration`.
String	getRoleArn() `AWS::StepFunctions::StateMachine.RoleArn`.
String	getStateMachineName() `AWS::StepFunctions::StateMachine.StateMachineName`.
String	getStateMachineType() `AWS::StepFunctions::StateMachine.StateMachineType`.
TagManager	getTags() `AWS::StepFunctions::StateMachine.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDefinitionString(String value) `AWS::StepFunctions::StateMachine.DefinitionString`.
void	setLoggingConfiguration(CfnStateMachine.LoggingConfigurationProperty value) `AWS::StepFunctions::StateMachine.LoggingConfiguration`.
void	setLoggingConfiguration(IResolvable value) `AWS::StepFunctions::StateMachine.LoggingConfiguration`.
void	setRoleArn(String value) `AWS::StepFunctions::StateMachine.RoleArn`.
void	setStateMachineName(String value) `AWS::StepFunctions::StateMachine.StateMachineName`.
void	setStateMachineType(String value) `AWS::StepFunctions::StateMachine.StateMachineType`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getUpdatedProperites, isCfnResource, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, 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=External)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStateMachine

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

CfnStateMachine

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

CfnStateMachine

@Stability(value=External)
public CfnStateMachine(@NotNull
                                                  Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnStateMachineProps props)

Create a new `AWS::StepFunctions::StateMachine`.

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

fromCloudFormation

@Stability(value=Experimental)
 @NotNull
public static CfnStateMachine fromCloudFormation(@NotNull
                                                                                          Construct scope,
                                                                                          @NotNull
                                                                                          String id,
                                                                                          @NotNull
                                                                                          Object resourceAttributes)

A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource.

Used in the @aws-cdk/cloudformation-include module.

EXPERIMENTAL

Parameters:

scope - This parameter is required.

id - This parameter is required.

resourceAttributes - This parameter is required.

inspect

@Stability(value=Experimental)
public void inspect(@NotNull
                                                   TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

EXPERIMENTAL

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=External)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                   Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrName

@Stability(value=External)
 @NotNull
public String getAttrName()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

`AWS::StepFunctions::StateMachine.Tags`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags

getDefinitionString

@Stability(value=External)
 @NotNull
public String getDefinitionString()

`AWS::StepFunctions::StateMachine.DefinitionString`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionstring

setDefinitionString

@Stability(value=External)
public void setDefinitionString(@NotNull
                                                           String value)

`AWS::StepFunctions::StateMachine.DefinitionString`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionstring

getRoleArn

@Stability(value=External)
 @NotNull
public String getRoleArn()

`AWS::StepFunctions::StateMachine.RoleArn`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn

setRoleArn

@Stability(value=External)
public void setRoleArn(@NotNull
                                                  String value)

`AWS::StepFunctions::StateMachine.RoleArn`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn

getLoggingConfiguration

@Stability(value=External)
 @Nullable
public Object getLoggingConfiguration()

`AWS::StepFunctions::StateMachine.LoggingConfiguration`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration

setLoggingConfiguration

@Stability(value=External)
public void setLoggingConfiguration(@Nullable
                                                               CfnStateMachine.LoggingConfigurationProperty value)

`AWS::StepFunctions::StateMachine.LoggingConfiguration`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration

setLoggingConfiguration

@Stability(value=External)
public void setLoggingConfiguration(@Nullable
                                                               IResolvable value)

`AWS::StepFunctions::StateMachine.LoggingConfiguration`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration

getStateMachineName

@Stability(value=External)
 @Nullable
public String getStateMachineName()

`AWS::StepFunctions::StateMachine.StateMachineName`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename

setStateMachineName

@Stability(value=External)
public void setStateMachineName(@Nullable
                                                           String value)

`AWS::StepFunctions::StateMachine.StateMachineName`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename

getStateMachineType

@Stability(value=External)
 @Nullable
public String getStateMachineType()

`AWS::StepFunctions::StateMachine.StateMachineType`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype

setStateMachineType

@Stability(value=External)
public void setStateMachineType(@Nullable
                                                           String value)

`AWS::StepFunctions::StateMachine.StateMachineType`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype