Module appautoscaling

@pulumi/aws > appautoscaling

Index

appautoscaling/policy.ts appautoscaling/scheduledAction.ts appautoscaling/target.ts

class Policy

Provides an Application AutoScaling Policy resource.

constructor

new Policy(name: string, args: PolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a Policy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PolicyState): Policy

Get an existing Policy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property adjustmentType

public adjustmentType: pulumi.Output<string | undefined>;

The scaling policy’s adjustment type.

property alarms

public alarms: pulumi.Output<string[] | undefined>;

property arn

public arn: pulumi.Output<string>;

The ARN assigned by AWS to the scaling policy.

property cooldown

public cooldown: pulumi.Output<number | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property metricAggregationType

public metricAggregationType: pulumi.Output<string | undefined>;

property minAdjustmentMagnitude

public minAdjustmentMagnitude: pulumi.Output<number | undefined>;

property name

public name: pulumi.Output<string>;

The name of the policy.

property policyType

public policyType: pulumi.Output<string | undefined>;

For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling and TargetTrackingScaling are supported. For any other service, only StepScaling is supported. Defaults to StepScaling.

property resourceId

public resourceId: pulumi.Output<string>;

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

property scalableDimension

public scalableDimension: pulumi.Output<string>;

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

property serviceNamespace

public serviceNamespace: pulumi.Output<string>;

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

property stepAdjustments

public stepAdjustments: pulumi.Output<{ ... }[] | undefined>;

property stepScalingPolicyConfigurations

public stepScalingPolicyConfigurations: pulumi.Output<{ ... }[] | undefined>;

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

property targetTrackingScalingPolicyConfiguration

public targetTrackingScalingPolicyConfiguration: pulumi.Output<{ ... } | undefined>;

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ScheduledAction

Provides an Application AutoScaling ScheduledAction resource.

constructor

new ScheduledAction(name: string, args: ScheduledActionArgs, opts?: pulumi.CustomResourceOptions)

Create a ScheduledAction resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ScheduledActionState): ScheduledAction

Get an existing ScheduledAction resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the scheduled action.

property endTime

public endTime: pulumi.Output<string | undefined>;

The date and time for the scheduled action to end. Specify the following format: 2006-01-02T15:04:05Z

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the scheduled action.

property resourceId

public resourceId: pulumi.Output<string>;

The identifier of the resource associated with the scheduled action. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference

property scalableDimension

public scalableDimension: pulumi.Output<string | undefined>;

The scalable dimension. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount

property scalableTargetAction

public scalableTargetAction: pulumi.Output<{ ... } | undefined>;

The new minimum and maximum capacity. You can set both values or just one. See below

property schedule

public schedule: pulumi.Output<string | undefined>;

The schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). In UTC. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference

property serviceNamespace

public serviceNamespace: pulumi.Output<string>;

The namespace of the AWS service. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference Example: ecs

property startTime

public startTime: pulumi.Output<string | undefined>;

The date and time for the scheduled action to start. Specify the following format: 2006-01-02T15:04:05Z

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Target

Provides an Application AutoScaling ScalableTarget resource. To manage policies which get attached to the target, see the aws_appautoscaling_policy resource.

constructor

new Target(name: string, args: TargetArgs, opts?: pulumi.CustomResourceOptions)

Create a Target resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TargetState): Target

Get an existing Target resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maxCapacity

public maxCapacity: pulumi.Output<number>;

The max capacity of the scalable target.

property minCapacity

public minCapacity: pulumi.Output<number>;

The min capacity of the scalable target.

property resourceId

public resourceId: pulumi.Output<string>;

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

property roleArn

public roleArn: pulumi.Output<string>;

The ARN of the IAM role that allows Application AutoScaling to modify your scalable target on your behalf.

property scalableDimension

public scalableDimension: pulumi.Output<string>;

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

property serviceNamespace

public serviceNamespace: pulumi.Output<string>;

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface PolicyArgs

The set of arguments for constructing a Policy resource.

property adjustmentType

adjustmentType?: pulumi.Input<string>;

The scaling policy’s adjustment type.

property alarms

alarms?: pulumi.Input<pulumi.Input<string>[]>;

property cooldown

cooldown?: pulumi.Input<number>;

property metricAggregationType

metricAggregationType?: pulumi.Input<string>;

property minAdjustmentMagnitude

minAdjustmentMagnitude?: pulumi.Input<number>;

property name

name?: pulumi.Input<string>;

The name of the policy.

property policyType

policyType?: pulumi.Input<string>;

For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling and TargetTrackingScaling are supported. For any other service, only StepScaling is supported. Defaults to StepScaling.

property resourceId

resourceId: pulumi.Input<string>;

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

property scalableDimension

scalableDimension: pulumi.Input<string>;

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

property serviceNamespace

serviceNamespace: pulumi.Input<string>;

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

property stepAdjustments

stepAdjustments?: pulumi.Input<pulumi.Input<{ ... }>[]>;

property stepScalingPolicyConfigurations

stepScalingPolicyConfigurations?: pulumi.Input<pulumi.Input<{ ... }>[]>;

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

