CfnScalingPlan

class aws_cdk.aws_autoscalingplans.CfnScalingPlan(scope, id, *, application_source, scaling_instructions)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::AutoScalingPlans::ScalingPlan.

CloudformationResource

AWS::AutoScalingPlans::ScalingPlan

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html

Create a new AWS::AutoScalingPlans::ScalingPlan.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

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

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride 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. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

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

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

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

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AutoScalingPlans::ScalingPlan'
application_source

AWS::AutoScalingPlans::ScalingPlan.ApplicationSource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-applicationsource

Return type

Union[ApplicationSourceProperty, IResolvable]

attr_scaling_plan_name

ScalingPlanName

Type

cloudformationAttribute

Return type

str

attr_scaling_plan_version

ScalingPlanVersion

Type

cloudformationAttribute

Return type

str

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

logical_id

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 overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

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 }).

Return type

str

scaling_instructions

AWS::AutoScalingPlans::ScalingPlan.ScalingInstructions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-scalinginstructions

Return type

Union[IResolvable, List[Union[IResolvable, ScalingInstructionProperty]]]

stack

The stack in which this element is defined.

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

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ApplicationSourceProperty

class CfnScalingPlan.ApplicationSourceProperty(*, cloud_formation_stack_arn=None, tag_filters=None)

Bases: object

Parameters
  • cloud_formation_stack_arn (Optional[str]) – CfnScalingPlan.ApplicationSourceProperty.CloudFormationStackARN.

  • tag_filters (Union[IResolvable, Sequence[Union[IResolvable, TagFilterProperty]], None]) – CfnScalingPlan.ApplicationSourceProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html

Attributes

cloud_formation_stack_arn

CfnScalingPlan.ApplicationSourceProperty.CloudFormationStackARN.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html#cfn-autoscalingplans-scalingplan-applicationsource-cloudformationstackarn

Return type

Optional[str]

tag_filters

CfnScalingPlan.ApplicationSourceProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html#cfn-autoscalingplans-scalingplan-applicationsource-tagfilters

Return type

Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]

CustomizedLoadMetricSpecificationProperty

class CfnScalingPlan.CustomizedLoadMetricSpecificationProperty(*, metric_name, namespace, statistic, dimensions=None, unit=None)

Bases: object

Parameters
  • metric_name (str) – CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.MetricName.

  • namespace (str) – CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Namespace.

  • statistic (str) – CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Statistic.

  • dimensions (Union[IResolvable, Sequence[Union[IResolvable, MetricDimensionProperty]], None]) – CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Dimensions.

  • unit (Optional[str]) – CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Unit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html

Attributes

dimensions

CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Dimensions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-dimensions

Return type

Union[IResolvable, List[Union[IResolvable, MetricDimensionProperty]], None]

metric_name

CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.MetricName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-metricname

Return type

str

namespace

CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Namespace.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-namespace

Return type

str

statistic

CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Statistic.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-statistic

Return type

str

unit

CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Unit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-unit

Return type

Optional[str]

CustomizedScalingMetricSpecificationProperty

class CfnScalingPlan.CustomizedScalingMetricSpecificationProperty(*, metric_name, namespace, statistic, dimensions=None, unit=None)

Bases: object

Parameters
  • metric_name (str) – CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.MetricName.

  • namespace (str) – CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Namespace.

  • statistic (str) – CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Statistic.

  • dimensions (Union[IResolvable, Sequence[Union[IResolvable, MetricDimensionProperty]], None]) – CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Dimensions.

  • unit (Optional[str]) – CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Unit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html

Attributes

dimensions

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Dimensions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-dimensions

Return type

Union[IResolvable, List[Union[IResolvable, MetricDimensionProperty]], None]

metric_name

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.MetricName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-metricname

Return type

str

namespace

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Namespace.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-namespace

Return type

str

statistic

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Statistic.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-statistic

Return type

str

unit

CfnScalingPlan.CustomizedScalingMetricSpecificationProperty.Unit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-unit

Return type

Optional[str]

MetricDimensionProperty

class CfnScalingPlan.MetricDimensionProperty(*, name, value)

Bases: object

Parameters
  • name (str) – CfnScalingPlan.MetricDimensionProperty.Name.

  • value (str) – CfnScalingPlan.MetricDimensionProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html

Attributes

name

CfnScalingPlan.MetricDimensionProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html#cfn-autoscalingplans-scalingplan-metricdimension-name

Return type

str

value

CfnScalingPlan.MetricDimensionProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html#cfn-autoscalingplans-scalingplan-metricdimension-value

Return type

str

PredefinedLoadMetricSpecificationProperty

class CfnScalingPlan.PredefinedLoadMetricSpecificationProperty(*, predefined_load_metric_type, resource_label=None)

Bases: object

Parameters
  • predefined_load_metric_type (str) – CfnScalingPlan.PredefinedLoadMetricSpecificationProperty.PredefinedLoadMetricType.

  • resource_label (Optional[str]) – CfnScalingPlan.PredefinedLoadMetricSpecificationProperty.ResourceLabel.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html

