Class CfnStateMachineVersion
Represents a state machine version . A published version uses the latest state machine revision . A revision is an immutable, read-only snapshot of a state machine’s definition and configuration.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStateMachineVersion : CfnResource, IInspectable
Syntax (vb)
Public Class CfnStateMachineVersion
Inherits CfnResource
Implements IInspectable
Remarks
You can publish up to 1000 versions for each state machine.
Before you delete a version, make sure that version's ARN isn't being referenced in any long-running workflows or application code outside of the stack.
CloudformationResource: AWS::StepFunctions::StateMachineVersion
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.StepFunctions;
var cfnStateMachineVersion = new CfnStateMachineVersion(this, "MyCfnStateMachineVersion", new CfnStateMachineVersionProps {
StateMachineArn = "stateMachineArn",
// the properties below are optional
Description = "description",
StateMachineRevisionId = "stateMachineRevisionId"
});
Synopsis
Constructors
CfnStateMachineVersion(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStateMachineVersion(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnStateMachineVersion(Construct, String, ICfnStateMachineVersionProps) |
Properties
AttrArn | Returns the ARN of the state machine version. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | An optional description of the state machine version. |
StateMachineArn | The Amazon Resource Name (ARN) of the state machine. |
StateMachineRevisionId | Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStateMachineVersion(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStateMachineVersion(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStateMachineVersion(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStateMachineVersion(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnStateMachineVersion(Construct, String, ICfnStateMachineVersionProps)
public CfnStateMachineVersion(Construct scope, string id, ICfnStateMachineVersionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnStateMachineVersionProps
Resource properties.
Properties
AttrArn
Returns the ARN of the state machine version.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1
.
CloudformationAttribute: Arn
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
Description
An optional description of the state machine version.
public virtual string Description { get; set; }
Property Value
System.String
StateMachineArn
The Amazon Resource Name (ARN) of the state machine.
public virtual string StateMachineArn { get; set; }
Property Value
System.String
StateMachineRevisionId
Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.
public virtual string StateMachineRevisionId { 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>