/*******************************************************************************
* Copyright 2012-2019 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.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.CloudWatch;
using Amazon.CloudWatch.Model;
namespace Amazon.PowerShell.Cmdlets.CW
{
///
/// Creates or updates a composite alarm. When you create a composite alarm, you
/// specify a rule expression for the alarm that takes into account the alarm states of
/// other alarms that you have created. The composite alarm goes into ALARM state only
/// if all conditions of the rule are met.
///
///
///
/// The alarms specified in a composite alarm's rule expression can include metric alarms
/// and other composite alarms. The rule expression of a composite alarm can include as
/// many as 100 underlying alarms. Any single alarm can be included in the rule expressions
/// of as many as 150 composite alarms.
///
/// Using composite alarms can reduce alarm noise. You can create multiple metric alarms,
/// and also create a composite alarm and set up alerts only for the composite alarm.
/// For example, you could create a composite alarm that goes into ALARM state only when
/// more than one of the underlying metric alarms are in ALARM state.
///
/// Currently, the only alarm actions that can be taken by composite alarms are notifying
/// SNS topics.
///
/// It is possible to create a loop or cycle of composite alarms, where composite alarm
/// A depends on composite alarm B, and composite alarm B also depends on composite alarm
/// A. In this scenario, you can't delete any composite alarm that is part of the cycle
/// because there is always still a composite alarm that depends on that alarm that you
/// want to delete.
///
/// To get out of such a situation, you must break the cycle by changing the rule of one
/// of the composite alarms in the cycle to remove a dependency that creates the cycle.
/// The simplest change to make to break a cycle is to change the AlarmRule
/// of one of the alarms to false
.
///
/// Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle
/// in the evaluation path.
///
/// When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA
.
/// The alarm is then evaluated and its state is set appropriately. Any actions associated
/// with the new state are then executed. For a composite alarm, this initial time after
/// creation is the only time that the alarm can be in INSUFFICIENT_DATA
/// state.
///
/// When you update an existing alarm, its state is left unchanged, but the update completely
/// overwrites the previous configuration of the alarm.
///
/// To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm
/// permission that is scoped to *
. You can't create a composite alarms if
/// your cloudwatch:PutCompositeAlarm
permission has a narrower scope.
///
/// If you are an IAM user, you must have iam:CreateServiceLinkedRole
to
/// create a composite alarm that has Systems Manager OpsItem actions.
///
///
[Cmdlet("Write", "CWCompositeAlarm", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon CloudWatch PutCompositeAlarm API operation.", Operation = new[] {"PutCompositeAlarm"}, SelectReturnType = typeof(Amazon.CloudWatch.Model.PutCompositeAlarmResponse))]
[AWSCmdletOutput("None or Amazon.CloudWatch.Model.PutCompositeAlarmResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.CloudWatch.Model.PutCompositeAlarmResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class WriteCWCompositeAlarmCmdlet : AmazonCloudWatchClientCmdlet, IExecutor
{
#region Parameter ActionsEnabled
///
///
/// Indicates whether actions should be executed during any changes to the alarm state
/// of the composite alarm. The default is TRUE
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? ActionsEnabled { get; set; }
#endregion
#region Parameter ActionsSuppressor
///
///
/// Actions will be suppressed if the suppressor alarm is in the ALARM
state.
/// ActionsSuppressor
can be an AlarmName or an Amazon Resource Name (ARN)
/// from an existing alarm.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ActionsSuppressor { get; set; }
#endregion
#region Parameter ActionsSuppressorExtensionPeriod
///
///
/// The maximum time in seconds that the composite alarm waits after suppressor alarm
/// goes out of the ALARM
state. After this time, the composite alarm performs
/// its actions. ExtensionPeriod
is required only when ActionsSuppressor
/// is specified.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? ActionsSuppressorExtensionPeriod { get; set; }
#endregion
#region Parameter ActionsSuppressorWaitPeriod
///
///
/// The maximum time in seconds that the composite alarm waits for the suppressor alarm
/// to go into the ALARM
state. After this time, the composite alarm performs
/// its actions. WaitPeriod
is required only when ActionsSuppressor
is specified.
///
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? ActionsSuppressorWaitPeriod { get; set; }
#endregion
#region Parameter AlarmAction
///
///
/// The actions to execute when this alarm transitions to the ALARM
state
/// from any other state. Each action is specified as an Amazon Resource Name (ARN).Valid Values: arn:aws:sns:region:account-id:sns-topic-name
| arn:aws:ssm:region:account-id:opsitem:severity
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("AlarmActions")]
public System.String[] AlarmAction { get; set; }
#endregion
#region Parameter AlarmDescription
///
///
/// The description for the composite alarm.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String AlarmDescription { get; set; }
#endregion
#region Parameter AlarmName
///
///
/// The name for the composite alarm. This name must be unique within the Region.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String AlarmName { get; set; }
#endregion
#region Parameter AlarmRule
///
///
/// An expression that specifies which other alarms are to be evaluated to determine this
/// composite alarm's state. For each alarm that you reference, you designate a function
/// that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA
/// state. You can use operators (AND, OR and NOT) to combine multiple functions in a
/// single expression. You can use parenthesis to logically group the functions in your
/// expression.You can use either alarm names or ARNs to reference the other alarms that are to be
/// evaluated.Functions can include the following:ALARM("alarm-name or alarm-ARN")
is TRUE if the named
/// alarm is in ALARM state.OK("alarm-name or alarm-ARN")
is TRUE if the named alarm
/// is in OK state.INSUFFICIENT_DATA("alarm-name or alarm-ARN")
is TRUE if
/// the named alarm is in INSUFFICIENT_DATA state.TRUE
always evaluates to TRUE.FALSE
always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule
structure,
/// and for testing your alarm actions.Alarm names specified in AlarmRule
can be surrounded with double-quotes
/// ("), but do not have to be.The following are some examples of AlarmRule
:ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)
specifies
/// that the composite alarm goes into ALARM state only if both CPUUtilizationTooHigh
/// and DiskReadOpsTooHigh alarms are in ALARM state.ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)
specifies
/// that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state and
/// DeploymentInProgress is not in ALARM state. This example reduces alarm noise during
/// a known deployment window.(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)
/// goes into ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state,
/// and if NetworkOutTooHigh is in OK state. This provides another example of using a
/// composite alarm to prevent noise. This rule ensures that you are not notified with
/// an alarm action on high CPU or disk usage if a known network problem is also occurring.
The AlarmRule
can specify as many as 100 "children" alarms. The AlarmRule
/// expression can have as many as 500 elements. Elements are child alarms, TRUE or FALSE
/// statements, and parentheses.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String AlarmRule { get; set; }
#endregion
#region Parameter InsufficientDataAction
///
///
/// The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
/// state from any other state. Each action is specified as an Amazon Resource Name (ARN).Valid Values: arn:aws:sns:region:account-id:sns-topic-name
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("InsufficientDataActions")]
public System.String[] InsufficientDataAction { get; set; }
#endregion
#region Parameter OKAction
///
///
/// The actions to execute when this alarm transitions to an OK
state from
/// any other state. Each action is specified as an Amazon Resource Name (ARN).Valid Values: arn:aws:sns:region:account-id:sns-topic-name
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("OKActions")]
public System.String[] OKAction { get; set; }
#endregion
#region Parameter Tag
///
///
/// A list of key-value pairs to associate with the composite alarm. You can associate
/// as many as 50 tags with an alarm.Tags can help you organize and categorize your resources. You can also use them to
/// scope user permissions, by granting a user permission to access or change only resources
/// with certain tag values.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.CloudWatch.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatch.Model.PutCompositeAlarmResponse).
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the AlarmName parameter.
/// The -PassThru parameter is deprecated, use -Select '^AlarmName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AlarmName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.AlarmName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-CWCompositeAlarm (PutCompositeAlarm)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.AlarmName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ActionsEnabled = this.ActionsEnabled;
context.ActionsSuppressor = this.ActionsSuppressor;
context.ActionsSuppressorExtensionPeriod = this.ActionsSuppressorExtensionPeriod;
context.ActionsSuppressorWaitPeriod = this.ActionsSuppressorWaitPeriod;
if (this.AlarmAction != null)
{
context.AlarmAction = new List(this.AlarmAction);
}
context.AlarmDescription = this.AlarmDescription;
context.AlarmName = this.AlarmName;
#if MODULAR
if (this.AlarmName == null && ParameterWasBound(nameof(this.AlarmName)))
{
WriteWarning("You are passing $null as a value for parameter AlarmName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.AlarmRule = this.AlarmRule;
#if MODULAR
if (this.AlarmRule == null && ParameterWasBound(nameof(this.AlarmRule)))
{
WriteWarning("You are passing $null as a value for parameter AlarmRule which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
if (this.InsufficientDataAction != null)
{
context.InsufficientDataAction = new List(this.InsufficientDataAction);
}
if (this.OKAction != null)
{
context.OKAction = new List(this.OKAction);
}
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.CloudWatch.Model.PutCompositeAlarmRequest();
if (cmdletContext.ActionsEnabled != null)
{
request.ActionsEnabled = cmdletContext.ActionsEnabled.Value;
}
if (cmdletContext.ActionsSuppressor != null)
{
request.ActionsSuppressor = cmdletContext.ActionsSuppressor;
}
if (cmdletContext.ActionsSuppressorExtensionPeriod != null)
{
request.ActionsSuppressorExtensionPeriod = cmdletContext.ActionsSuppressorExtensionPeriod.Value;
}
if (cmdletContext.ActionsSuppressorWaitPeriod != null)
{
request.ActionsSuppressorWaitPeriod = cmdletContext.ActionsSuppressorWaitPeriod.Value;
}
if (cmdletContext.AlarmAction != null)
{
request.AlarmActions = cmdletContext.AlarmAction;
}
if (cmdletContext.AlarmDescription != null)
{
request.AlarmDescription = cmdletContext.AlarmDescription;
}
if (cmdletContext.AlarmName != null)
{
request.AlarmName = cmdletContext.AlarmName;
}
if (cmdletContext.AlarmRule != null)
{
request.AlarmRule = cmdletContext.AlarmRule;
}
if (cmdletContext.InsufficientDataAction != null)
{
request.InsufficientDataActions = cmdletContext.InsufficientDataAction;
}
if (cmdletContext.OKAction != null)
{
request.OKActions = cmdletContext.OKAction;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.CloudWatch.Model.PutCompositeAlarmResponse CallAWSServiceOperation(IAmazonCloudWatch client, Amazon.CloudWatch.Model.PutCompositeAlarmRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon CloudWatch", "PutCompositeAlarm");
try
{
#if DESKTOP
return client.PutCompositeAlarm(request);
#elif CORECLR
return client.PutCompositeAlarmAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.Boolean? ActionsEnabled { get; set; }
public System.String ActionsSuppressor { get; set; }
public System.Int32? ActionsSuppressorExtensionPeriod { get; set; }
public System.Int32? ActionsSuppressorWaitPeriod { get; set; }
public List AlarmAction { get; set; }
public System.String AlarmDescription { get; set; }
public System.String AlarmName { get; set; }
public System.String AlarmRule { get; set; }
public List InsufficientDataAction { get; set; }
public List OKAction { get; set; }
public List Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}