property targetTrackingScalingPolicyConfiguration

targetTrackingScalingPolicyConfiguration?: pulumi.Input<{ ... }>;

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

interface PolicyState

Input properties used for looking up and filtering Policy resources.

property adjustmentType

adjustmentType?: pulumi.Input<string>;

The scaling policy’s adjustment type.

property alarms

alarms?: pulumi.Input<pulumi.Input<string>[]>;

property arn

arn?: pulumi.Input<string>;

The ARN assigned by AWS to the scaling policy.

property cooldown

cooldown?: pulumi.Input<number>;

property metricAggregationType

metricAggregationType?: pulumi.Input<string>;

property minAdjustmentMagnitude

minAdjustmentMagnitude?: pulumi.Input<number>;

property name

name?: pulumi.Input<string>;

The name of the policy.

property policyType

policyType?: pulumi.Input<string>;

For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling and TargetTrackingScaling are supported. For any other service, only StepScaling is supported. Defaults to StepScaling.

property resourceId

resourceId?: pulumi.Input<string>;

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

property scalableDimension

scalableDimension?: pulumi.Input<string>;

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

property serviceNamespace

serviceNamespace?: pulumi.Input<string>;

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

property stepAdjustments

stepAdjustments?: pulumi.Input<pulumi.Input<{ ... }>[]>;

property stepScalingPolicyConfigurations

stepScalingPolicyConfigurations?: pulumi.Input<pulumi.Input<{ ... }>[]>;

Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

property targetTrackingScalingPolicyConfiguration

targetTrackingScalingPolicyConfiguration?: pulumi.Input<{ ... }>;

A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

interface ScheduledActionArgs

The set of arguments for constructing a ScheduledAction resource.

property endTime

endTime?: pulumi.Input<string>;

The date and time for the scheduled action to end. Specify the following format: 2006-01-02T15:04:05Z

property name

name?: pulumi.Input<string>;

The name of the scheduled action.

property resourceId

resourceId: pulumi.Input<string>;

The identifier of the resource associated with the scheduled action. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference

property scalableDimension

scalableDimension?: pulumi.Input<string>;

The scalable dimension. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount

property scalableTargetAction

scalableTargetAction?: pulumi.Input<{ ... }>;

The new minimum and maximum capacity. You can set both values or just one. See below

property schedule

schedule?: pulumi.Input<string>;

The schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). In UTC. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference

property serviceNamespace

serviceNamespace: pulumi.Input<string>;

The namespace of the AWS service. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference Example: ecs

property startTime

startTime?: pulumi.Input<string>;

The date and time for the scheduled action to start. Specify the following format: 2006-01-02T15:04:05Z

interface ScheduledActionState

Input properties used for looking up and filtering ScheduledAction resources.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the scheduled action.

property endTime

endTime?: pulumi.Input<string>;

The date and time for the scheduled action to end. Specify the following format: 2006-01-02T15:04:05Z

property name

name?: pulumi.Input<string>;

The name of the scheduled action.

property resourceId

resourceId?: pulumi.Input<string>;

The identifier of the resource associated with the scheduled action. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference

property scalableDimension

scalableDimension?: pulumi.Input<string>;

The scalable dimension. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount

property scalableTargetAction

scalableTargetAction?: pulumi.Input<{ ... }>;

The new minimum and maximum capacity. You can set both values or just one. See below

property schedule

schedule?: pulumi.Input<string>;

The schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). In UTC. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference

property serviceNamespace

serviceNamespace?: pulumi.Input<string>;

The namespace of the AWS service. Documentation can be found in the parameter at: AWS Application Auto Scaling API Reference Example: ecs

property startTime

startTime?: pulumi.Input<string>;

The date and time for the scheduled action to start. Specify the following format: 2006-01-02T15:04:05Z

interface TargetArgs

The set of arguments for constructing a Target resource.

property maxCapacity

maxCapacity: pulumi.Input<number>;

The max capacity of the scalable target.

property minCapacity

minCapacity: pulumi.Input<number>;

The min capacity of the scalable target.

property resourceId

resourceId: pulumi.Input<string>;

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

property roleArn

roleArn?: pulumi.Input<string>;

The ARN of the IAM role that allows Application AutoScaling to modify your scalable target on your behalf.

property scalableDimension

scalableDimension: pulumi.Input<string>;

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

property serviceNamespace

serviceNamespace: pulumi.Input<string>;

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference

interface TargetState

Input properties used for looking up and filtering Target resources.

property maxCapacity

maxCapacity?: pulumi.Input<number>;

The max capacity of the scalable target.

property minCapacity

minCapacity?: pulumi.Input<number>;

The min capacity of the scalable target.

property resourceId

resourceId?: pulumi.Input<string>;

The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference

property roleArn

roleArn?: pulumi.Input<string>;

The ARN of the IAM role that allows Application AutoScaling to modify your scalable target on your behalf.

property scalableDimension

scalableDimension?: pulumi.Input<string>;

The scalable dimension of the scalable target. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference

property serviceNamespace

serviceNamespace?: pulumi.Input<string>;

The AWS service namespace of the scalable target. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference