Package software.amazon.awscdk.services.stepfunctions

Class CfnStateMachineAlias

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.stepfunctions.CfnStateMachineAlias
All Implemented Interfaces:
IInspectable, IStateMachineAliasRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:47.793Z") @Stability(Stable) public class CfnStateMachineAlias extends CfnResource implements IInspectable, IStateMachineAliasRef
Represents a state machine alias . An alias routes traffic to one or two versions of the same state machine.

You can create up to 100 aliases for each state machine.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 CfnStateMachineAlias cfnStateMachineAlias = CfnStateMachineAlias.Builder.create(this, "MyCfnStateMachineAlias")
         .deploymentPreference(DeploymentPreferenceProperty.builder()
                 .stateMachineVersionArn("stateMachineVersionArn")
                 .type("type")
                 // the properties below are optional
                 .alarms(List.of("alarms"))
                 .interval(123)
                 .percentage(123)
                 .build())
         .description("description")
         .name("name")
         .routingConfiguration(List.of(RoutingConfigurationVersionProperty.builder()
                 .stateMachineVersionArn("stateMachineVersionArn")
                 .weight(123)
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStateMachineAlias

      protected CfnStateMachineAlias(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStateMachineAlias

      protected CfnStateMachineAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStateMachineAlias

      @Stability(Stable) public CfnStateMachineAlias(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnStateMachineAliasProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnStateMachineAlias

      @Stability(Stable) public CfnStateMachineAlias(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the ARN of the state machine alias.

      For example, arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:PROD .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStateMachineAliasRef

      @Stability(Stable) @NotNull public StateMachineAliasReference getStateMachineAliasRef()
      A reference to a StateMachineAlias resource.
      Specified by:
      getStateMachineAliasRef in interface IStateMachineAliasRef

    • getDeploymentPreference

      @Stability(Stable) @Nullable public Object getDeploymentPreference()
      The settings that enable gradual state machine deployments.

      Returns union: either IResolvable or CfnStateMachineAlias.DeploymentPreferenceProperty

    • setDeploymentPreference

      @Stability(Stable) public void setDeploymentPreference(@Nullable IResolvable value)
      The settings that enable gradual state machine deployments.

    • setDeploymentPreference

      @Stability(Stable) public void setDeploymentPreference(@Nullable CfnStateMachineAlias.DeploymentPreferenceProperty value)
      The settings that enable gradual state machine deployments.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      An optional description of the state machine alias.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description of the state machine alias.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the state machine alias.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the state machine alias.

    • getRoutingConfiguration

      @Stability(Stable) @Nullable public Object getRoutingConfiguration()
      The routing configuration of an alias.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStateMachineAlias.RoutingConfigurationVersionProperty>

    • setRoutingConfiguration

      @Stability(Stable) public void setRoutingConfiguration(@Nullable IResolvable value)
      The routing configuration of an alias.

    • setRoutingConfiguration

      @Stability(Stable) public void setRoutingConfiguration(@Nullable List<Object> value)
      The routing configuration of an alias.