/* * 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 ssm-2014-11-06.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.SimpleSystemsManagement.Model { /// /// Detailed information about the current state of an individual Automation execution. /// public partial class AutomationExecution { private AlarmConfiguration _alarmConfiguration; private string _associationId; private string _automationExecutionId; private AutomationExecutionStatus _automationExecutionStatus; private AutomationSubtype _automationSubtype; private string _changeRequestName; private string _currentAction; private string _currentStepName; private string _documentName; private string _documentVersion; private string _executedBy; private DateTime? _executionEndTime; private DateTime? _executionStartTime; private string _failureMessage; private string _maxConcurrency; private string _maxErrors; private ExecutionMode _mode; private string _opsItemId; private Dictionary> _outputs = new Dictionary>(); private Dictionary> _parameters = new Dictionary>(); private string _parentAutomationExecutionId; private ProgressCounters _progressCounters; private ResolvedTargets _resolvedTargets; private List _runbooks = new List(); private DateTime? _scheduledTime; private List _stepExecutions = new List(); private bool? _stepExecutionsTruncated; private string _target; private List _targetLocations = new List(); private List>> _targetMaps = new List>>(); private string _targetParameterName; private List _targets = new List(); private List _triggeredAlarms = new List(); /// /// Gets and sets the property AlarmConfiguration. /// /// The details for the CloudWatch alarm applied to your automation. /// /// public AlarmConfiguration AlarmConfiguration { get { return this._alarmConfiguration; } set { this._alarmConfiguration = value; } } // Check to see if AlarmConfiguration property is set internal bool IsSetAlarmConfiguration() { return this._alarmConfiguration != null; } /// /// Gets and sets the property AssociationId. /// /// The ID of a State Manager association used in the Automation operation. /// /// public string AssociationId { get { return this._associationId; } set { this._associationId = value; } } // Check to see if AssociationId property is set internal bool IsSetAssociationId() { return this._associationId != null; } /// /// Gets and sets the property AutomationExecutionId. /// /// The execution ID. /// /// [AWSProperty(Min=36, Max=36)] public string AutomationExecutionId { get { return this._automationExecutionId; } set { this._automationExecutionId = value; } } // Check to see if AutomationExecutionId property is set internal bool IsSetAutomationExecutionId() { return this._automationExecutionId != null; } /// /// Gets and sets the property AutomationExecutionStatus. /// /// The execution status of the Automation. /// /// public AutomationExecutionStatus AutomationExecutionStatus { get { return this._automationExecutionStatus; } set { this._automationExecutionStatus = value; } } // Check to see if AutomationExecutionStatus property is set internal bool IsSetAutomationExecutionStatus() { return this._automationExecutionStatus != null; } /// /// Gets and sets the property AutomationSubtype. /// /// The subtype of the Automation operation. Currently, the only supported value is ChangeRequest. /// /// public AutomationSubtype AutomationSubtype { get { return this._automationSubtype; } set { this._automationSubtype = value; } } // Check to see if AutomationSubtype property is set internal bool IsSetAutomationSubtype() { return this._automationSubtype != null; } /// /// Gets and sets the property ChangeRequestName. /// /// The name of the Change Manager change request. /// /// [AWSProperty(Min=1, Max=1024)] public string ChangeRequestName { get { return this._changeRequestName; } set { this._changeRequestName = value; } } // Check to see if ChangeRequestName property is set internal bool IsSetChangeRequestName() { return this._changeRequestName != null; } /// /// Gets and sets the property CurrentAction. /// /// The action of the step that is currently running. /// /// public string CurrentAction { get { return this._currentAction; } set { this._currentAction = value; } } // Check to see if CurrentAction property is set internal bool IsSetCurrentAction() { return this._currentAction != null; } /// /// Gets and sets the property CurrentStepName. /// /// The name of the step that is currently running. /// /// public string CurrentStepName { get { return this._currentStepName; } set { this._currentStepName = value; } } // Check to see if CurrentStepName property is set internal bool IsSetCurrentStepName() { return this._currentStepName != null; } /// /// Gets and sets the property DocumentName. /// /// The name of the Automation runbook used during the execution. /// /// public string DocumentName { get { return this._documentName; } set { this._documentName = value; } } // Check to see if DocumentName property is set internal bool IsSetDocumentName() { return this._documentName != null; } /// /// Gets and sets the property DocumentVersion. /// /// The version of the document to use during execution. /// /// public string DocumentVersion { get { return this._documentVersion; } set { this._documentVersion = value; } } // Check to see if DocumentVersion property is set internal bool IsSetDocumentVersion() { return this._documentVersion != null; } /// /// Gets and sets the property ExecutedBy. /// /// The Amazon Resource Name (ARN) of the user who ran the automation. /// /// public string ExecutedBy { get { return this._executedBy; } set { this._executedBy = value; } } // Check to see if ExecutedBy property is set internal bool IsSetExecutedBy() { return this._executedBy != null; } /// /// Gets and sets the property ExecutionEndTime. /// /// The time the execution finished. /// /// public DateTime ExecutionEndTime { get { return this._executionEndTime.GetValueOrDefault(); } set { this._executionEndTime = value; } } // Check to see if ExecutionEndTime property is set internal bool IsSetExecutionEndTime() { return this._executionEndTime.HasValue; } /// /// Gets and sets the property ExecutionStartTime. /// /// The time the execution started. /// /// public DateTime ExecutionStartTime { get { return this._executionStartTime.GetValueOrDefault(); } set { this._executionStartTime = value; } } // Check to see if ExecutionStartTime property is set internal bool IsSetExecutionStartTime() { return this._executionStartTime.HasValue; } /// /// Gets and sets the property FailureMessage. /// /// A message describing why an execution has failed, if the status is set to Failed. /// /// public string FailureMessage { get { return this._failureMessage; } set { this._failureMessage = value; } } // Check to see if FailureMessage property is set internal bool IsSetFailureMessage() { return this._failureMessage != null; } /// /// Gets and sets the property MaxConcurrency. /// /// The MaxConcurrency value specified by the user when the execution started. /// /// [AWSProperty(Min=1, Max=7)] public string MaxConcurrency { get { return this._maxConcurrency; } set { this._maxConcurrency = value; } } // Check to see if MaxConcurrency property is set internal bool IsSetMaxConcurrency() { return this._maxConcurrency != null; } /// /// Gets and sets the property MaxErrors. /// /// The MaxErrors value specified by the user when the execution started. /// /// [AWSProperty(Min=1, Max=7)] public string MaxErrors { get { return this._maxErrors; } set { this._maxErrors = value; } } // Check to see if MaxErrors property is set internal bool IsSetMaxErrors() { return this._maxErrors != null; } /// /// Gets and sets the property Mode. /// /// The automation execution mode. /// /// public ExecutionMode Mode { get { return this._mode; } set { this._mode = value; } } // Check to see if Mode property is set internal bool IsSetMode() { return this._mode != null; } /// /// Gets and sets the property OpsItemId. /// /// The ID of an OpsItem that is created to represent a Change Manager change request. /// /// public string OpsItemId { get { return this._opsItemId; } set { this._opsItemId = value; } } // Check to see if OpsItemId property is set internal bool IsSetOpsItemId() { return this._opsItemId != null; } /// /// Gets and sets the property Outputs. /// /// The list of execution outputs as defined in the Automation runbook. /// /// [AWSProperty(Min=1, Max=200)] public Dictionary> Outputs { get { return this._outputs; } set { this._outputs = value; } } // Check to see if Outputs property is set internal bool IsSetOutputs() { return this._outputs != null && this._outputs.Count > 0; } /// /// Gets and sets the property Parameters. /// /// The key-value map of execution parameters, which were supplied when calling StartAutomationExecution. /// /// [AWSProperty(Min=1, Max=200)] public Dictionary> Parameters { get { return this._parameters; } set { this._parameters = value; } } // Check to see if Parameters property is set internal bool IsSetParameters() { return this._parameters != null && this._parameters.Count > 0; } /// /// Gets and sets the property ParentAutomationExecutionId. /// /// The AutomationExecutionId of the parent automation. /// /// [AWSProperty(Min=36, Max=36)] public string ParentAutomationExecutionId { get { return this._parentAutomationExecutionId; } set { this._parentAutomationExecutionId = value; } } // Check to see if ParentAutomationExecutionId property is set internal bool IsSetParentAutomationExecutionId() { return this._parentAutomationExecutionId != null; } /// /// Gets and sets the property ProgressCounters. /// /// An aggregate of step execution statuses displayed in the Amazon Web Services Systems /// Manager console for a multi-Region and multi-account Automation execution. /// /// public ProgressCounters ProgressCounters { get { return this._progressCounters; } set { this._progressCounters = value; } } // Check to see if ProgressCounters property is set internal bool IsSetProgressCounters() { return this._progressCounters != null; } /// /// Gets and sets the property ResolvedTargets. /// /// A list of resolved targets in the rate control execution. /// /// public ResolvedTargets ResolvedTargets { get { return this._resolvedTargets; } set { this._resolvedTargets = value; } } // Check to see if ResolvedTargets property is set internal bool IsSetResolvedTargets() { return this._resolvedTargets != null; } /// /// Gets and sets the property Runbooks. /// /// Information about the Automation runbooks that are run as part of a runbook workflow. /// /// /// /// The Automation runbooks specified for the runbook workflow can't run until all required /// approvals for the change request have been received. /// /// /// [AWSProperty(Min=1, Max=1)] public List Runbooks { get { return this._runbooks; } set { this._runbooks = value; } } // Check to see if Runbooks property is set internal bool IsSetRunbooks() { return this._runbooks != null && this._runbooks.Count > 0; } /// /// Gets and sets the property ScheduledTime. /// /// The date and time the Automation operation is scheduled to start. /// /// public DateTime ScheduledTime { get { return this._scheduledTime.GetValueOrDefault(); } set { this._scheduledTime = value; } } // Check to see if ScheduledTime property is set internal bool IsSetScheduledTime() { return this._scheduledTime.HasValue; } /// /// Gets and sets the property StepExecutions. /// /// A list of details about the current state of all steps that comprise an execution. /// An Automation runbook contains a list of steps that are run in order. /// /// public List StepExecutions { get { return this._stepExecutions; } set { this._stepExecutions = value; } } // Check to see if StepExecutions property is set internal bool IsSetStepExecutions() { return this._stepExecutions != null && this._stepExecutions.Count > 0; } /// /// Gets and sets the property StepExecutionsTruncated. /// /// A boolean value that indicates if the response contains the full list of the Automation /// step executions. If true, use the DescribeAutomationStepExecutions API operation to /// get the full list of step executions. /// /// public bool StepExecutionsTruncated { get { return this._stepExecutionsTruncated.GetValueOrDefault(); } set { this._stepExecutionsTruncated = value; } } // Check to see if StepExecutionsTruncated property is set internal bool IsSetStepExecutionsTruncated() { return this._stepExecutionsTruncated.HasValue; } /// /// Gets and sets the property Target. /// /// The target of the execution. /// /// public string Target { get { return this._target; } set { this._target = value; } } // Check to see if Target property is set internal bool IsSetTarget() { return this._target != null; } /// /// Gets and sets the property TargetLocations. /// /// The combination of Amazon Web Services Regions and/or Amazon Web Services accounts /// where you want to run the Automation. /// /// [AWSProperty(Min=1, Max=100)] public List TargetLocations { get { return this._targetLocations; } set { this._targetLocations = value; } } // Check to see if TargetLocations property is set internal bool IsSetTargetLocations() { return this._targetLocations != null && this._targetLocations.Count > 0; } /// /// Gets and sets the property TargetMaps. /// /// The specified key-value mapping of document parameters to target resources. /// /// [AWSProperty(Min=0, Max=300)] public List>> TargetMaps { get { return this._targetMaps; } set { this._targetMaps = value; } } // Check to see if TargetMaps property is set internal bool IsSetTargetMaps() { return this._targetMaps != null && this._targetMaps.Count > 0; } /// /// Gets and sets the property TargetParameterName. /// /// The parameter name. /// /// [AWSProperty(Min=1, Max=50)] public string TargetParameterName { get { return this._targetParameterName; } set { this._targetParameterName = value; } } // Check to see if TargetParameterName property is set internal bool IsSetTargetParameterName() { return this._targetParameterName != null; } /// /// Gets and sets the property Targets. /// /// The specified targets. /// /// [AWSProperty(Min=0, Max=5)] public List Targets { get { return this._targets; } set { this._targets = value; } } // Check to see if Targets property is set internal bool IsSetTargets() { return this._targets != null && this._targets.Count > 0; } /// /// Gets and sets the property TriggeredAlarms. /// /// The CloudWatch alarm that was invoked by the automation. /// /// [AWSProperty(Min=1, Max=1)] public List TriggeredAlarms { get { return this._triggeredAlarms; } set { this._triggeredAlarms = value; } } // Check to see if TriggeredAlarms property is set internal bool IsSetTriggeredAlarms() { return this._triggeredAlarms != null && this._triggeredAlarms.Count > 0; } } }