AWS Native is in preview. AWS Classic is fully supported.
aws-native.stepfunctions.StateMachineAlias
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource schema for StateMachineAlias
Create StateMachineAlias Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new StateMachineAlias(name: string, args?: StateMachineAliasArgs, opts?: CustomResourceOptions);
@overload
def StateMachineAlias(resource_name: str,
args: Optional[StateMachineAliasArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def StateMachineAlias(resource_name: str,
opts: Optional[ResourceOptions] = None,
deployment_preference: Optional[StateMachineAliasDeploymentPreferenceArgs] = None,
description: Optional[str] = None,
name: Optional[str] = None,
routing_configuration: Optional[Sequence[StateMachineAliasRoutingConfigurationVersionArgs]] = None)
func NewStateMachineAlias(ctx *Context, name string, args *StateMachineAliasArgs, opts ...ResourceOption) (*StateMachineAlias, error)
public StateMachineAlias(string name, StateMachineAliasArgs? args = null, CustomResourceOptions? opts = null)
public StateMachineAlias(String name, StateMachineAliasArgs args)
public StateMachineAlias(String name, StateMachineAliasArgs args, CustomResourceOptions options)
type: aws-native:stepfunctions:StateMachineAlias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args StateMachineAliasArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args StateMachineAliasArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args StateMachineAliasArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StateMachineAliasArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StateMachineAliasArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const stateMachineAliasResource = new aws_native.stepfunctions.StateMachineAlias("stateMachineAliasResource", {
deploymentPreference: {
stateMachineVersionArn: "string",
type: aws_native.stepfunctions.StateMachineAliasDeploymentPreferenceType.Linear,
alarms: ["string"],
interval: 0,
percentage: 0,
},
description: "string",
name: "string",
routingConfiguration: [{
stateMachineVersionArn: "string",
weight: 0,
}],
});
Coming soon!
StateMachineAlias Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The StateMachineAlias resource accepts the following input properties:
- Deployment
Preference Pulumi.Aws Native. Step Functions. Inputs. State Machine Alias Deployment Preference - Description string
- An optional description of the alias.
- Name string
- The alias name.
- Routing
Configuration List<Pulumi.Aws Native. Step Functions. Inputs. State Machine Alias Routing Configuration Version>
- Deployment
Preference StateMachine Alias Deployment Preference Args - Description string
- An optional description of the alias.
- Name string
- The alias name.
- Routing
Configuration []StateMachine Alias Routing Configuration Version Args
- deployment
Preference StateMachine Alias Deployment Preference - description String
- An optional description of the alias.
- name String
- The alias name.
- routing
Configuration List<StateMachine Alias Routing Configuration Version>
- deployment
Preference StateMachine Alias Deployment Preference - description string
- An optional description of the alias.
- name string
- The alias name.
- routing
Configuration StateMachine Alias Routing Configuration Version[]
- deployment_
preference StateMachine Alias Deployment Preference Args - description str
- An optional description of the alias.
- name str
- The alias name.
- routing_
configuration Sequence[StateMachine Alias Routing Configuration Version Args]
- deployment
Preference Property Map - description String
- An optional description of the alias.
- name String
- The alias name.
- routing
Configuration List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the StateMachineAlias resource produces the following output properties:
Supporting Types
StateMachineAliasDeploymentPreference, StateMachineAliasDeploymentPreferenceArgs
- State
Machine stringVersion Arn - Type
Pulumi.
Aws Native. Step Functions. State Machine Alias Deployment Preference Type - The type of deployment to perform.
- Alarms List<string>
- A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state.
- Interval int
- The time in minutes between each traffic shifting increment.
- Percentage int
- The percentage of traffic to shift to the new version in each increment.
- State
Machine stringVersion Arn - Type
State
Machine Alias Deployment Preference Type - The type of deployment to perform.
- Alarms []string
- A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state.
- Interval int
- The time in minutes between each traffic shifting increment.
- Percentage int
- The percentage of traffic to shift to the new version in each increment.
- state
Machine StringVersion Arn - type
State
Machine Alias Deployment Preference Type - The type of deployment to perform.
- alarms List<String>
- A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state.
- interval Integer
- The time in minutes between each traffic shifting increment.
- percentage Integer
- The percentage of traffic to shift to the new version in each increment.
- state
Machine stringVersion Arn - type
State
Machine Alias Deployment Preference Type - The type of deployment to perform.
- alarms string[]
- A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state.
- interval number
- The time in minutes between each traffic shifting increment.
- percentage number
- The percentage of traffic to shift to the new version in each increment.
- state_
machine_ strversion_ arn - type
State
Machine Alias Deployment Preference Type - The type of deployment to perform.
- alarms Sequence[str]
- A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state.
- interval int
- The time in minutes between each traffic shifting increment.
- percentage int
- The percentage of traffic to shift to the new version in each increment.
- state
Machine StringVersion Arn - type "LINEAR" | "ALL_AT_ONCE" | "CANARY"
- The type of deployment to perform.
- alarms List<String>
- A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state.
- interval Number
- The time in minutes between each traffic shifting increment.
- percentage Number
- The percentage of traffic to shift to the new version in each increment.
StateMachineAliasDeploymentPreferenceType, StateMachineAliasDeploymentPreferenceTypeArgs
- Linear
- LINEAR
- All
At Once - ALL_AT_ONCE
- Canary
- CANARY
- State
Machine Alias Deployment Preference Type Linear - LINEAR
- State
Machine Alias Deployment Preference Type All At Once - ALL_AT_ONCE
- State
Machine Alias Deployment Preference Type Canary - CANARY
- Linear
- LINEAR
- All
At Once - ALL_AT_ONCE
- Canary
- CANARY
- Linear
- LINEAR
- All
At Once - ALL_AT_ONCE
- Canary
- CANARY
- LINEAR
- LINEAR
- ALL_AT_ONCE
- ALL_AT_ONCE
- CANARY
- CANARY
- "LINEAR"
- LINEAR
- "ALL_AT_ONCE"
- ALL_AT_ONCE
- "CANARY"
- CANARY
StateMachineAliasRoutingConfigurationVersion, StateMachineAliasRoutingConfigurationVersionArgs
- State
Machine stringVersion Arn - The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
- Weight int
- The percentage of traffic you want to route to the state machine version. The sum of the weights in the routing configuration must be equal to 100.
- State
Machine stringVersion Arn - The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
- Weight int
- The percentage of traffic you want to route to the state machine version. The sum of the weights in the routing configuration must be equal to 100.
- state
Machine StringVersion Arn - The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
- weight Integer
- The percentage of traffic you want to route to the state machine version. The sum of the weights in the routing configuration must be equal to 100.
- state
Machine stringVersion Arn - The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
- weight number
- The percentage of traffic you want to route to the state machine version. The sum of the weights in the routing configuration must be equal to 100.
- state_
machine_ strversion_ arn - The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
- weight int
- The percentage of traffic you want to route to the state machine version. The sum of the weights in the routing configuration must be equal to 100.
- state
Machine StringVersion Arn - The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
- weight Number
- The percentage of traffic you want to route to the state machine version. The sum of the weights in the routing configuration must be equal to 100.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.