appautoscaling

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.appautoscaling.Policy(resource_name, opts=None, alarms=None, name=None, policy_type=None, resource_id=None, scalable_dimension=None, service_namespace=None, step_scaling_policy_configuration=None, target_tracking_scaling_policy_configuration=None, __props__=None, __name__=None, __opts__=None)

Provides an Application AutoScaling Policy resource.

  • target_value - (Required) The target value for the metric.

  • disable_scale_in - (Optional) Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

  • scale_in_cooldown - (Optional) The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

  • scale_out_cooldown - (Optional) The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

  • customized_metric_specification - (Optional) A custom CloudWatch metric. Documentation can be found at: AWS Customized Metric Specification. See supported fields below.

  • predefined_metric_specification - (Optional) A predefined metric. See supported fields below.

  • dimensions - (Optional) The dimensions of the metric.

  • metric_name - (Required) The name of the metric.

  • namespace - (Required) The namespace of the metric.

  • statistic - (Required) The statistic of the metric.

  • unit - (Optional) The unit of the metric.

  • predefined_metric_type - (Required) The metric type.

  • resource_label - (Optional) Reserved for future use.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the policy.

  • policy_type (pulumi.Input[str]) – 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.

  • resource_id (pulumi.Input[str]) – 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

  • scalable_dimension (pulumi.Input[str]) –

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

  • service_namespace (pulumi.Input[str]) –

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

  • step_scaling_policy_configuration (pulumi.Input[dict]) – Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

  • target_tracking_scaling_policy_configuration (pulumi.Input[dict]) – A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

The step_scaling_policy_configuration object supports the following:

  • adjustmentType (pulumi.Input[str])

  • cooldown (pulumi.Input[float])

  • metricAggregationType (pulumi.Input[str])

  • minAdjustmentMagnitude (pulumi.Input[float])

  • stepAdjustments (pulumi.Input[list])

    • metricIntervalLowerBound (pulumi.Input[str])

    • metricIntervalUpperBound (pulumi.Input[str])

    • scalingAdjustment (pulumi.Input[float])

The target_tracking_scaling_policy_configuration object supports the following:

  • customizedMetricSpecification (pulumi.Input[dict])

    • dimensions (pulumi.Input[list])

      • name (pulumi.Input[str]) - The name of the policy.

      • value (pulumi.Input[str])

    • metricName (pulumi.Input[str])

    • namespace (pulumi.Input[str])

    • statistic (pulumi.Input[str])

    • unit (pulumi.Input[str])

  • disableScaleIn (pulumi.Input[bool])

  • predefinedMetricSpecification (pulumi.Input[dict])

    • predefinedMetricType (pulumi.Input[str])

    • resourceLabel (pulumi.Input[str])

  • scaleInCooldown (pulumi.Input[float])

  • scaleOutCooldown (pulumi.Input[float])

  • targetValue (pulumi.Input[float])

arn = None

The ARN assigned by AWS to the scaling policy.

name = None

The name of the policy.

policy_type = None

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.

resource_id = None

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

scalable_dimension = None

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

service_namespace = None

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

step_scaling_policy_configuration = None

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

  • adjustmentType (str)

  • cooldown (float)

  • metricAggregationType (str)

  • minAdjustmentMagnitude (float)

  • stepAdjustments (list)

    • metricIntervalLowerBound (str)

    • metricIntervalUpperBound (str)

    • scalingAdjustment (float)

target_tracking_scaling_policy_configuration = None

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

  • customizedMetricSpecification (dict)

    • dimensions (list)

      • name (str) - The name of the policy.

      • value (str)

    • metricName (str)

    • namespace (str)

    • statistic (str)

    • unit (str)

  • disableScaleIn (bool)

  • predefinedMetricSpecification (dict)

    • predefinedMetricType (str)

    • resourceLabel (str)

  • scaleInCooldown (float)

  • scaleOutCooldown (float)

  • targetValue (float)

static get(resource_name, id, opts=None, alarms=None, arn=None, name=None, policy_type=None, resource_id=None, scalable_dimension=None, service_namespace=None, step_scaling_policy_configuration=None, target_tracking_scaling_policy_configuration=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN assigned by AWS to the scaling policy.

  • name (pulumi.Input[str]) – The name of the policy.

  • policy_type (pulumi.Input[str]) – 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.

  • resource_id (pulumi.Input[str]) –

    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

  • scalable_dimension (pulumi.Input[str]) –

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

  • service_namespace (pulumi.Input[str]) –

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

  • step_scaling_policy_configuration (pulumi.Input[dict]) – Step scaling policy configuration, requires policy_type = "StepScaling" (default). See supported fields below.

  • target_tracking_scaling_policy_configuration (pulumi.Input[dict]) – A target tracking policy, requires policy_type = "TargetTrackingScaling". See supported fields below.

The step_scaling_policy_configuration object supports the following:

  • adjustmentType (pulumi.Input[str])

  • cooldown (pulumi.Input[float])

  • metricAggregationType (pulumi.Input[str])

  • minAdjustmentMagnitude (pulumi.Input[float])

  • stepAdjustments (pulumi.Input[list])

    • metricIntervalLowerBound (pulumi.Input[str])

    • metricIntervalUpperBound (pulumi.Input[str])

    • scalingAdjustment (pulumi.Input[float])

The target_tracking_scaling_policy_configuration object supports the following:

  • customizedMetricSpecification (pulumi.Input[dict])

    • dimensions (pulumi.Input[list])

      • name (pulumi.Input[str]) - The name of the policy.

      • value (pulumi.Input[str])

    • metricName (pulumi.Input[str])

    • namespace (pulumi.Input[str])

    • statistic (pulumi.Input[str])

    • unit (pulumi.Input[str])

  • disableScaleIn (pulumi.Input[bool])

  • predefinedMetricSpecification (pulumi.Input[dict])

    • predefinedMetricType (pulumi.Input[str])

    • resourceLabel (pulumi.Input[str])

  • scaleInCooldown (pulumi.Input[float])

  • scaleOutCooldown (pulumi.Input[float])

  • targetValue (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.appautoscaling.ScheduledAction(resource_name, opts=None, end_time=None, name=None, resource_id=None, scalable_dimension=None, scalable_target_action=None, schedule=None, service_namespace=None, start_time=None, __props__=None, __name__=None, __opts__=None)

Provides an Application AutoScaling ScheduledAction resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • end_time (pulumi.Input[str]) – The date and time for the scheduled action to end. Specify the following format: 2006-01-02T15:04:05Z

  • name (pulumi.Input[str]) – The name of the scheduled action.

  • resource_id (pulumi.Input[str]) –

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

  • scalable_dimension (pulumi.Input[str]) –

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

  • scalable_target_action (pulumi.Input[dict]) – The new minimum and maximum capacity. You can set both values or just one. See below

  • schedule (pulumi.Input[str]) –

    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

  • service_namespace (pulumi.Input[str]) –

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

  • start_time (pulumi.Input[str]) – The date and time for the scheduled action to start. Specify the following format: 2006-01-02T15:04:05Z

The scalable_target_action object supports the following:

  • max_capacity (pulumi.Input[float]) - The maximum capacity.

  • min_capacity (pulumi.Input[float]) - The minimum capacity.

arn = None

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

end_time = None

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

name = None

The name of the scheduled action.

resource_id = None

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

scalable_dimension = None

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

scalable_target_action = None

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

  • max_capacity (float) - The maximum capacity.

  • min_capacity (float) - The minimum capacity.

schedule = None

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

service_namespace = None

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

start_time = None

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

static get(resource_name, id, opts=None, arn=None, end_time=None, name=None, resource_id=None, scalable_dimension=None, scalable_target_action=None, schedule=None, service_namespace=None, start_time=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the scheduled action.

  • end_time (pulumi.Input[str]) – The date and time for the scheduled action to end. Specify the following format: 2006-01-02T15:04:05Z

  • name (pulumi.Input[str]) – The name of the scheduled action.

  • resource_id (pulumi.Input[str]) –

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

  • scalable_dimension (pulumi.Input[str]) –

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

  • scalable_target_action (pulumi.Input[dict]) – The new minimum and maximum capacity. You can set both values or just one. See below

  • schedule (pulumi.Input[str]) –

    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

  • service_namespace (pulumi.Input[str]) –

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

  • start_time (pulumi.Input[str]) – The date and time for the scheduled action to start. Specify the following format: 2006-01-02T15:04:05Z

The scalable_target_action object supports the following:

  • max_capacity (pulumi.Input[float]) - The maximum capacity.

  • min_capacity (pulumi.Input[float]) - The minimum capacity.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.appautoscaling.Target(resource_name, opts=None, max_capacity=None, min_capacity=None, resource_id=None, role_arn=None, scalable_dimension=None, service_namespace=None, __props__=None, __name__=None, __opts__=None)

Provides an Application AutoScaling ScalableTarget resource. To manage policies which get attached to the target, see the ``appautoscaling.Policy` resource <https://www.terraform.io/docs/providers/aws/r/appautoscaling_policy.html>`_.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • max_capacity (pulumi.Input[float]) – The max capacity of the scalable target.

  • min_capacity (pulumi.Input[float]) – The min capacity of the scalable target.

  • resource_id (pulumi.Input[str]) –

    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

  • role_arn (pulumi.Input[str]) – The ARN of the IAM role that allows Application AutoScaling to modify your scalable target on your behalf.

  • scalable_dimension (pulumi.Input[str]) –

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

  • service_namespace (pulumi.Input[str]) –

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

max_capacity = None

The max capacity of the scalable target.

min_capacity = None

The min capacity of the scalable target.

resource_id = None

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

role_arn = None

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

scalable_dimension = None

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

service_namespace = None

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

static get(resource_name, id, opts=None, max_capacity=None, min_capacity=None, resource_id=None, role_arn=None, scalable_dimension=None, service_namespace=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • max_capacity (pulumi.Input[float]) – The max capacity of the scalable target.

  • min_capacity (pulumi.Input[float]) – The min capacity of the scalable target.

  • resource_id (pulumi.Input[str]) –

    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

  • role_arn (pulumi.Input[str]) – The ARN of the IAM role that allows Application AutoScaling to modify your scalable target on your behalf.

  • scalable_dimension (pulumi.Input[str]) –

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

  • service_namespace (pulumi.Input[str]) –

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str