Interface CfnStateMachineProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnStateMachineProps.Jsii$Proxy
CfnStateMachine
.
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.stepfunctions.*; Object definition; CfnStateMachineProps cfnStateMachineProps = CfnStateMachineProps.builder() .roleArn("roleArn") // the properties below are optional .definition(definition) .definitionS3Location(S3LocationProperty.builder() .bucket("bucket") .key("key") // the properties below are optional .version("version") .build()) .definitionString("definitionString") .definitionSubstitutions(Map.of( "definitionSubstitutionsKey", "definitionSubstitutions")) .encryptionConfiguration(EncryptionConfigurationProperty.builder() .type("type") // the properties below are optional .kmsDataKeyReusePeriodSeconds(123) .kmsKeyId("kmsKeyId") .build()) .loggingConfiguration(LoggingConfigurationProperty.builder() .destinations(List.of(LogDestinationProperty.builder() .cloudWatchLogsLogGroup(CloudWatchLogsLogGroupProperty.builder() .logGroupArn("logGroupArn") .build()) .build())) .includeExecutionData(false) .level("level") .build()) .stateMachineName("stateMachineName") .stateMachineType("stateMachineType") .tags(List.of(TagsEntryProperty.builder() .key("key") .value("value") .build())) .tracingConfiguration(TracingConfigurationProperty.builder() .enabled(false) .build()) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnStateMachineProps
static final class
An implementation forCfnStateMachineProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnStateMachineProps.Builder
builder()
default Object
The Amazon States Language definition of the state machine.default Object
The name of the S3 bucket where the state machine definition is stored.default String
The Amazon States Language definition of the state machine.default Object
A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.default Object
Encryption configuration for the state machine.default Object
Defines what execution history events are logged and where they are logged.The Amazon Resource Name (ARN) of the IAM role to use for this state machine.default String
The name of the state machine.default String
Determines whether aSTANDARD
orEXPRESS
state machine is created.default List<CfnStateMachine.TagsEntryProperty>
getTags()
The list of tags to add to a resource.default Object
Selects whether or not the state machine's AWS X-Ray tracing is enabled.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getRoleArn
The Amazon Resource Name (ARN) of the IAM role to use for this state machine. -
getDefinition
The Amazon States Language definition of the state machine.The state machine definition must be in JSON or YAML, and the format of the object must match the format of your CloudFormation template file. See Amazon States Language .
-
getDefinitionS3Location
The name of the S3 bucket where the state machine definition is stored.The state machine definition must be a JSON or YAML file.
-
getDefinitionString
The Amazon States Language definition of the state machine.The state machine definition must be in JSON. See Amazon States Language .
-
getDefinitionSubstitutions
A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key-value map.
Substitutions must follow the syntax:
${key_name}
or${variable_1,variable_2,...}
. -
getEncryptionConfiguration
Encryption configuration for the state machine. -
getLoggingConfiguration
Defines what execution history events are logged and where they are logged.By default, the
level
is set toOFF
. For more information see Log Levels in the AWS Step Functions User Guide. -
getStateMachineName
The name of the state machine.A name must not contain:
- white space
- brackets
< > { } [ ]
- wildcard characters
? *
- special characters
" # % \ ^ | ~
$ & , ; : /` - control characters (
U+0000-001F
,U+007F-009F
)
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
-
getStateMachineType
Determines whether aSTANDARD
orEXPRESS
state machine is created.The default is
STANDARD
. You cannot update thetype
of a state machine once it has been created. For more information onSTANDARD
andEXPRESS
workflows, see Standard Versus Express Workflows in the AWS Step Functions Developer Guide. -
getTags
The list of tags to add to a resource.Tags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + -
-
getTracingConfiguration
Selects whether or not the state machine's AWS X-Ray tracing is enabled. -
builder
- Returns:
- a
CfnStateMachineProps.Builder
ofCfnStateMachineProps
-