CfnStateMachineProps Struct
Properties for defining a CfnStateMachine.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';
declare const definition: any;
const cfnStateMachineProps: sam.CfnStateMachineProps = {
definition: definition,
definitionSubstitutions: {
definitionSubstitutionsKey: 'definitionSubstitutions',
},
definitionUri: 'definitionUri',
events: {
eventsKey: {
properties: {
method: 'method',
path: 'path',
// the properties below are optional
restApiId: 'restApiId',
},
type: 'type',
},
},
logging: {
destinations: [{
cloudWatchLogsLogGroup: {
logGroupArn: 'logGroupArn',
},
}],
includeExecutionData: false,
level: 'level',
},
name: 'name',
permissionsBoundaries: 'permissionsBoundaries',
policies: 'policies',
role: 'role',
tags: {
tagsKey: 'tags',
},
tracing: {
enabled: false,
},
type: 'type',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam
# definition: Any
cfn_state_machine_props = sam.CfnStateMachineProps(
definition=definition,
definition_substitutions={
"definition_substitutions_key": "definitionSubstitutions"
},
definition_uri="definitionUri",
events={
"events_key": sam.CfnStateMachine.EventSourceProperty(
properties=sam.CfnStateMachine.ApiEventProperty(
method="method",
path="path",
# the properties below are optional
rest_api_id="restApiId"
),
type="type"
)
},
logging=sam.CfnStateMachine.LoggingConfigurationProperty(
destinations=[sam.CfnStateMachine.LogDestinationProperty(
cloud_watch_logs_log_group=sam.CfnStateMachine.CloudWatchLogsLogGroupProperty(
log_group_arn="logGroupArn"
)
)],
include_execution_data=False,
level="level"
),
name="name",
permissions_boundaries="permissionsBoundaries",
policies="policies",
role="role",
tags={
"tags_key": "tags"
},
tracing=sam.CfnStateMachine.TracingConfigurationProperty(
enabled=False
),
type="type"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sam.*;
Object definition;
CfnStateMachineProps cfnStateMachineProps = CfnStateMachineProps.builder()
.definition(definition)
.definitionSubstitutions(Map.of(
"definitionSubstitutionsKey", "definitionSubstitutions"))
.definitionUri("definitionUri")
.events(Map.of(
"eventsKey", EventSourceProperty.builder()
.properties(ApiEventProperty.builder()
.method("method")
.path("path")
// the properties below are optional
.restApiId("restApiId")
.build())
.type("type")
.build()))
.logging(LoggingConfigurationProperty.builder()
.destinations(List.of(LogDestinationProperty.builder()
.cloudWatchLogsLogGroup(CloudWatchLogsLogGroupProperty.builder()
.logGroupArn("logGroupArn")
.build())
.build()))
.includeExecutionData(false)
.level("level")
.build())
.name("name")
.permissionsBoundaries("permissionsBoundaries")
.policies("policies")
.role("role")
.tags(Map.of(
"tagsKey", "tags"))
.tracing(TracingConfigurationProperty.builder()
.enabled(false)
.build())
.type("type")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SAM;
var definition;
var cfnStateMachineProps = new CfnStateMachineProps {
Definition = definition,
DefinitionSubstitutions = new Dictionary<string, string> {
{ "definitionSubstitutionsKey", "definitionSubstitutions" }
},
DefinitionUri = "definitionUri",
Events = new Dictionary<string, object> {
{ "eventsKey", new EventSourceProperty {
Properties = new ApiEventProperty {
Method = "method",
Path = "path",
// the properties below are optional
RestApiId = "restApiId"
},
Type = "type"
} }
},
Logging = new LoggingConfigurationProperty {
Destinations = new [] { new LogDestinationProperty {
CloudWatchLogsLogGroup = new CloudWatchLogsLogGroupProperty {
LogGroupArn = "logGroupArn"
}
} },
IncludeExecutionData = false,
Level = "level"
},
Name = "name",
PermissionsBoundaries = "permissionsBoundaries",
Policies = "policies",
Role = "role",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
Tracing = new TracingConfigurationProperty {
Enabled = false
},
Type = "type"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var definition interface{}
cfnStateMachineProps := &CfnStateMachineProps{
Definition: definition,
DefinitionSubstitutions: map[string]*string{
"definitionSubstitutionsKey": jsii.String("definitionSubstitutions"),
},
DefinitionUri: jsii.String("definitionUri"),
Events: map[string]interface{}{
"eventsKey": &EventSourceProperty{
"properties": &ApiEventProperty{
"method": jsii.String("method"),
"path": jsii.String("path"),
// the properties below are optional
"restApiId": jsii.String("restApiId"),
},
"type": jsii.String("type"),
},
},
Logging: &LoggingConfigurationProperty{
Destinations: []interface{}{
&LogDestinationProperty{
CloudWatchLogsLogGroup: &CloudWatchLogsLogGroupProperty{
LogGroupArn: jsii.String("logGroupArn"),
},
},
},
IncludeExecutionData: jsii.Boolean(false),
Level: jsii.String("level"),
},
Name: jsii.String("name"),
PermissionsBoundaries: jsii.String("permissionsBoundaries"),
Policies: jsii.String("policies"),
Role: jsii.String("role"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
Tracing: &TracingConfigurationProperty{
Enabled: jsii.Boolean(false),
},
Type: jsii.String("type"),
}
Properties
definitionoptionalanydefinitionoptionalAnydefinitionoptionalObjectDefinitionoptionalobjectDefinitionoptionalinterface{}#definitionSubstitutionsoptionalIResolvable | { [key: string]: string }definition_substitutionsoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]definitionSubstitutionsoptionalIResolvableDefinitionSubstitutionsoptionalIResolvableDefinitionSubstitutionsoptionalinterface{}#definitionUrioptionalstring | IResolvable | CfnStateMachine.S3LocationPropertydefinition_urioptionaltyping.Union[str, IResolvable, S3LocationProperty]definitionUrioptionalStringDefinitionUrioptionalstringDefinitionUrioptionalinterface{}#eventsoptionalIResolvable | { [key: string]: IResolvable | CfnStateMachine.EventSourceProperty }eventsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, EventSourceProperty]]]eventsoptionalIResolvableEventsoptionalIResolvableEventsoptionalinterface{}#loggingoptionalIResolvable | CfnStateMachine.LoggingConfigurationPropertyloggingoptionaltyping.Union[IResolvable, LoggingConfigurationProperty]loggingoptionalIResolvableLoggingoptionalIResolvableLoggingoptionalinterface{}#permissionsBoundariesoptionalstringpermissions_boundariesoptionalstrpermissionsBoundariesoptionalStringPermissionsBoundariesoptionalstringPermissionsBoundariesoptional*string#policiesoptionalstring | IResolvable | CfnStateMachine.IAMPolicyDocumentProperty | string | IResolvable | CfnStateMachine.IAMPolicyDocumentProperty | CfnStateMachine.SAMPolicyTemplateProperty[]policiesoptionaltyping.Union[str, IResolvable, IAMPolicyDocumentProperty, typing.List[typing.Union[str, IResolvable, IAMPolicyDocumentProperty, SAMPolicyTemplateProperty]]]policiesoptionalStringPoliciesoptionalstringPoliciesoptionalinterface{}#tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#tracingoptionalIResolvable | CfnStateMachine.TracingConfigurationPropertytracingoptionaltyping.Union[IResolvable, TracingConfigurationProperty]tracingoptionalIResolvableTracingoptionalIResolvableTracingoptionalinterface{}#