/*
* 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
{
///
/// This is the response object from the DescribeStateMachine operation.
///
public partial class DescribeStateMachineResponse : AmazonWebServiceResponse
{
private DateTime? _creationDate;
private string _definition;
private string _description;
private string _label;
private LoggingConfiguration _loggingConfiguration;
private string _name;
private string _revisionId;
private string _roleArn;
private string _stateMachineArn;
private StateMachineStatus _status;
private TracingConfiguration _tracingConfiguration;
private StateMachineType _type;
///
/// Gets and sets the property CreationDate.
///
/// The date the state machine is created.
///
///
///
/// For a state machine version, creationDate
is the date the version was
/// created.
///
///
[AWSProperty(Required=true)]
public DateTime CreationDate
{
get { return this._creationDate.GetValueOrDefault(); }
set { this._creationDate = value; }
}
// Check to see if CreationDate property is set
internal bool IsSetCreationDate()
{
return this._creationDate.HasValue;
}
///
/// Gets and sets the property Definition.
///
/// The Amazon States Language definition of the state machine. See Amazon
/// States Language.
///
///
[AWSProperty(Required=true, Sensitive=true, Min=1, Max=1048576)]
public string Definition
{
get { return this._definition; }
set { this._definition = value; }
}
// Check to see if Definition property is set
internal bool IsSetDefinition()
{
return this._definition != null;
}
///
/// Gets and sets the property Description.
///
/// The description of the state machine version.
///
///
[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 Label.
///
/// A user-defined or an auto-generated string that identifies a Map
state.
/// This parameter is present only if the stateMachineArn
specified in input
/// is a qualified state machine ARN.
///
///
public string Label
{
get { return this._label; }
set { this._label = value; }
}
// Check to see if Label property is set
internal bool IsSetLabel()
{
return this._label != null;
}
///
/// Gets and sets the property LoggingConfiguration.
///
public LoggingConfiguration LoggingConfiguration
{
get { return this._loggingConfiguration; }
set { this._loggingConfiguration = value; }
}
// Check to see if LoggingConfiguration property is set
internal bool IsSetLoggingConfiguration()
{
return this._loggingConfiguration != null;
}
///
/// Gets and sets the property Name.
///
/// The name of the state machine.
///
///
///
/// A name must not contain:
///
/// -
///
/// white space
///
///
-
///
/// brackets
< > { } [ ]
///
/// -
///
/// wildcard characters
? *
///
/// -
///
/// special characters
" # % \ ^ | ~ ` $ & , ; : /
///
/// -
///
/// control characters (
U+0000-001F
, U+007F-009F
)
///
///
///
/// To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z,
/// - and _.
///
///
[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 RevisionId.
///
/// The revision identifier for the state machine.
///
///
///
/// Use the revisionId
parameter to compare between versions of a state machine
/// configuration used for executions without performing a diff of the properties, such
/// as definition
and roleArn
.
///
///
public string RevisionId
{
get { return this._revisionId; }
set { this._revisionId = value; }
}
// Check to see if RevisionId property is set
internal bool IsSetRevisionId()
{
return this._revisionId != null;
}
///
/// Gets and sets the property RoleArn.
///
/// The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
/// (The IAM role maintains security by granting Step Functions access to Amazon Web Services
/// resources.)
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string RoleArn
{
get { return this._roleArn; }
set { this._roleArn = value; }
}
// Check to see if RoleArn property is set
internal bool IsSetRoleArn()
{
return this._roleArn != null;
}
///
/// Gets and sets the property StateMachineArn.
///
/// The Amazon Resource Name (ARN) that identifies the state machine.
///
///
///
/// If you specified a state machine version ARN in your request, the API returns the
/// version ARN. The version ARN is a combination of state machine ARN and the version
/// number separated by a colon (:). For example, stateMachineARN:1
.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string StateMachineArn
{
get { return this._stateMachineArn; }
set { this._stateMachineArn = value; }
}
// Check to see if StateMachineArn property is set
internal bool IsSetStateMachineArn()
{
return this._stateMachineArn != null;
}
///
/// Gets and sets the property Status.
///
/// The current status of the state machine.
///
///
public StateMachineStatus Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
///
/// Gets and sets the property TracingConfiguration.
///
/// Selects whether X-Ray tracing is enabled.
///
///
public TracingConfiguration TracingConfiguration
{
get { return this._tracingConfiguration; }
set { this._tracingConfiguration = value; }
}
// Check to see if TracingConfiguration property is set
internal bool IsSetTracingConfiguration()
{
return this._tracingConfiguration != null;
}
///
/// Gets and sets the property Type.
///
/// The type
of the state machine (STANDARD
or EXPRESS
).
///
///
[AWSProperty(Required=true)]
public StateMachineType Type
{
get { return this._type; }
set { this._type = value; }
}
// Check to see if Type property is set
internal bool IsSetType()
{
return this._type != null;
}
}
}