Class CfnStateMachine

A CloudFormation AWS::Serverless::StateMachine.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnStateMachine

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.SAM

Assembly: Amazon.CDK.AWS.SAM.dll

Syntax (csharp)

public class CfnStateMachine : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnStateMachine
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

CloudformationResource: AWS::Serverless::StateMachine

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

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 CloudWatchEventEventProperty {
                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(Construct, String, ICfnStateMachineProps)	Create a new AWS::Serverless::StateMachine.
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

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
Definition	AWS::Serverless::StateMachine.Definition.
DefinitionSubstitutions	AWS::Serverless::StateMachine.DefinitionSubstitutions.
DefinitionUri	AWS::Serverless::StateMachine.DefinitionUri.
Events	AWS::Serverless::StateMachine.Events.
Logging	AWS::Serverless::StateMachine.Logging.
Name	AWS::Serverless::StateMachine.Name.
PermissionsBoundaries	AWS::Serverless::StateMachine.PermissionsBoundaries.
Policies	AWS::Serverless::StateMachine.Policies.
REQUIRED_TRANSFORM	The Transform a template must use in order to use this resource.
Role	AWS::Serverless::StateMachine.Role.
Tags	AWS::Serverless::StateMachine.Tags.
Tracing	AWS::Serverless::StateMachine.Tracing.
Type	AWS::Serverless::StateMachine.Type.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnStateMachine(Construct, String, ICfnStateMachineProps)

Create a new AWS::Serverless::StateMachine.

public CfnStateMachine(Construct scope, string id, ICfnStateMachineProps props = null)

Parameters

scope Construct

• scope in which this resource is defined.

id System.String

• scoped id of the resource.

props ICfnStateMachineProps

• resource properties.

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

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

CfnResource.CfnProperties

Definition

AWS::Serverless::StateMachine.Definition.

public virtual object Definition { get; set; }

Property Value

System.Object

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

DefinitionSubstitutions

AWS::Serverless::StateMachine.DefinitionSubstitutions.

public virtual object DefinitionSubstitutions { get; set; }

Property Value

System.Object

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

DefinitionUri

AWS::Serverless::StateMachine.DefinitionUri.

public virtual object DefinitionUri { get; set; }

Property Value

System.Object

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

Events

AWS::Serverless::StateMachine.Events.

public virtual object Events { get; set; }

Property Value

System.Object

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

Logging

AWS::Serverless::StateMachine.Logging.

public virtual object Logging { get; set; }

Property Value

System.Object

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

Name

AWS::Serverless::StateMachine.Name.

public virtual string Name { get; set; }

Property Value

System.String

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

PermissionsBoundaries

AWS::Serverless::StateMachine.PermissionsBoundaries.

public virtual string PermissionsBoundaries { get; set; }

Property Value

System.String

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html#sam-statemachine-permissionsboundary

Policies

AWS::Serverless::StateMachine.Policies.

public virtual object Policies { get; set; }

Property Value

System.Object

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

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

AWS::Serverless::StateMachine.Role.

public virtual string Role { get; set; }

Property Value

System.String

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

Tags

AWS::Serverless::StateMachine.Tags.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

Tracing

AWS::Serverless::StateMachine.Tracing.

public virtual object Tracing { get; set; }

Property Value

System.Object

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html#sam-statemachine-tracing

Type

AWS::Serverless::StateMachine.Type.

public virtual string Type { get; set; }

Property Value

System.String

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable