Skip to content

AWS.AutoScaling.ScalingPolicy

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html

Index

Fields

fn new

new(errorOnEmptyProp)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html

fn creationPolicy

creationPolicy(policy)

Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded. To signal a resource, you can use the cfn-signal helper script or SignalResource API. CloudFormation publishes valid signals to the stack events so that you track the number of signals sent. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html

fn creationPolicyMixin

creationPolicyMixin(policy)

cf creationPolicy(), but return a merged object

fn deletionPolicy

deletionPolicy(policy)

With the DeletionPolicy attribute you can preserve, and in some cases, backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html

fn deletionPolicyMixin

deletionPolicyMixin(policy)

cf deletionPolicy(), but return a merged object

fn dependsOn

dependsOn(dependencies)

With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html

fn dependsOnMixin

dependsOnMixin(dependencies)

cf dependsOn(), but return a merged array

fn metadata

metadata(metadatas)

The metadata attribute enables you to associate structured data with a resource. By adding a metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the metadata attribute to add those interpreted values. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html

fn metadataMixin

metadataMixin(metadatas)

cf metadata(), but return a merged object

fn updatePolicy

updatePolicy(policy)

Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AppStream::Fleet, AWS::AutoScaling::AutoScalingGroup, AWS::ElastiCache::ReplicationGroup, AWS::OpenSearchService::Domain, AWS::Elasticsearch::Domain, or AWS::Lambda::Alias resources. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html

fn updatePolicyMixin

updatePolicyMixin(policy)

cf `updatePolicy(), but return a merged object

fn updateReplacePolicy

updateReplacePolicy(policy)

Use the UpdateReplacePolicy attribute to retain or, in some cases, backup the existing physical instance of a resource when it's replaced during a stack update operation. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html

fn updateReplacePolicyMixin

updateReplacePolicyMixin(policy)

cf updateReplacePolicy, but return a merged object

fn withAdjustmentType

withAdjustmentType(adjustmentType)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-adjustmenttype

fn withAutoScalingGroupName

withAutoScalingGroupName(autoScalingGroupName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-autoscalinggroupname

fn withCooldown

withCooldown(cooldown)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-cooldown

fn withEstimatedInstanceWarmup

withEstimatedInstanceWarmup(estimatedInstanceWarmup)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-estimatedinstancewarmup

fn withMetricAggregationType

withMetricAggregationType(metricAggregationType)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-metricaggregationtype

fn withMinAdjustmentMagnitude

withMinAdjustmentMagnitude(minAdjustmentMagnitude)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-minadjustmentmagnitude

fn withPolicyType

withPolicyType(policyType)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-policytype

fn withPredictiveScalingConfiguration

withPredictiveScalingConfiguration(predictiveScalingConfiguration)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration

fn withPredictiveScalingConfigurationMixin

withPredictiveScalingConfigurationMixin(predictiveScalingConfiguration)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration

fn withScalingAdjustment

withScalingAdjustment(scalingAdjustment)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-scalingadjustment

fn withStepAdjustments

withStepAdjustments(stepAdjustments)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-stepadjustments

fn withStepAdjustmentsMixin

withStepAdjustmentsMixin(stepAdjustments)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-stepadjustments

fn withTargetTrackingConfiguration

withTargetTrackingConfiguration(targetTrackingConfiguration)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration

fn withTargetTrackingConfigurationMixin

withTargetTrackingConfigurationMixin(targetTrackingConfiguration)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration