/*******************************************************************************
* 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.ApplicationAutoScaling;
using Amazon.ApplicationAutoScaling.Model;
namespace Amazon.PowerShell.Cmdlets.AAS
{
///
/// Deletes the specified scaling policy for an Application Auto Scaling scalable target.
///
///
///
/// Deleting a step scaling policy deletes the underlying alarm action, but does not delete
/// the CloudWatch alarm associated with the scaling policy, even if it no longer has
/// an associated action.
///
/// For more information, see Delete
/// a step scaling policy and Delete
/// a target tracking scaling policy in the Application Auto Scaling User Guide.
///
///
[Cmdlet("Remove", "AASScalingPolicy", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)]
[OutputType("None")]
[AWSCmdlet("Calls the Application Auto Scaling DeleteScalingPolicy API operation.", Operation = new[] {"DeleteScalingPolicy"}, SelectReturnType = typeof(Amazon.ApplicationAutoScaling.Model.DeleteScalingPolicyResponse))]
[AWSCmdletOutput("None or Amazon.ApplicationAutoScaling.Model.DeleteScalingPolicyResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.ApplicationAutoScaling.Model.DeleteScalingPolicyResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RemoveAASScalingPolicyCmdlet : AmazonApplicationAutoScalingClientCmdlet, IExecutor
{
#region Parameter PolicyName
///
///
/// The name of the scaling policy.
///
///
#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 PolicyName { get; set; }
#endregion
#region Parameter ResourceId
///
///
/// The identifier of the resource associated with the scalable target. This string consists
/// of the resource type and unique identifier.- ECS service - The resource type is
service
and the unique identifier
/// is the cluster name and service name. Example: service/default/sample-webapp
. - Spot Fleet - The resource type is
spot-fleet-request
and the unique identifier
/// is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
. - EMR cluster - The resource type is
instancegroup
and the unique identifier
/// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
. - AppStream 2.0 fleet - The resource type is
fleet
and the unique identifier
/// is the fleet name. Example: fleet/sample-fleet
. - DynamoDB table - The resource type is
table
and the unique identifier
/// is the table name. Example: table/my-table
. - DynamoDB global secondary index - The resource type is
index
and the
/// unique identifier is the index name. Example: table/my-table/index/my-table-index
. - Aurora DB cluster - The resource type is
cluster
and the unique identifier
/// is the cluster name. Example: cluster:my-db-cluster
. - SageMaker endpoint variant - The resource type is
variant
and the unique
/// identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering
. - Custom resources are not supported with a resource type. This parameter must specify
/// the
OutputValue
from the CloudFormation template stack used to access
/// the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository. - Amazon Comprehend document classification endpoint - The resource type and unique
/// identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE
. - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier
/// are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE
. - Lambda provisioned concurrency - The resource type is
function
and the
/// unique identifier is the function name with a function version or alias name suffix
/// that is not $LATEST
. Example: function:my-function:prod
/// or function:my-function:1
. - Amazon Keyspaces table - The resource type is
table
and the unique identifier
/// is the table name. Example: keyspace/mykeyspace/table/mytable
. - Amazon MSK cluster - The resource type and unique identifier are specified using the
/// cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5
. - Amazon ElastiCache replication group - The resource type is
replication-group
/// and the unique identifier is the replication group name. Example: replication-group/mycluster
. - Neptune cluster - The resource type is
cluster
and the unique identifier
/// is the cluster name. Example: cluster:mycluster
. - SageMaker Serverless endpoint - The resource type is
variant
and the
/// unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering
.
///
///
#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 ResourceId { get; set; }
#endregion
#region Parameter ScalableDimension
///
///
/// The scalable dimension. This string consists of the service namespace, resource type,
/// and scaling property.ecs:service:DesiredCount
- The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount
- The instance count of
/// an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot
/// Fleet.appstream:fleet:DesiredCapacity
- The desired capacity of an AppStream
/// 2.0 fleet.dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for
/// a DynamoDB table.dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for
/// a DynamoDB table.dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for
/// a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for
/// a DynamoDB global secondary index.rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora
/// DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
/// edition.sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances
/// for a SageMaker model endpoint variant.custom-resource:ResourceType:Property
- The scalable dimension for a
/// custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The
/// number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number
/// of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency
- The provisioned concurrency
/// for a Lambda function.cassandra:table:ReadCapacityUnits
- The provisioned read capacity for
/// an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits
- The provisioned write capacity
/// for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB)
/// for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups
- The number of node groups
/// for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas
- The number of replicas per
/// node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount
- The count of read replicas in an
/// Amazon Neptune DB cluster.sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency
/// for a SageMaker Serverless endpoint.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[AWSConstantClassSource("Amazon.ApplicationAutoScaling.ScalableDimension")]
public Amazon.ApplicationAutoScaling.ScalableDimension ScalableDimension { get; set; }
#endregion
#region Parameter ServiceNamespace
///
///
/// The namespace of the Amazon Web Services service that provides the resource. For a
/// resource provided by your own application or service, use custom-resource
/// instead.
///
///
#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.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[AWSConstantClassSource("Amazon.ApplicationAutoScaling.ServiceNamespace")]
public Amazon.ApplicationAutoScaling.ServiceNamespace ServiceNamespace { 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.ApplicationAutoScaling.Model.DeleteScalingPolicyResponse).
/// 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 ServiceNamespace parameter.
/// The -PassThru parameter is deprecated, use -Select '^ServiceNamespace' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ServiceNamespace' 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.PolicyName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-AASScalingPolicy (DeleteScalingPolicy)"))
{
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.ServiceNamespace;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.PolicyName = this.PolicyName;
#if MODULAR
if (this.PolicyName == null && ParameterWasBound(nameof(this.PolicyName)))
{
WriteWarning("You are passing $null as a value for parameter PolicyName 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.ResourceId = this.ResourceId;
#if MODULAR
if (this.ResourceId == null && ParameterWasBound(nameof(this.ResourceId)))
{
WriteWarning("You are passing $null as a value for parameter ResourceId 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.ScalableDimension = this.ScalableDimension;
#if MODULAR
if (this.ScalableDimension == null && ParameterWasBound(nameof(this.ScalableDimension)))
{
WriteWarning("You are passing $null as a value for parameter ScalableDimension 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.ServiceNamespace = this.ServiceNamespace;
#if MODULAR
if (this.ServiceNamespace == null && ParameterWasBound(nameof(this.ServiceNamespace)))
{
WriteWarning("You are passing $null as a value for parameter ServiceNamespace 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
// 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.ApplicationAutoScaling.Model.DeleteScalingPolicyRequest();
if (cmdletContext.PolicyName != null)
{
request.PolicyName = cmdletContext.PolicyName;
}
if (cmdletContext.ResourceId != null)
{
request.ResourceId = cmdletContext.ResourceId;
}
if (cmdletContext.ScalableDimension != null)
{
request.ScalableDimension = cmdletContext.ScalableDimension;
}
if (cmdletContext.ServiceNamespace != null)
{
request.ServiceNamespace = cmdletContext.ServiceNamespace;
}
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.ApplicationAutoScaling.Model.DeleteScalingPolicyResponse CallAWSServiceOperation(IAmazonApplicationAutoScaling client, Amazon.ApplicationAutoScaling.Model.DeleteScalingPolicyRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Application Auto Scaling", "DeleteScalingPolicy");
try
{
#if DESKTOP
return client.DeleteScalingPolicy(request);
#elif CORECLR
return client.DeleteScalingPolicyAsync(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.String PolicyName { get; set; }
public System.String ResourceId { get; set; }
public Amazon.ApplicationAutoScaling.ScalableDimension ScalableDimension { get; set; }
public Amazon.ApplicationAutoScaling.ServiceNamespace ServiceNamespace { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}