Attributes

predefined_load_metric_type

CfnScalingPlan.PredefinedLoadMetricSpecificationProperty.PredefinedLoadMetricType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedloadmetricspecification-predefinedloadmetrictype

Return type

str

resource_label

CfnScalingPlan.PredefinedLoadMetricSpecificationProperty.ResourceLabel.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedloadmetricspecification-resourcelabel

Return type

Optional[str]

PredefinedScalingMetricSpecificationProperty

class CfnScalingPlan.PredefinedScalingMetricSpecificationProperty(*, predefined_scaling_metric_type, resource_label=None)

Bases: object

Parameters
  • predefined_scaling_metric_type (str) – CfnScalingPlan.PredefinedScalingMetricSpecificationProperty.PredefinedScalingMetricType.

  • resource_label (Optional[str]) – CfnScalingPlan.PredefinedScalingMetricSpecificationProperty.ResourceLabel.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html

Attributes

predefined_scaling_metric_type

CfnScalingPlan.PredefinedScalingMetricSpecificationProperty.PredefinedScalingMetricType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-predefinedscalingmetrictype

Return type

str

resource_label

CfnScalingPlan.PredefinedScalingMetricSpecificationProperty.ResourceLabel.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-resourcelabel

Return type

Optional[str]

ScalingInstructionProperty

class CfnScalingPlan.ScalingInstructionProperty(*, max_capacity, min_capacity, resource_id, scalable_dimension, service_namespace, target_tracking_configurations, customized_load_metric_specification=None, disable_dynamic_scaling=None, predefined_load_metric_specification=None, predictive_scaling_max_capacity_behavior=None, predictive_scaling_max_capacity_buffer=None, predictive_scaling_mode=None, scaling_policy_update_behavior=None, scheduled_action_buffer_time=None)

Bases: object

Parameters
  • max_capacity (Union[int, float]) – CfnScalingPlan.ScalingInstructionProperty.MaxCapacity.

  • min_capacity (Union[int, float]) – CfnScalingPlan.ScalingInstructionProperty.MinCapacity.

  • resource_id (str) – CfnScalingPlan.ScalingInstructionProperty.ResourceId.

  • scalable_dimension (str) – CfnScalingPlan.ScalingInstructionProperty.ScalableDimension.

  • service_namespace (str) – CfnScalingPlan.ScalingInstructionProperty.ServiceNamespace.

  • target_tracking_configurations (Union[IResolvable, Sequence[Union[IResolvable, TargetTrackingConfigurationProperty]]]) – CfnScalingPlan.ScalingInstructionProperty.TargetTrackingConfigurations.

  • customized_load_metric_specification (Union[IResolvable, CustomizedLoadMetricSpecificationProperty, None]) – CfnScalingPlan.ScalingInstructionProperty.CustomizedLoadMetricSpecification.

  • disable_dynamic_scaling (Union[bool, IResolvable, None]) – CfnScalingPlan.ScalingInstructionProperty.DisableDynamicScaling.

  • predefined_load_metric_specification (Union[IResolvable, PredefinedLoadMetricSpecificationProperty, None]) – CfnScalingPlan.ScalingInstructionProperty.PredefinedLoadMetricSpecification.

  • predictive_scaling_max_capacity_behavior (Optional[str]) – CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMaxCapacityBehavior.

  • predictive_scaling_max_capacity_buffer (Union[int, float, None]) – CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMaxCapacityBuffer.

  • predictive_scaling_mode (Optional[str]) – CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMode.

  • scaling_policy_update_behavior (Optional[str]) – CfnScalingPlan.ScalingInstructionProperty.ScalingPolicyUpdateBehavior.

  • scheduled_action_buffer_time (Union[int, float, None]) – CfnScalingPlan.ScalingInstructionProperty.ScheduledActionBufferTime.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html

Attributes

customized_load_metric_specification

CfnScalingPlan.ScalingInstructionProperty.CustomizedLoadMetricSpecification.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-customizedloadmetricspecification

Return type

Union[IResolvable, CustomizedLoadMetricSpecificationProperty, None]

disable_dynamic_scaling

CfnScalingPlan.ScalingInstructionProperty.DisableDynamicScaling.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-disabledynamicscaling

Return type

Union[bool, IResolvable, None]

max_capacity

CfnScalingPlan.ScalingInstructionProperty.MaxCapacity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-maxcapacity

Return type

Union[int, float]

min_capacity

CfnScalingPlan.ScalingInstructionProperty.MinCapacity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-mincapacity

Return type

Union[int, float]

predefined_load_metric_specification

CfnScalingPlan.ScalingInstructionProperty.PredefinedLoadMetricSpecification.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predefinedloadmetricspecification

Return type

Union[IResolvable, PredefinedLoadMetricSpecificationProperty, None]

