Class CfnStateMachine
Inherited Members
Namespace: Amazon.CDK.AWS.SAM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStateMachine : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnStateMachine
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
CloudformationResource: AWS::Serverless::StateMachine
ExampleMetadata: fixture=_generated
Examples
// 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 cfnStateMachine = new CfnStateMachine(this, "MyCfnStateMachine", 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"
});
Synopsis
Constructors
CfnStateMachine(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStateMachine(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnStateMachine(Construct, String, ICfnStateMachineProps) |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Definition | |
DefinitionSubstitutions | |
DefinitionUri | |
Events | |
Logging | |
Name | |
PermissionsBoundaries | |
Policies | |
REQUIRED_TRANSFORM | The |
Role | |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | |
Tracing | |
Type |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStateMachine(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStateMachine(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStateMachine(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStateMachine(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnStateMachine(Construct, String, ICfnStateMachineProps)
public CfnStateMachine(Construct scope, string id, ICfnStateMachineProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnStateMachineProps
Resource properties.
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Definition
public virtual object Definition { get; set; }
Property Value
System.Object
DefinitionSubstitutions
public virtual object DefinitionSubstitutions { get; set; }
Property Value
System.Object
DefinitionUri
public virtual object DefinitionUri { get; set; }
Property Value
System.Object
Events
public virtual object Events { get; set; }
Property Value
System.Object
Logging
public virtual object Logging { get; set; }
Property Value
System.Object
Name
public virtual string Name { get; set; }
Property Value
System.String
PermissionsBoundaries
public virtual string PermissionsBoundaries { get; set; }
Property Value
System.String
Policies
public virtual object Policies { get; set; }
Property Value
System.Object
REQUIRED_TRANSFORM
The Transform
a template must use in order to use this resource.
public static string REQUIRED_TRANSFORM { get; }
Property Value
System.String
Role
public virtual string Role { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Tracing
public virtual object Tracing { get; set; }
Property Value
System.Object
Type
public virtual string Type { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>