Class: AWSCDK::Autoscaling::CfnScalingPolicy

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSAutoscaling::IScalingPolicyRef
Defined in:
autoscaling/cfn_scaling_policy.rb

Overview

The AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.

For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic scaling and Predictive scaling in the Amazon EC2 Auto Scaling User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnScalingPolicy

Create a new AWS::AutoScaling::ScalingPolicy.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Autoscaling::CfnScalingPolicyProps) —

    Resource properties.



19
20
21
22
23
24
25
 
# File 'autoscaling/cfn_scaling_policy.rb', line 19

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Autoscaling::CfnScalingPolicyProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXV0b3NjYWxpbmcuQ2ZuU2NhbGluZ1BvbGljeVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_scaling_policy(resource) ⇒ String

Parameters:

Returns:

  • (String) 


83
84
85
86
 
# File 'autoscaling/cfn_scaling_policy.rb', line 83

def self.arn_for_scaling_policy(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hdXRvc2NhbGluZy5JU2NhbGluZ1BvbGljeVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_autoscaling.CfnScalingPolicy", "arnForScalingPolicy", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


190
191
192
 
# File 'autoscaling/cfn_scaling_policy.rb', line 190

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_autoscaling.CfnScalingPolicy", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_scaling_policy(x) ⇒ Boolean

Checks whether the given object is a CfnScalingPolicy.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'autoscaling/cfn_scaling_policy.rb', line 92

def self.is_cfn_scaling_policy(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_autoscaling.CfnScalingPolicy", "isCfnScalingPolicy", [x])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'autoscaling/cfn_scaling_policy.rb', line 27

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_policy_name => { kind: :property, name: "attrPolicyName", is_optional: false },
    :scaling_policy_ref => { kind: :property, name: "scalingPolicyRef", is_optional: false },
    :auto_scaling_group_name => { kind: :property, name: "autoScalingGroupName", is_optional: false },
    :adjustment_type => { kind: :property, name: "adjustmentType", is_optional: true },
    :cooldown => { kind: :property, name: "cooldown", is_optional: true },
    :estimated_instance_warmup => { kind: :property, name: "estimatedInstanceWarmup", is_optional: true },
    :metric_aggregation_type => { kind: :property, name: "metricAggregationType", is_optional: true },
    :min_adjustment_magnitude => { kind: :property, name: "minAdjustmentMagnitude", is_optional: true },
    :policy_type => { kind: :property, name: "policyType", is_optional: true },
    :predictive_scaling_configuration => { kind: :property, name: "predictiveScalingConfiguration", is_optional: true },
    :scaling_adjustment => { kind: :property, name: "scalingAdjustment", is_optional: true },
    :step_adjustments => { kind: :property, name: "stepAdjustments", is_optional: true },
    :target_tracking_configuration => { kind: :property, name: "targetTrackingConfiguration", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



389
390
391
392
 
# File 'autoscaling/cfn_scaling_policy.rb', line 389

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



401
402
403
404
 
# File 'autoscaling/cfn_scaling_policy.rb', line 401

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



411
412
413
414
 
# File 'autoscaling/cfn_scaling_policy.rb', line 411

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



422
423
424
425
426
 
# File 'autoscaling/cfn_scaling_policy.rb', line 422

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


479
480
481
482
483
 
# File 'autoscaling/cfn_scaling_policy.rb', line 479

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



489
490
491
492
 
# File 'autoscaling/cfn_scaling_policy.rb', line 489

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



501
502
503
504
505
 
# File 'autoscaling/cfn_scaling_policy.rb', line 501

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#adjustment_type ⇒ String?

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).

Returns:

  • (String, nil) 


230
231
232
 
# File 'autoscaling/cfn_scaling_policy.rb', line 230

def adjustment_type()
  jsii_get_property("adjustmentType")
end

#adjustment_type=(value) ⇒ Object 



234
235
236
237
 
# File 'autoscaling/cfn_scaling_policy.rb', line 234

def adjustment_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "adjustmentType") unless value.nil?
  jsii_set_property("adjustmentType", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



514
515
516
517
 
# File 'autoscaling/cfn_scaling_policy.rb', line 514

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



536
537
538
539
540
541
 
# File 'autoscaling/cfn_scaling_policy.rb', line 536

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

Returns the ARN of a scaling policy.

Returns:

  • (String) 


197
198
199
 
# File 'autoscaling/cfn_scaling_policy.rb', line 197

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_policy_name ⇒ String

Returns the name of a scaling policy.

Returns:

  • (String) 


204
205
206
 
# File 'autoscaling/cfn_scaling_policy.rb', line 204

def attr_policy_name()
  jsii_get_property("attrPolicyName")
end

#auto_scaling_group_name ⇒ String

The name of the Auto Scaling group.

Returns:

  • (String) 


218
219
220
 
# File 'autoscaling/cfn_scaling_policy.rb', line 218

def auto_scaling_group_name()
  jsii_get_property("autoScalingGroupName")
end

#auto_scaling_group_name=(value) ⇒ Object 



222
223
224
225
 
# File 'autoscaling/cfn_scaling_policy.rb', line 222

def auto_scaling_group_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "autoScalingGroupName")
  jsii_set_property("autoScalingGroupName", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



143
144
145
 
# File 'autoscaling/cfn_scaling_policy.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


148
149
150
 
# File 'autoscaling/cfn_scaling_policy.rb', line 148

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


545
546
547
548
 
# File 'autoscaling/cfn_scaling_policy.rb', line 545

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


153
154
155
 
# File 'autoscaling/cfn_scaling_policy.rb', line 153

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


160
161
162
 
# File 'autoscaling/cfn_scaling_policy.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cooldown ⇒ String?

A cooldown period, in seconds, that applies to a specific simple scaling policy.

Returns:

  • (String, nil) 


242
243
244
 
# File 'autoscaling/cfn_scaling_policy.rb', line 242

def cooldown()
  jsii_get_property("cooldown")
end

#cooldown=(value) ⇒ Object 



246
247
248
249
 
# File 'autoscaling/cfn_scaling_policy.rb', line 246

def cooldown=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cooldown") unless value.nil?
  jsii_set_property("cooldown", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


105
106
107
 
# File 'autoscaling/cfn_scaling_policy.rb', line 105

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



165
166
167
 
# File 'autoscaling/cfn_scaling_policy.rb', line 165

def env()
  jsii_get_property("env")
end

#estimated_instance_warmup ⇒ Numeric?

Not needed if the default instance warmup is defined for the group..

Returns:

  • (Numeric, nil) 


254
255
256
 
# File 'autoscaling/cfn_scaling_policy.rb', line 254

def estimated_instance_warmup()
  jsii_get_property("estimatedInstanceWarmup")
end

#estimated_instance_warmup=(value) ⇒ Object 



258
259
260
261
 
# File 'autoscaling/cfn_scaling_policy.rb', line 258

def estimated_instance_warmup=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "estimatedInstanceWarmup") unless value.nil?
  jsii_set_property("estimatedInstanceWarmup", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



558
559
560
561
562
 
# File 'autoscaling/cfn_scaling_policy.rb', line 558

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



569
570
571
572
 
# File 'autoscaling/cfn_scaling_policy.rb', line 569

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



639
640
641
642
 
# File 'autoscaling/cfn_scaling_policy.rb', line 639

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


117
118
119
 
# File 'autoscaling/cfn_scaling_policy.rb', line 117

def logical_id()
  jsii_get_property("logicalId")
end

#metric_aggregation_type ⇒ String?

The aggregation type for the CloudWatch metrics.

Returns:

  • (String, nil) 


266
267
268
 
# File 'autoscaling/cfn_scaling_policy.rb', line 266

def metric_aggregation_type()
  jsii_get_property("metricAggregationType")
end

#metric_aggregation_type=(value) ⇒ Object 



270
271
272
273
 
# File 'autoscaling/cfn_scaling_policy.rb', line 270

def metric_aggregation_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricAggregationType") unless value.nil?
  jsii_set_property("metricAggregationType", value)
end

#min_adjustment_magnitude ⇒ Numeric?

The minimum value to scale by when the adjustment type is PercentChangeInCapacity .

Returns:

  • (Numeric, nil) 


278
279
280
 
# File 'autoscaling/cfn_scaling_policy.rb', line 278

def min_adjustment_magnitude()
  jsii_get_property("minAdjustmentMagnitude")
end

#min_adjustment_magnitude=(value) ⇒ Object 



282
283
284
285
 
# File 'autoscaling/cfn_scaling_policy.rb', line 282

def min_adjustment_magnitude=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minAdjustmentMagnitude") unless value.nil?
  jsii_set_property("minAdjustmentMagnitude", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


100
101
102
 
# File 'autoscaling/cfn_scaling_policy.rb', line 100

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



580
581
582
 
# File 'autoscaling/cfn_scaling_policy.rb', line 580

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



587
588
589
 
# File 'autoscaling/cfn_scaling_policy.rb', line 587

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



380
381
382
383
 
# File 'autoscaling/cfn_scaling_policy.rb', line 380

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#policy_type ⇒ String?

One of the following policy types:.

Returns:

  • (String, nil) 


290
291
292
 
# File 'autoscaling/cfn_scaling_policy.rb', line 290

def policy_type()
  jsii_get_property("policyType")
end

#policy_type=(value) ⇒ Object 



294
295
296
297
 
# File 'autoscaling/cfn_scaling_policy.rb', line 294

def policy_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyType") unless value.nil?
  jsii_set_property("policyType", value)
end

#predictive_scaling_configuration ⇒ AWSCDK::IResolvable, ...

A predictive scaling policy.

Provides support for predefined and custom metrics.

Returns:



304
305
306
 
# File 'autoscaling/cfn_scaling_policy.rb', line 304

def predictive_scaling_configuration()
  jsii_get_property("predictiveScalingConfiguration")
end

#predictive_scaling_configuration=(value) ⇒ Object 



308
309
310
311
312
 
# File 'autoscaling/cfn_scaling_policy.rb', line 308

def predictive_scaling_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Autoscaling::CfnScalingPolicy::PredictiveScalingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hdXRvc2NhbGluZy5DZm5TY2FsaW5nUG9saWN5LlByZWRpY3RpdmVTY2FsaW5nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "predictiveScalingConfiguration") unless value.nil?
  jsii_set_property("predictiveScalingConfiguration", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


136
137
138
 
# File 'autoscaling/cfn_scaling_policy.rb', line 136

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



598
599
600
601
 
# File 'autoscaling/cfn_scaling_policy.rb', line 598

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


605
606
607
608
 
# File 'autoscaling/cfn_scaling_policy.rb', line 605

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



615
616
617
618
619
 
# File 'autoscaling/cfn_scaling_policy.rb', line 615

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#scaling_adjustment ⇒ Numeric?

The amount by which to scale, based on the specified adjustment type.

Returns:

  • (Numeric, nil) 


317
318
319
 
# File 'autoscaling/cfn_scaling_policy.rb', line 317

def scaling_adjustment()
  jsii_get_property("scalingAdjustment")
end

#scaling_adjustment=(value) ⇒ Object 



321
322
323
324
 
# File 'autoscaling/cfn_scaling_policy.rb', line 321

def scaling_adjustment=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "scalingAdjustment") unless value.nil?
  jsii_set_property("scalingAdjustment", value)
end

#scaling_policy_ref ⇒ AWSCDK::Interfaces::AWSAutoscaling::ScalingPolicyReference

A reference to a ScalingPolicy resource.

Returns:



211
212
213
 
# File 'autoscaling/cfn_scaling_policy.rb', line 211

def scaling_policy_ref()
  jsii_get_property("scalingPolicyRef")
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



624
625
626
 
# File 'autoscaling/cfn_scaling_policy.rb', line 624

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



126
127
128
 
# File 'autoscaling/cfn_scaling_policy.rb', line 126

def stack()
  jsii_get_property("stack")
end

#step_adjustments ⇒ AWSCDK::IResolvable, ...

A set of adjustments that enable you to scale based on the size of the alarm breach.

Returns:



329
330
331
 
# File 'autoscaling/cfn_scaling_policy.rb', line 329

def step_adjustments()
  jsii_get_property("stepAdjustments")
end

#step_adjustments=(value) ⇒ Object 



333
334
335
336
 
# File 'autoscaling/cfn_scaling_policy.rb', line 333

def step_adjustments=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXV0b3NjYWxpbmcuQ2ZuU2NhbGluZ1BvbGljeS5TdGVwQWRqdXN0bWVudFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "stepAdjustments") unless value.nil?
  jsii_set_property("stepAdjustments", value)
end

#target_tracking_configuration ⇒ AWSCDK::IResolvable, ...

A target tracking scaling policy.

Provides support for predefined or custom metrics.

Returns:



343
344
345
 
# File 'autoscaling/cfn_scaling_policy.rb', line 343

def target_tracking_configuration()
  jsii_get_property("targetTrackingConfiguration")
end

#target_tracking_configuration=(value) ⇒ Object 



347
348
349
350
351
 
# File 'autoscaling/cfn_scaling_policy.rb', line 347

def target_tracking_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Autoscaling::CfnScalingPolicy::TargetTrackingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hdXRvc2NhbGluZy5DZm5TY2FsaW5nUG9saWN5LlRhcmdldFRyYWNraW5nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "targetTrackingConfiguration") unless value.nil?
  jsii_set_property("targetTrackingConfiguration", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



356
357
358
 
# File 'autoscaling/cfn_scaling_policy.rb', line 356

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


173
174
175
 
# File 'autoscaling/cfn_scaling_policy.rb', line 173

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


183
184
185
 
# File 'autoscaling/cfn_scaling_policy.rb', line 183

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


630
631
632
633
 
# File 'autoscaling/cfn_scaling_policy.rb', line 630

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


369
370
371
372
373
374
 
# File 'autoscaling/cfn_scaling_policy.rb', line 369

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end