AwsStepFunctionsAliasArgs

interface AwsStepFunctionsAliasArgs extends Omit<aws.sfn.AliasArgs, 'name' | 'routingConfigurations'> { aliasName: string; description?: Input<string | undefined>; region?: Input<string | undefined>; routingConfigurations: Input<Input<AliasRoutingConfiguration>[]>; }

Input arguments for the Step Functions alias capability.

Example

CODE
const args: AwsStepFunctionsAliasArgs = {
  aliasName: 'production',
  routingConfigurations: [
    {
      stateMachineVersionArn: 'arn:aws:states:eu-west-1:000000000000:stateMachine:orders:1',
      weight: 100,
    },
  ],
};

Hierarchy

  • AliasArgs, "name" | "routingConfigurations">
  • AwsStepFunctionsAliasArgs

Properties

aliasName: string

Required alias purpose name used for AWS resource naming.

description: Input<string | undefined>

Inherited from description

Description of the alias.

region: Input<string | undefined>

Inherited from region

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

routingConfigurations: Input<Input<AliasRoutingConfiguration>[]>

Routing configuration for one or two state machine versions.