/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the states-2016-11-23.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.StepFunctions.Model
{
///
/// Container for the parameters to the CreateStateMachineAlias operation.
/// Creates an alias
/// for a state machine that points to one or two versions
/// of the same state machine. You can set your application to call StartExecution
/// with an alias and update the version the alias uses without changing the client's
/// code.
///
///
///
/// You can also map an alias to split StartExecution requests between two versions
/// of a state machine. To do this, add a second RoutingConfig
object in
/// the routingConfiguration
parameter. You must also specify the percentage
/// of execution run requests each version should receive in both RoutingConfig
/// objects. Step Functions randomly chooses which version runs a given execution based
/// on the percentage you specify.
///
///
///
/// To create an alias that points to a single version, specify a single RoutingConfig
/// object with a weight
set to 100.
///
///
///
/// You can create up to 100 aliases for each state machine. You must delete unused aliases
/// using the DeleteStateMachineAlias API action.
///
///
///
/// CreateStateMachineAlias
is an idempotent API. Step Functions bases the
/// idempotency check on the stateMachineArn
, description
, name
,
/// and routingConfiguration
parameters. Requests that contain the same values
/// for these parameters return a successful idempotent response without creating a duplicate
/// resource.
///
///
///
/// Related operations:
///
///
///
public partial class CreateStateMachineAliasRequest : AmazonStepFunctionsRequest
{
private string _description;
private string _name;
private List _routingConfiguration = new List();
///
/// Gets and sets the property Description.
///
/// A description for the state machine alias.
///
///
[AWSProperty(Sensitive=true, Max=256)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
///
/// Gets and sets the property Name.
///
/// The name of the state machine alias.
///
///
///
/// To avoid conflict with version ARNs, don't use an integer in the name of the alias.
///
///
[AWSProperty(Required=true, Min=1, Max=80)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
///
/// Gets and sets the property RoutingConfiguration.
///
/// The routing configuration of a state machine alias. The routing configuration shifts
/// execution traffic between two state machine versions. routingConfiguration
/// contains an array of RoutingConfig
objects that specify up to two state
/// machine versions. Step Functions then randomly choses which version to run an execution
/// with based on the weight assigned to each RoutingConfig
.
///
///
[AWSProperty(Required=true, Min=1, Max=2)]
public List RoutingConfiguration
{
get { return this._routingConfiguration; }
set { this._routingConfiguration = value; }
}
// Check to see if RoutingConfiguration property is set
internal bool IsSetRoutingConfiguration()
{
return this._routingConfiguration != null && this._routingConfiguration.Count > 0;
}
}
}