@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
293 lines • 11.4 kB
JavaScript
"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Policy = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides an Application AutoScaling Policy resource.
*
* ## Example Usage
*
* ### DynamoDB Table Autoscaling
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const dynamodbTableReadTarget = new aws.appautoscaling.Target("dynamodb_table_read_target", {
* maxCapacity: 100,
* minCapacity: 5,
* resourceId: "table/tableName",
* scalableDimension: "dynamodb:table:ReadCapacityUnits",
* serviceNamespace: "dynamodb",
* });
* const dynamodbTableReadPolicy = new aws.appautoscaling.Policy("dynamodb_table_read_policy", {
* name: pulumi.interpolate`DynamoDBReadCapacityUtilization:${dynamodbTableReadTarget.resourceId}`,
* policyType: "TargetTrackingScaling",
* resourceId: dynamodbTableReadTarget.resourceId,
* scalableDimension: dynamodbTableReadTarget.scalableDimension,
* serviceNamespace: dynamodbTableReadTarget.serviceNamespace,
* targetTrackingScalingPolicyConfiguration: {
* predefinedMetricSpecification: {
* predefinedMetricType: "DynamoDBReadCapacityUtilization",
* },
* targetValue: 70,
* },
* });
* ```
*
* ### ECS Service Autoscaling
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const ecsTarget = new aws.appautoscaling.Target("ecs_target", {
* maxCapacity: 4,
* minCapacity: 1,
* resourceId: "service/clusterName/serviceName",
* scalableDimension: "ecs:service:DesiredCount",
* serviceNamespace: "ecs",
* });
* const ecsPolicy = new aws.appautoscaling.Policy("ecs_policy", {
* name: "scale-down",
* policyType: "StepScaling",
* resourceId: ecsTarget.resourceId,
* scalableDimension: ecsTarget.scalableDimension,
* serviceNamespace: ecsTarget.serviceNamespace,
* stepScalingPolicyConfiguration: {
* adjustmentType: "ChangeInCapacity",
* cooldown: 60,
* metricAggregationType: "Maximum",
* stepAdjustments: [{
* metricIntervalUpperBound: "0",
* scalingAdjustment: -1,
* }],
* },
* });
* ```
*
* ### Preserve desired count when updating an autoscaled ECS Service
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const ecsService = new aws.ecs.Service("ecs_service", {
* name: "serviceName",
* cluster: "clusterName",
* taskDefinition: "taskDefinitionFamily:1",
* desiredCount: 2,
* });
* ```
*
* ### Aurora Read Replica Autoscaling
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const replicas = new aws.appautoscaling.Target("replicas", {
* serviceNamespace: "rds",
* scalableDimension: "rds:cluster:ReadReplicaCount",
* resourceId: `cluster:${example.id}`,
* minCapacity: 1,
* maxCapacity: 15,
* });
* const replicasPolicy = new aws.appautoscaling.Policy("replicas", {
* name: "cpu-auto-scaling",
* serviceNamespace: replicas.serviceNamespace,
* scalableDimension: replicas.scalableDimension,
* resourceId: replicas.resourceId,
* policyType: "TargetTrackingScaling",
* targetTrackingScalingPolicyConfiguration: {
* predefinedMetricSpecification: {
* predefinedMetricType: "RDSReaderAverageCPUUtilization",
* },
* targetValue: 75,
* scaleInCooldown: 300,
* scaleOutCooldown: 300,
* },
* });
* ```
*
* ### Create target tracking scaling policy using metric math
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const ecsTarget = new aws.appautoscaling.Target("ecs_target", {
* maxCapacity: 4,
* minCapacity: 1,
* resourceId: "service/clusterName/serviceName",
* scalableDimension: "ecs:service:DesiredCount",
* serviceNamespace: "ecs",
* });
* const example = new aws.appautoscaling.Policy("example", {
* name: "foo",
* policyType: "TargetTrackingScaling",
* resourceId: ecsTarget.resourceId,
* scalableDimension: ecsTarget.scalableDimension,
* serviceNamespace: ecsTarget.serviceNamespace,
* targetTrackingScalingPolicyConfiguration: {
* targetValue: 100,
* customizedMetricSpecification: {
* metrics: [
* {
* label: "Get the queue size (the number of messages waiting to be processed)",
* id: "m1",
* metricStat: {
* metric: {
* metricName: "ApproximateNumberOfMessagesVisible",
* namespace: "AWS/SQS",
* dimensions: [{
* name: "QueueName",
* value: "my-queue",
* }],
* },
* stat: "Sum",
* },
* returnData: false,
* },
* {
* label: "Get the ECS running task count (the number of currently running tasks)",
* id: "m2",
* metricStat: {
* metric: {
* metricName: "RunningTaskCount",
* namespace: "ECS/ContainerInsights",
* dimensions: [
* {
* name: "ClusterName",
* value: "default",
* },
* {
* name: "ServiceName",
* value: "web-app",
* },
* ],
* },
* stat: "Average",
* },
* returnData: false,
* },
* {
* label: "Calculate the backlog per instance",
* id: "e1",
* expression: "m1 / m2",
* returnData: true,
* },
* ],
* },
* },
* });
* ```
*
* ### MSK / Kafka Autoscaling
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const mskTarget = new aws.appautoscaling.Target("msk_target", {
* serviceNamespace: "kafka",
* scalableDimension: "kafka:broker-storage:VolumeSize",
* resourceId: example.arn,
* minCapacity: 1,
* maxCapacity: 8,
* });
* const targets = new aws.appautoscaling.Policy("targets", {
* name: "storage-size-auto-scaling",
* serviceNamespace: mskTarget.serviceNamespace,
* scalableDimension: mskTarget.scalableDimension,
* resourceId: mskTarget.resourceId,
* policyType: "TargetTrackingScaling",
* targetTrackingScalingPolicyConfiguration: {
* predefinedMetricSpecification: {
* predefinedMetricType: "KafkaBrokerStorageUtilization",
* },
* targetValue: 55,
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Application AutoScaling Policy using the `service-namespace` , `resource-id`, `scalable-dimension` and `policy-name` separated by `/`. For example:
*
* ```sh
* $ pulumi import aws:appautoscaling/policy:Policy test-policy service-namespace/resource-id/scalable-dimension/policy-name
* ```
*/
class Policy extends pulumi.CustomResource {
/**
* Get an existing Policy resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new Policy(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Policy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Policy.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["alarmArns"] = state?.alarmArns;
resourceInputs["arn"] = state?.arn;
resourceInputs["name"] = state?.name;
resourceInputs["policyType"] = state?.policyType;
resourceInputs["region"] = state?.region;
resourceInputs["resourceId"] = state?.resourceId;
resourceInputs["scalableDimension"] = state?.scalableDimension;
resourceInputs["serviceNamespace"] = state?.serviceNamespace;
resourceInputs["stepScalingPolicyConfiguration"] = state?.stepScalingPolicyConfiguration;
resourceInputs["targetTrackingScalingPolicyConfiguration"] = state?.targetTrackingScalingPolicyConfiguration;
}
else {
const args = argsOrState;
if (args?.resourceId === undefined && !opts.urn) {
throw new Error("Missing required property 'resourceId'");
}
if (args?.scalableDimension === undefined && !opts.urn) {
throw new Error("Missing required property 'scalableDimension'");
}
if (args?.serviceNamespace === undefined && !opts.urn) {
throw new Error("Missing required property 'serviceNamespace'");
}
resourceInputs["name"] = args?.name;
resourceInputs["policyType"] = args?.policyType;
resourceInputs["region"] = args?.region;
resourceInputs["resourceId"] = args?.resourceId;
resourceInputs["scalableDimension"] = args?.scalableDimension;
resourceInputs["serviceNamespace"] = args?.serviceNamespace;
resourceInputs["stepScalingPolicyConfiguration"] = args?.stepScalingPolicyConfiguration;
resourceInputs["targetTrackingScalingPolicyConfiguration"] = args?.targetTrackingScalingPolicyConfiguration;
resourceInputs["alarmArns"] = undefined /*out*/;
resourceInputs["arn"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Policy.__pulumiType, name, resourceInputs, opts);
}
}
exports.Policy = Policy;
/** @internal */
Policy.__pulumiType = 'aws:appautoscaling/policy:Policy';
//# sourceMappingURL=policy.js.map