predictive_scaling_max_capacity_behavior

CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMaxCapacityBehavior.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmaxcapacitybehavior

Return type

Optional[str]

predictive_scaling_max_capacity_buffer

CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMaxCapacityBuffer.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmaxcapacitybuffer

Return type

Union[int, float, None]

predictive_scaling_mode

CfnScalingPlan.ScalingInstructionProperty.PredictiveScalingMode.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmode

Return type

Optional[str]

resource_id

CfnScalingPlan.ScalingInstructionProperty.ResourceId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-resourceid

Return type

str

scalable_dimension

CfnScalingPlan.ScalingInstructionProperty.ScalableDimension.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalabledimension

Return type

str

scaling_policy_update_behavior

CfnScalingPlan.ScalingInstructionProperty.ScalingPolicyUpdateBehavior.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalingpolicyupdatebehavior

Return type

Optional[str]

scheduled_action_buffer_time

CfnScalingPlan.ScalingInstructionProperty.ScheduledActionBufferTime.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scheduledactionbuffertime

Return type

Union[int, float, None]

service_namespace

CfnScalingPlan.ScalingInstructionProperty.ServiceNamespace.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-servicenamespace

Return type

str

target_tracking_configurations

CfnScalingPlan.ScalingInstructionProperty.TargetTrackingConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-targettrackingconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, TargetTrackingConfigurationProperty]]]

TagFilterProperty

class CfnScalingPlan.TagFilterProperty(*, key, values=None)

Bases: object

Parameters
  • key (str) – CfnScalingPlan.TagFilterProperty.Key.

  • values (Optional[Sequence[str]]) – CfnScalingPlan.TagFilterProperty.Values.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html

Attributes

key

CfnScalingPlan.TagFilterProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html#cfn-autoscalingplans-scalingplan-tagfilter-key

Return type

str

values

CfnScalingPlan.TagFilterProperty.Values.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html#cfn-autoscalingplans-scalingplan-tagfilter-values

Return type

Optional[List[str]]

TargetTrackingConfigurationProperty

class CfnScalingPlan.TargetTrackingConfigurationProperty(*, target_value, customized_scaling_metric_specification=None, disable_scale_in=None, estimated_instance_warmup=None, predefined_scaling_metric_specification=None, scale_in_cooldown=None, scale_out_cooldown=None)

Bases: object

Parameters
  • target_value (Union[int, float]) – CfnScalingPlan.TargetTrackingConfigurationProperty.TargetValue.

  • customized_scaling_metric_specification (Union[IResolvable, CustomizedScalingMetricSpecificationProperty, None]) – CfnScalingPlan.TargetTrackingConfigurationProperty.CustomizedScalingMetricSpecification.

  • disable_scale_in (Union[bool, IResolvable, None]) – CfnScalingPlan.TargetTrackingConfigurationProperty.DisableScaleIn.

  • estimated_instance_warmup (Union[int, float, None]) – CfnScalingPlan.TargetTrackingConfigurationProperty.EstimatedInstanceWarmup.

  • predefined_scaling_metric_specification (Union[IResolvable, PredefinedScalingMetricSpecificationProperty, None]) – CfnScalingPlan.TargetTrackingConfigurationProperty.PredefinedScalingMetricSpecification.

  • scale_in_cooldown (Union[int, float, None]) – CfnScalingPlan.TargetTrackingConfigurationProperty.ScaleInCooldown.

  • scale_out_cooldown (Union[int, float, None]) – CfnScalingPlan.TargetTrackingConfigurationProperty.ScaleOutCooldown.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html

Attributes

customized_scaling_metric_specification

CfnScalingPlan.TargetTrackingConfigurationProperty.CustomizedScalingMetricSpecification.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-customizedscalingmetricspecification

Return type

Union[IResolvable, CustomizedScalingMetricSpecificationProperty, None]

disable_scale_in

CfnScalingPlan.TargetTrackingConfigurationProperty.DisableScaleIn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-disablescalein

Return type

Union[bool, IResolvable, None]

estimated_instance_warmup

CfnScalingPlan.TargetTrackingConfigurationProperty.EstimatedInstanceWarmup.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-estimatedinstancewarmup

Return type

Union[int, float, None]

predefined_scaling_metric_specification

CfnScalingPlan.TargetTrackingConfigurationProperty.PredefinedScalingMetricSpecification.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-predefinedscalingmetricspecification

Return type

Union[IResolvable, PredefinedScalingMetricSpecificationProperty, None]

scale_in_cooldown

CfnScalingPlan.TargetTrackingConfigurationProperty.ScaleInCooldown.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleincooldown

Return type

Union[int, float, None]

scale_out_cooldown

CfnScalingPlan.TargetTrackingConfigurationProperty.ScaleOutCooldown.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleoutcooldown

Return type

Union[int, float, None]

target_value

CfnScalingPlan.TargetTrackingConfigurationProperty.TargetValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-targetvalue

Return type

Union[int, float]