Class CfnStateMachineAlias
Represents a state machine alias . An alias routes traffic to one or two versions of the same state machine.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStateMachineAlias : CfnResource, IInspectable
Syntax (vb)
Public Class CfnStateMachineAlias
Inherits CfnResource
Implements IInspectable
Remarks
You can create up to 100 aliases for each state machine.
CloudformationResource: AWS::StepFunctions::StateMachineAlias
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 cfnStateMachineAlias = new CfnStateMachineAlias(this, "MyCfnStateMachineAlias", new CfnStateMachineAliasProps {
DeploymentPreference = new DeploymentPreferenceProperty {
StateMachineVersionArn = "stateMachineVersionArn",
Type = "type",
// the properties below are optional
Alarms = new [] { "alarms" },
Interval = 123,
Percentage = 123
},
Description = "description",
Name = "name",
RoutingConfiguration = new [] { new RoutingConfigurationVersionProperty {
StateMachineVersionArn = "stateMachineVersionArn",
Weight = 123
} }
});
Synopsis
Constructors
CfnStateMachineAlias(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStateMachineAlias(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnStateMachineAlias(Construct, String, ICfnStateMachineAliasProps) |
Properties
AttrArn | Returns the ARN of the state machine alias. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DeploymentPreference | The settings that enable gradual state machine deployments. |
Description | An optional description of the state machine alias. |
Name | The name of the state machine alias. |
RoutingConfiguration | The routing configuration of an alias. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStateMachineAlias(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStateMachineAlias(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStateMachineAlias(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStateMachineAlias(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnStateMachineAlias(Construct, String, ICfnStateMachineAliasProps)
public CfnStateMachineAlias(Construct scope, string id, ICfnStateMachineAliasProps 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 ICfnStateMachineAliasProps
Resource properties.
Properties
AttrArn
Returns the ARN of the state machine alias.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:PROD
.
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
DeploymentPreference
The settings that enable gradual state machine deployments.
public virtual object DeploymentPreference { get; set; }
Property Value
System.Object
Description
An optional description of the state machine alias.
public virtual string Description { get; set; }
Property Value
System.String
Name
The name of the state machine alias.
public virtual string Name { get; set; }
Property Value
System.String
RoutingConfiguration
The routing configuration of an alias.
public virtual object RoutingConfiguration { get; set; }
Property Value
System.Object
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>