Documentation ¶
Index ¶
- func BaseScalableAttribute_IsConstruct(x interface{}) *bool
- func CfnScalableTarget_CFN_RESOURCE_TYPE_NAME() *string
- func CfnScalableTarget_IsCfnElement(x interface{}) *bool
- func CfnScalableTarget_IsCfnResource(x interface{}) *bool
- func CfnScalableTarget_IsConstruct(x interface{}) *bool
- func CfnScalingPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnScalingPolicy_IsCfnElement(x interface{}) *bool
- func CfnScalingPolicy_IsCfnResource(x interface{}) *bool
- func CfnScalingPolicy_IsConstruct(x interface{}) *bool
- func NewBaseScalableAttribute_Override(b BaseScalableAttribute, scope constructs.Construct, id *string, ...)
- func NewCfnScalableTarget_Override(c CfnScalableTarget, scope constructs.Construct, id *string, ...)
- func NewCfnScalingPolicy_Override(c CfnScalingPolicy, scope constructs.Construct, id *string, ...)
- func NewScalableTarget_Override(s ScalableTarget, scope constructs.Construct, id *string, ...)
- func NewSchedule_Override(s Schedule)
- func NewStepScalingAction_Override(s StepScalingAction, scope constructs.Construct, id *string, ...)
- func NewStepScalingPolicy_Override(s StepScalingPolicy, scope constructs.Construct, id *string, ...)
- func NewTargetTrackingScalingPolicy_Override(t TargetTrackingScalingPolicy, scope constructs.Construct, id *string, ...)
- func ScalableTarget_IsConstruct(x interface{}) *bool
- func ScalableTarget_IsOwnedResource(construct constructs.IConstruct) *bool
- func ScalableTarget_IsResource(construct constructs.IConstruct) *bool
- func StepScalingAction_IsConstruct(x interface{}) *bool
- func StepScalingPolicy_IsConstruct(x interface{}) *bool
- func TargetTrackingScalingPolicy_IsConstruct(x interface{}) *bool
- type AdjustmentTier
- type AdjustmentType
- type BaseScalableAttribute
- type BaseScalableAttributeProps
- type BaseTargetTrackingProps
- type BasicStepScalingPolicyProps
- type BasicTargetTrackingScalingPolicyProps
- type CfnScalableTarget
- type CfnScalableTargetProps
- type CfnScalableTarget_ScalableTargetActionProperty
- type CfnScalableTarget_ScheduledActionProperty
- type CfnScalableTarget_SuspendedStateProperty
- type CfnScalingPolicy
- type CfnScalingPolicyProps
- type CfnScalingPolicy_CustomizedMetricSpecificationProperty
- type CfnScalingPolicy_MetricDimensionProperty
- type CfnScalingPolicy_PredefinedMetricSpecificationProperty
- type CfnScalingPolicy_StepAdjustmentProperty
- type CfnScalingPolicy_StepScalingPolicyConfigurationProperty
- type CfnScalingPolicy_TargetTrackingMetricDataQueryProperty
- type CfnScalingPolicy_TargetTrackingMetricDimensionProperty
- type CfnScalingPolicy_TargetTrackingMetricProperty
- type CfnScalingPolicy_TargetTrackingMetricStatProperty
- type CfnScalingPolicy_TargetTrackingScalingPolicyConfigurationProperty
- type CronOptions
- type EnableScalingProps
- type IScalableTarget
- type MetricAggregationType
- type PredefinedMetric
- type ScalableTarget
- type ScalableTargetProps
- type ScalingInterval
- type ScalingSchedule
- type Schedule
- type ServiceNamespace
- type StepScalingAction
- type StepScalingActionProps
- type StepScalingPolicy
- type StepScalingPolicyProps
- type TargetTrackingScalingPolicy
- type TargetTrackingScalingPolicyProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BaseScalableAttribute_IsConstruct ¶
func BaseScalableAttribute_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnScalableTarget_CFN_RESOURCE_TYPE_NAME ¶
func CfnScalableTarget_CFN_RESOURCE_TYPE_NAME() *string
func CfnScalableTarget_IsCfnElement ¶
func CfnScalableTarget_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnScalableTarget_IsCfnResource ¶
func CfnScalableTarget_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnScalableTarget_IsConstruct ¶
func CfnScalableTarget_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnScalingPolicy_CFN_RESOURCE_TYPE_NAME ¶
func CfnScalingPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnScalingPolicy_IsCfnElement ¶
func CfnScalingPolicy_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnScalingPolicy_IsCfnResource ¶
func CfnScalingPolicy_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnScalingPolicy_IsConstruct ¶
func CfnScalingPolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewBaseScalableAttribute_Override ¶
func NewBaseScalableAttribute_Override(b BaseScalableAttribute, scope constructs.Construct, id *string, props *BaseScalableAttributeProps)
func NewCfnScalableTarget_Override ¶
func NewCfnScalableTarget_Override(c CfnScalableTarget, scope constructs.Construct, id *string, props *CfnScalableTargetProps)
func NewCfnScalingPolicy_Override ¶
func NewCfnScalingPolicy_Override(c CfnScalingPolicy, scope constructs.Construct, id *string, props *CfnScalingPolicyProps)
func NewScalableTarget_Override ¶
func NewScalableTarget_Override(s ScalableTarget, scope constructs.Construct, id *string, props *ScalableTargetProps)
func NewSchedule_Override ¶
func NewSchedule_Override(s Schedule)
func NewStepScalingAction_Override ¶
func NewStepScalingAction_Override(s StepScalingAction, scope constructs.Construct, id *string, props *StepScalingActionProps)
func NewStepScalingPolicy_Override ¶
func NewStepScalingPolicy_Override(s StepScalingPolicy, scope constructs.Construct, id *string, props *StepScalingPolicyProps)
func NewTargetTrackingScalingPolicy_Override ¶
func NewTargetTrackingScalingPolicy_Override(t TargetTrackingScalingPolicy, scope constructs.Construct, id *string, props *TargetTrackingScalingPolicyProps)
func ScalableTarget_IsConstruct ¶
func ScalableTarget_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func ScalableTarget_IsOwnedResource ¶ added in v2.32.0
func ScalableTarget_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func ScalableTarget_IsResource ¶
func ScalableTarget_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func StepScalingAction_IsConstruct ¶
func StepScalingAction_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func StepScalingPolicy_IsConstruct ¶
func StepScalingPolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func TargetTrackingScalingPolicy_IsConstruct ¶
func TargetTrackingScalingPolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
Types ¶
type AdjustmentTier ¶
type AdjustmentTier struct { // What number to adjust the capacity with. // // The number is interpeted as an added capacity, a new fixed capacity or an // added percentage depending on the AdjustmentType value of the // StepScalingPolicy. // // Can be positive or negative. Adjustment *float64 `field:"required" json:"adjustment" yaml:"adjustment"` // Lower bound where this scaling tier applies. // // The scaling tier applies if the difference between the metric // value and its alarm threshold is higher than this value. // Default: -Infinity if this is the first tier, otherwise the upperBound of the previous tier. // LowerBound *float64 `field:"optional" json:"lowerBound" yaml:"lowerBound"` // Upper bound where this scaling tier applies. // // The scaling tier applies if the difference between the metric // value and its alarm threshold is lower than this value. // Default: +Infinity. // UpperBound *float64 `field:"optional" json:"upperBound" yaml:"upperBound"` }
An adjustment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" adjustmentTier := &AdjustmentTier{ Adjustment: jsii.Number(123), // the properties below are optional LowerBound: jsii.Number(123), UpperBound: jsii.Number(123), }
type AdjustmentType ¶
type AdjustmentType string
How adjustment numbers are interpreted.
Example:
var capacity scalableAttribute var cpuUtilization metric capacity.scaleOnMetric(jsii.String("ScaleToCPU"), &basicStepScalingPolicyProps{ Metric: cpuUtilization, ScalingSteps: []scalingInterval{ &scalingInterval{ Upper: jsii.Number(10), Change: -jsii.Number(1), }, &scalingInterval{ Lower: jsii.Number(50), Change: +jsii.Number(1), }, &scalingInterval{ Lower: jsii.Number(70), Change: +jsii.Number(3), }, }, // Change this to AdjustmentType.PercentChangeInCapacity to interpret the // 'change' numbers before as percentages instead of capacity counts. AdjustmentType: appscaling.AdjustmentType_CHANGE_IN_CAPACITY, })
const ( // Add the adjustment number to the current capacity. // // A positive number increases capacity, a negative number decreases capacity. AdjustmentType_CHANGE_IN_CAPACITY AdjustmentType = "CHANGE_IN_CAPACITY" // Add this percentage of the current capacity to itself. // // The number must be between -100 and 100; a positive number increases // capacity and a negative number decreases it. AdjustmentType_PERCENT_CHANGE_IN_CAPACITY AdjustmentType = "PERCENT_CHANGE_IN_CAPACITY" // Make the capacity equal to the exact number given. AdjustmentType_EXACT_CAPACITY AdjustmentType = "EXACT_CAPACITY" )
type BaseScalableAttribute ¶
type BaseScalableAttribute interface { constructs.Construct // The tree node. Node() constructs.Node Props() *BaseScalableAttributeProps // Scale out or in based on a metric value. DoScaleOnMetric(id *string, props *BasicStepScalingPolicyProps) // Scale out or in based on time. DoScaleOnSchedule(id *string, props *ScalingSchedule) // Scale out or in in order to keep a metric around a target value. DoScaleToTrackMetric(id *string, props *BasicTargetTrackingScalingPolicyProps) // Returns a string representation of this construct. ToString() *string }
Represent an attribute for which autoscaling can be configured.
This class is basically a light wrapper around ScalableTarget, but with all methods protected instead of public so they can be selectively exposed and/or more specific versions of them can be exposed by derived classes for individual services support autoscaling.
Typical use cases:
- Hide away the PredefinedMetric enum for target tracking policies.
- Don't expose all scaling methods (for example Dynamo tables don't support Step Scaling, so the Dynamo subclass won't expose this method).
type BaseScalableAttributeProps ¶
type BaseScalableAttributeProps struct { // Maximum capacity to scale to. MaxCapacity *float64 `field:"required" json:"maxCapacity" yaml:"maxCapacity"` // Minimum capacity to scale to. // Default: 1. // MinCapacity *float64 `field:"optional" json:"minCapacity" yaml:"minCapacity"` // Scalable dimension of the attribute. Dimension *string `field:"required" json:"dimension" yaml:"dimension"` // Resource ID of the attribute. ResourceId *string `field:"required" json:"resourceId" yaml:"resourceId"` // Role to use for scaling. Role awsiam.IRole `field:"required" json:"role" yaml:"role"` // Service namespace of the scalable attribute. ServiceNamespace ServiceNamespace `field:"required" json:"serviceNamespace" yaml:"serviceNamespace"` }
Properties for a ScalableTableAttribute.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" var role role baseScalableAttributeProps := &BaseScalableAttributeProps{ Dimension: jsii.String("dimension"), MaxCapacity: jsii.Number(123), ResourceId: jsii.String("resourceId"), Role: role, ServiceNamespace: awscdk.Aws_applicationautoscaling.ServiceNamespace_ECS, // the properties below are optional MinCapacity: jsii.Number(123), }
type BaseTargetTrackingProps ¶
type BaseTargetTrackingProps struct { // 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. // Default: false. // DisableScaleIn *bool `field:"optional" json:"disableScaleIn" yaml:"disableScaleIn"` // A name for the scaling policy. // Default: - Automatically generated name. // PolicyName *string `field:"optional" json:"policyName" yaml:"policyName"` // Period after a scale in activity completes before another scale in activity can start. // Default: Duration.seconds(300) for the following scalable targets: ECS services, // Spot Fleet requests, EMR clusters, AppStream 2.0 fleets, Aurora DB clusters, // Amazon SageMaker endpoint variants, Custom resources. For all other scalable // targets, the default value is Duration.seconds(0): DynamoDB tables, DynamoDB // global secondary indexes, Amazon Comprehend document classification endpoints, // Lambda provisioned concurrency. // ScaleInCooldown awscdk.Duration `field:"optional" json:"scaleInCooldown" yaml:"scaleInCooldown"` // Period after a scale out activity completes before another scale out activity can start. // Default: Duration.seconds(300) for the following scalable targets: ECS services, // Spot Fleet requests, EMR clusters, AppStream 2.0 fleets, Aurora DB clusters, // Amazon SageMaker endpoint variants, Custom resources. For all other scalable // targets, the default value is Duration.seconds(0): DynamoDB tables, DynamoDB // global secondary indexes, Amazon Comprehend document classification endpoints, // Lambda provisioned concurrency. // ScaleOutCooldown awscdk.Duration `field:"optional" json:"scaleOutCooldown" yaml:"scaleOutCooldown"` }
Base interface for target tracking props.
Contains the attributes that are common to target tracking policies, except the ones relating to the metric and to the scalable target.
This interface is reused by more specific target tracking props objects in other services.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" baseTargetTrackingProps := &BaseTargetTrackingProps{ DisableScaleIn: jsii.Boolean(false), PolicyName: jsii.String("policyName"), ScaleInCooldown: cdk.Duration_Minutes(jsii.Number(30)), ScaleOutCooldown: cdk.Duration_*Minutes(jsii.Number(30)), }
type BasicStepScalingPolicyProps ¶
type BasicStepScalingPolicyProps struct { // Metric to scale on. Metric awscloudwatch.IMetric `field:"required" json:"metric" yaml:"metric"` // The intervals for scaling. // // Maps a range of metric values to a particular scaling behavior. // // Must be between 2 and 40 steps. ScalingSteps *[]*ScalingInterval `field:"required" json:"scalingSteps" yaml:"scalingSteps"` // How the adjustment numbers inside 'intervals' are interpreted. // Default: ChangeInCapacity. // AdjustmentType AdjustmentType `field:"optional" json:"adjustmentType" yaml:"adjustmentType"` // Grace period after scaling activity. // // Subsequent scale outs during the cooldown period are squashed so that only // the biggest scale out happens. // // Subsequent scale ins during the cooldown period are ignored. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html // // Default: No cooldown period. // Cooldown awscdk.Duration `field:"optional" json:"cooldown" yaml:"cooldown"` // The number of data points out of the evaluation periods that must be breaching to trigger a scaling action. // // Creates an "M out of N" alarm, where this property is the M and the value set for // `evaluationPeriods` is the N value. // // Only has meaning if `evaluationPeriods != 1`. // Default: - Same as `evaluationPeriods`. // DatapointsToAlarm *float64 `field:"optional" json:"datapointsToAlarm" yaml:"datapointsToAlarm"` // How many evaluation periods of the metric to wait before triggering a scaling action. // // Raising this value can be used to smooth out the metric, at the expense // of slower response times. // // If `datapointsToAlarm` is not set, then all data points in the evaluation period // must meet the criteria to trigger a scaling action. // Default: 1. // EvaluationPeriods *float64 `field:"optional" json:"evaluationPeriods" yaml:"evaluationPeriods"` // Aggregation to apply to all data points over the evaluation periods. // // Only has meaning if `evaluationPeriods != 1`. // Default: - The statistic from the metric if applicable (MIN, MAX, AVERAGE), otherwise AVERAGE. // MetricAggregationType MetricAggregationType `field:"optional" json:"metricAggregationType" yaml:"metricAggregationType"` // Minimum absolute number to adjust capacity with as result of percentage scaling. // // Only when using AdjustmentType = PercentChangeInCapacity, this number controls // the minimum absolute effect size. // Default: No minimum scaling effect. // MinAdjustmentMagnitude *float64 `field:"optional" json:"minAdjustmentMagnitude" yaml:"minAdjustmentMagnitude"` }
Example:
var capacity scalableAttribute var cpuUtilization metric capacity.scaleOnMetric(jsii.String("ScaleToCPU"), &basicStepScalingPolicyProps{ Metric: cpuUtilization, ScalingSteps: []scalingInterval{ &scalingInterval{ Upper: jsii.Number(10), Change: -jsii.Number(1), }, &scalingInterval{ Lower: jsii.Number(50), Change: +jsii.Number(1), }, &scalingInterval{ Lower: jsii.Number(70), Change: +jsii.Number(3), }, }, // Change this to AdjustmentType.PercentChangeInCapacity to interpret the // 'change' numbers before as percentages instead of capacity counts. AdjustmentType: appscaling.AdjustmentType_CHANGE_IN_CAPACITY, })
type BasicTargetTrackingScalingPolicyProps ¶
type BasicTargetTrackingScalingPolicyProps struct { // 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. // Default: false. // DisableScaleIn *bool `field:"optional" json:"disableScaleIn" yaml:"disableScaleIn"` // A name for the scaling policy. // Default: - Automatically generated name. // PolicyName *string `field:"optional" json:"policyName" yaml:"policyName"` // Period after a scale in activity completes before another scale in activity can start. // Default: Duration.seconds(300) for the following scalable targets: ECS services, // Spot Fleet requests, EMR clusters, AppStream 2.0 fleets, Aurora DB clusters, // Amazon SageMaker endpoint variants, Custom resources. For all other scalable // targets, the default value is Duration.seconds(0): DynamoDB tables, DynamoDB // global secondary indexes, Amazon Comprehend document classification endpoints, // Lambda provisioned concurrency. // ScaleInCooldown awscdk.Duration `field:"optional" json:"scaleInCooldown" yaml:"scaleInCooldown"` // Period after a scale out activity completes before another scale out activity can start. // Default: Duration.seconds(300) for the following scalable targets: ECS services, // Spot Fleet requests, EMR clusters, AppStream 2.0 fleets, Aurora DB clusters, // Amazon SageMaker endpoint variants, Custom resources. For all other scalable // targets, the default value is Duration.seconds(0): DynamoDB tables, DynamoDB // global secondary indexes, Amazon Comprehend document classification endpoints, // Lambda provisioned concurrency. // ScaleOutCooldown awscdk.Duration `field:"optional" json:"scaleOutCooldown" yaml:"scaleOutCooldown"` // The target value for the metric. TargetValue *float64 `field:"required" json:"targetValue" yaml:"targetValue"` // A custom metric for application autoscaling. // // The metric must track utilization. Scaling out will happen if the metric is higher than // the target value, scaling in will happen in the metric is lower than the target value. // // Exactly one of customMetric or predefinedMetric must be specified. // Default: - No custom metric. // CustomMetric awscloudwatch.IMetric `field:"optional" json:"customMetric" yaml:"customMetric"` // A predefined metric for application autoscaling. // // The metric must track utilization. Scaling out will happen if the metric is higher than // the target value, scaling in will happen in the metric is lower than the target value. // // Exactly one of customMetric or predefinedMetric must be specified. // Default: - No predefined metrics. // PredefinedMetric PredefinedMetric `field:"optional" json:"predefinedMetric" yaml:"predefinedMetric"` // Identify the resource associated with the metric type. // // Only used for predefined metric ALBRequestCountPerTarget. // // Example value: `app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>`. // Default: - No resource label. // ResourceLabel *string `field:"optional" json:"resourceLabel" yaml:"resourceLabel"` }
Properties for a Target Tracking policy that include the metric but exclude the target.
Example:
shardsScalableTarget := appscaling.NewScalableTarget(this, jsii.String("ElastiCacheRedisShardsScalableTarget"), &ScalableTargetProps{ ServiceNamespace: appscaling.ServiceNamespace_ELASTICACHE, ScalableDimension: jsii.String("elasticache:replication-group:NodeGroups"), MinCapacity: jsii.Number(2), MaxCapacity: jsii.Number(10), ResourceId: jsii.String("replication-group/main-cluster"), }) shardsScalableTarget.ScaleToTrackMetric(jsii.String("ElastiCacheRedisShardsCPUUtilization"), &BasicTargetTrackingScalingPolicyProps{ TargetValue: jsii.Number(20), PredefinedMetric: appscaling.PredefinedMetric_ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION, })
type CfnScalableTarget ¶
type CfnScalableTarget interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The maximum value that you plan to scale out to. MaxCapacity() *float64 SetMaxCapacity(val *float64) // The minimum value that you plan to scale in to. MinCapacity() *float64 SetMinCapacity(val *float64) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The identifier of the resource associated with the scalable target. ResourceId() *string SetResourceId(val *string) // Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. RoleArn() *string SetRoleArn(val *string) // The scalable dimension associated with the scalable target. ScalableDimension() *string SetScalableDimension(val *string) // The scheduled actions for the scalable target. ScheduledActions() interface{} SetScheduledActions(val interface{}) // The namespace of the AWS service that provides the resource, or a `custom-resource` . ServiceNamespace() *string SetServiceNamespace(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. SuspendedState() interface{} SetSuspendedState(val interface{}) // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::ApplicationAutoScaling::ScalableTarget` resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource.
For more information, see [Getting started](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the *Application Auto Scaling User Guide* .
> If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnScalableTarget := awscdk.Aws_applicationautoscaling.NewCfnScalableTarget(this, jsii.String("MyCfnScalableTarget"), &CfnScalableTargetProps{ MaxCapacity: jsii.Number(123), MinCapacity: jsii.Number(123), ResourceId: jsii.String("resourceId"), ScalableDimension: jsii.String("scalableDimension"), ServiceNamespace: jsii.String("serviceNamespace"), // the properties below are optional RoleArn: jsii.String("roleArn"), ScheduledActions: []interface{}{ &ScheduledActionProperty{ Schedule: jsii.String("schedule"), ScheduledActionName: jsii.String("scheduledActionName"), // the properties below are optional EndTime: NewDate(), ScalableTargetAction: &ScalableTargetActionProperty{ MaxCapacity: jsii.Number(123), MinCapacity: jsii.Number(123), }, StartTime: NewDate(), Timezone: jsii.String("timezone"), }, }, SuspendedState: &SuspendedStateProperty{ DynamicScalingInSuspended: jsii.Boolean(false), DynamicScalingOutSuspended: jsii.Boolean(false), ScheduledScalingSuspended: jsii.Boolean(false), }, })
func NewCfnScalableTarget ¶
func NewCfnScalableTarget(scope constructs.Construct, id *string, props *CfnScalableTargetProps) CfnScalableTarget
type CfnScalableTargetProps ¶
type CfnScalableTargetProps struct { // The maximum value that you plan to scale out to. // // When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-maxcapacity // MaxCapacity *float64 `field:"required" json:"maxCapacity" yaml:"maxCapacity"` // The minimum value that you plan to scale in to. // // When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-mincapacity // MinCapacity *float64 `field:"required" json:"minCapacity" yaml:"minCapacity"` // The identifier of the resource associated with the scalable target. // // This string consists of the resource type and unique identifier. // // - ECS service - The resource type is `service` and the unique identifier is the cluster name and service name. Example: `service/my-cluster/my-service` . // - Spot Fleet - The resource type is `spot-fleet-request` and the unique identifier is the Spot Fleet request ID. Example: `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE` . // - EMR cluster - The resource type is `instancegroup` and the unique identifier is the cluster ID and instance group ID. Example: `instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0` . // - AppStream 2.0 fleet - The resource type is `fleet` and the unique identifier is the fleet name. Example: `fleet/sample-fleet` . // - DynamoDB table - The resource type is `table` and the unique identifier is the table name. Example: `table/my-table` . // - DynamoDB global secondary index - The resource type is `index` and the unique identifier is the index name. Example: `table/my-table/index/my-table-index` . // - Aurora DB cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:my-db-cluster` . // - SageMaker endpoint variant - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering` . // - Custom resources are not supported with a resource type. This parameter must specify the `OutputValue` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource) . // - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE` . // - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE` . // - Lambda provisioned concurrency - The resource type is `function` and the unique identifier is the function name with a function version or alias name suffix that is not `$LATEST` . Example: `function:my-function:prod` or `function:my-function:1` . // - Amazon Keyspaces table - The resource type is `table` and the unique identifier is the table name. Example: `keyspace/mykeyspace/table/mytable` . // - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: `arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5` . // - Amazon ElastiCache replication group - The resource type is `replication-group` and the unique identifier is the replication group name. Example: `replication-group/mycluster` . // - Neptune cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:mycluster` . // - SageMaker serverless endpoint - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering` . // - SageMaker inference component - The resource type is `inference-component` and the unique identifier is the resource ID. Example: `inference-component/my-inference-component` . // - Pool of WorkSpaces - The resource type is `workspacespool` and the unique identifier is the pool ID. Example: `workspacespool/wspool-123456` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-resourceid // ResourceId *string `field:"required" json:"resourceId" yaml:"resourceId"` // The scalable dimension associated with the scalable target. // // This string consists of the service namespace, resource type, and scaling property. // // - `ecs:service:DesiredCount` - The task count of an ECS service. // - `elasticmapreduce:instancegroup:InstanceCount` - The instance count of an EMR Instance Group. // - `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet. // - `appstream:fleet:DesiredCapacity` - The capacity of an AppStream 2.0 fleet. // - `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB table. // - `dynamodb:table:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB table. // - `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB global secondary index. // - `dynamodb:index:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB global secondary index. // - `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. // - `sagemaker:variant:DesiredInstanceCount` - The number of EC2 instances for a SageMaker model endpoint variant. // - `custom-resource:ResourceType:Property` - The scalable dimension for a custom resource provided by your own application or service. // - `comprehend:document-classifier-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend document classification endpoint. // - `comprehend:entity-recognizer-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. // - `lambda:function:ProvisionedConcurrency` - The provisioned concurrency for a Lambda function. // - `cassandra:table:ReadCapacityUnits` - The provisioned read capacity for an Amazon Keyspaces table. // - `cassandra:table:WriteCapacityUnits` - The provisioned write capacity for an Amazon Keyspaces table. // - `kafka:broker-storage:VolumeSize` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. // - `elasticache:replication-group:NodeGroups` - The number of node groups for an Amazon ElastiCache replication group. // - `elasticache:replication-group:Replicas` - The number of replicas per node group for an Amazon ElastiCache replication group. // - `neptune:cluster:ReadReplicaCount` - The count of read replicas in an Amazon Neptune DB cluster. // - `sagemaker:variant:DesiredProvisionedConcurrency` - The provisioned concurrency for a SageMaker serverless endpoint. // - `sagemaker:inference-component:DesiredCopyCount` - The number of copies across an endpoint for a SageMaker inference component. // - `workspaces:workspacespool:DesiredUserSessions` - The number of user sessions for the WorkSpaces in the pool. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-scalabledimension // ScalableDimension *string `field:"required" json:"scalableDimension" yaml:"scalableDimension"` // The namespace of the AWS service that provides the resource, or a `custom-resource` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-servicenamespace // ServiceNamespace *string `field:"required" json:"serviceNamespace" yaml:"serviceNamespace"` // Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. // // This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide* . // // To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide* . Look for the ARN in the table at the bottom of the page. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-rolearn // RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` // The scheduled actions for the scalable target. // // Duplicates aren't allowed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-scheduledactions // ScheduledActions interface{} `field:"optional" json:"scheduledActions" yaml:"scheduledActions"` // An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. // // Setting the value of an attribute to `true` suspends the specified scaling activities. Setting it to `false` (default) resumes the specified scaling activities. // // *Suspension Outcomes* // // - For `DynamicScalingInSuspended` , while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. // - For `DynamicScalingOutSuspended` , while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. // - For `ScheduledScalingSuspended` , while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-suspendedstate // SuspendedState interface{} `field:"optional" json:"suspendedState" yaml:"suspendedState"` }
Properties for defining a `CfnScalableTarget`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnScalableTargetProps := &CfnScalableTargetProps{ MaxCapacity: jsii.Number(123), MinCapacity: jsii.Number(123), ResourceId: jsii.String("resourceId"), ScalableDimension: jsii.String("scalableDimension"), ServiceNamespace: jsii.String("serviceNamespace"), // the properties below are optional RoleArn: jsii.String("roleArn"), ScheduledActions: []interface{}{ &ScheduledActionProperty{ Schedule: jsii.String("schedule"), ScheduledActionName: jsii.String("scheduledActionName"), // the properties below are optional EndTime: NewDate(), ScalableTargetAction: &ScalableTargetActionProperty{ MaxCapacity: jsii.Number(123), MinCapacity: jsii.Number(123), }, StartTime: NewDate(), Timezone: jsii.String("timezone"), }, }, SuspendedState: &SuspendedStateProperty{ DynamicScalingInSuspended: jsii.Boolean(false), DynamicScalingOutSuspended: jsii.Boolean(false), ScheduledScalingSuspended: jsii.Boolean(false), }, }
type CfnScalableTarget_ScalableTargetActionProperty ¶
type CfnScalableTarget_ScalableTargetActionProperty struct { // The maximum capacity. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scalabletargetaction.html#cfn-applicationautoscaling-scalabletarget-scalabletargetaction-maxcapacity // MaxCapacity *float64 `field:"optional" json:"maxCapacity" yaml:"maxCapacity"` // The minimum capacity. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scalabletargetaction.html#cfn-applicationautoscaling-scalabletarget-scalabletargetaction-mincapacity // MinCapacity *float64 `field:"optional" json:"minCapacity" yaml:"minCapacity"` }
`ScalableTargetAction` specifies the minimum and maximum capacity for the `ScalableTargetAction` property of the [AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html) property type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scalableTargetActionProperty := &ScalableTargetActionProperty{ MaxCapacity: jsii.Number(123), MinCapacity: jsii.Number(123), }
type CfnScalableTarget_ScheduledActionProperty ¶
type CfnScalableTarget_ScheduledActionProperty struct { // The schedule for this action. The following formats are supported:. // // - At expressions - " `at( *yyyy* - *mm* - *dd* T *hh* : *mm* : *ss* )` " // - Rate expressions - " `rate( *value* *unit* )` " // - Cron expressions - " `cron( *fields* )` " // // At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. // // At and cron expressions use Universal Coordinated Time (UTC) by default. // // The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. // // For rate expressions, *value* is a positive integer and *unit* is `minute` | `minutes` | `hour` | `hours` | `day` | `days` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-schedule // Schedule *string `field:"required" json:"schedule" yaml:"schedule"` // The name of the scheduled action. // // This name must be unique among all other scheduled actions on the specified scalable target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-scheduledactionname // ScheduledActionName *string `field:"required" json:"scheduledActionName" yaml:"scheduledActionName"` // The date and time that the action is scheduled to end, in UTC. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-endtime // EndTime interface{} `field:"optional" json:"endTime" yaml:"endTime"` // The new minimum and maximum capacity. // // You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-scalabletargetaction // ScalableTargetAction interface{} `field:"optional" json:"scalableTargetAction" yaml:"scalableTargetAction"` // The date and time that the action is scheduled to begin, in UTC. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-starttime // StartTime interface{} `field:"optional" json:"startTime" yaml:"startTime"` // The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-timezone // Timezone *string `field:"optional" json:"timezone" yaml:"timezone"` }
`ScheduledAction` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies a scheduled action for a scalable target.
For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) in the *Application Auto Scaling User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scheduledActionProperty := &ScheduledActionProperty{ Schedule: jsii.String("schedule"), ScheduledActionName: jsii.String("scheduledActionName"), // the properties below are optional EndTime: NewDate(), ScalableTargetAction: &ScalableTargetActionProperty{ MaxCapacity: jsii.Number(123), MinCapacity: jsii.Number(123), }, StartTime: NewDate(), Timezone: jsii.String("timezone"), }
type CfnScalableTarget_SuspendedStateProperty ¶
type CfnScalableTarget_SuspendedStateProperty struct { // Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. // // Set the value to `true` if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-suspendedstate.html#cfn-applicationautoscaling-scalabletarget-suspendedstate-dynamicscalinginsuspended // DynamicScalingInSuspended interface{} `field:"optional" json:"dynamicScalingInSuspended" yaml:"dynamicScalingInSuspended"` // Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. // // Set the value to `true` if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-suspendedstate.html#cfn-applicationautoscaling-scalabletarget-suspendedstate-dynamicscalingoutsuspended // DynamicScalingOutSuspended interface{} `field:"optional" json:"dynamicScalingOutSuspended" yaml:"dynamicScalingOutSuspended"` // Whether scheduled scaling is suspended. // // Set the value to `true` if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-suspendedstate.html#cfn-applicationautoscaling-scalabletarget-suspendedstate-scheduledscalingsuspended // ScheduledScalingSuspended interface{} `field:"optional" json:"scheduledScalingSuspended" yaml:"scheduledScalingSuspended"` }
`SuspendedState` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies whether the scaling activities for a scalable target are in a suspended state.
For more information, see [Suspending and resuming scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) in the *Application Auto Scaling User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" suspendedStateProperty := &SuspendedStateProperty{ DynamicScalingInSuspended: jsii.Boolean(false), DynamicScalingOutSuspended: jsii.Boolean(false), ScheduledScalingSuspended: jsii.Boolean(false), }
type CfnScalingPolicy ¶
type CfnScalingPolicy interface { awscdk.CfnResource awscdk.IInspectable // Returns the ARN of a scaling policy. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The name of the scaling policy. PolicyName() *string SetPolicyName(val *string) // The scaling policy type. PolicyType() *string SetPolicyType(val *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 })`. Ref() *string // The identifier of the resource associated with the scaling policy. ResourceId() *string SetResourceId(val *string) // The scalable dimension. // // This string consists of the service namespace, resource type, and scaling property. ScalableDimension() *string SetScalableDimension(val *string) // The CloudFormation-generated ID of an Application Auto Scaling scalable target. ScalingTargetId() *string SetScalingTargetId(val *string) // The namespace of the AWS service that provides the resource, or a `custom-resource` . ServiceNamespace() *string SetServiceNamespace(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A step scaling policy. StepScalingPolicyConfiguration() interface{} SetStepScalingPolicyConfiguration(val interface{}) // A target tracking scaling policy. TargetTrackingScalingPolicyConfiguration() interface{} SetTargetTrackingScalingPolicyConfiguration(val interface{}) // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::ApplicationAutoScaling::ScalingPolicy` resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target.
For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnScalingPolicy := awscdk.Aws_applicationautoscaling.NewCfnScalingPolicy(this, jsii.String("MyCfnScalingPolicy"), &CfnScalingPolicyProps{ PolicyName: jsii.String("policyName"), PolicyType: jsii.String("policyType"), // the properties below are optional ResourceId: jsii.String("resourceId"), ScalableDimension: jsii.String("scalableDimension"), ScalingTargetId: jsii.String("scalingTargetId"), ServiceNamespace: jsii.String("serviceNamespace"), StepScalingPolicyConfiguration: &StepScalingPolicyConfigurationProperty{ AdjustmentType: jsii.String("adjustmentType"), Cooldown: jsii.Number(123), MetricAggregationType: jsii.String("metricAggregationType"), MinAdjustmentMagnitude: jsii.Number(123), StepAdjustments: []interface{}{ &StepAdjustmentProperty{ ScalingAdjustment: jsii.Number(123), // the properties below are optional MetricIntervalLowerBound: jsii.Number(123), MetricIntervalUpperBound: jsii.Number(123), }, }, }, TargetTrackingScalingPolicyConfiguration: &TargetTrackingScalingPolicyConfigurationProperty{ TargetValue: jsii.Number(123), // the properties below are optional CustomizedMetricSpecification: &CustomizedMetricSpecificationProperty{ Dimensions: []interface{}{ &MetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Metrics: []interface{}{ &TargetTrackingMetricDataQueryProperty{ Expression: jsii.String("expression"), Id: jsii.String("id"), Label: jsii.String("label"), MetricStat: &TargetTrackingMetricStatProperty{ Metric: &TargetTrackingMetricProperty{ Dimensions: []interface{}{ &TargetTrackingMetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Namespace: jsii.String("namespace"), }, Stat: jsii.String("stat"), Unit: jsii.String("unit"), }, ReturnData: jsii.Boolean(false), }, }, Namespace: jsii.String("namespace"), Statistic: jsii.String("statistic"), Unit: jsii.String("unit"), }, DisableScaleIn: jsii.Boolean(false), PredefinedMetricSpecification: &PredefinedMetricSpecificationProperty{ PredefinedMetricType: jsii.String("predefinedMetricType"), // the properties below are optional ResourceLabel: jsii.String("resourceLabel"), }, ScaleInCooldown: jsii.Number(123), ScaleOutCooldown: jsii.Number(123), }, })
func NewCfnScalingPolicy ¶
func NewCfnScalingPolicy(scope constructs.Construct, id *string, props *CfnScalingPolicyProps) CfnScalingPolicy
type CfnScalingPolicyProps ¶
type CfnScalingPolicyProps struct { // The name of the scaling policy. // // Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing `AWS::ApplicationAutoScaling::ScalingPolicy` resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-policyname // PolicyName *string `field:"required" json:"policyName" yaml:"policyName"` // The scaling policy type. // // The following policy types are supported: // // `TargetTrackingScaling` —Not supported for Amazon EMR // // `StepScaling` —Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-policytype // PolicyType *string `field:"required" json:"policyType" yaml:"policyType"` // The identifier of the resource associated with the scaling policy. // // This string consists of the resource type and unique identifier. // // - ECS service - The resource type is `service` and the unique identifier is the cluster name and service name. Example: `service/my-cluster/my-service` . // - Spot Fleet - The resource type is `spot-fleet-request` and the unique identifier is the Spot Fleet request ID. Example: `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE` . // - EMR cluster - The resource type is `instancegroup` and the unique identifier is the cluster ID and instance group ID. Example: `instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0` . // - AppStream 2.0 fleet - The resource type is `fleet` and the unique identifier is the fleet name. Example: `fleet/sample-fleet` . // - DynamoDB table - The resource type is `table` and the unique identifier is the table name. Example: `table/my-table` . // - DynamoDB global secondary index - The resource type is `index` and the unique identifier is the index name. Example: `table/my-table/index/my-table-index` . // - Aurora DB cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:my-db-cluster` . // - SageMaker endpoint variant - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering` . // - Custom resources are not supported with a resource type. This parameter must specify the `OutputValue` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource) . // - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE` . // - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE` . // - Lambda provisioned concurrency - The resource type is `function` and the unique identifier is the function name with a function version or alias name suffix that is not `$LATEST` . Example: `function:my-function:prod` or `function:my-function:1` . // - Amazon Keyspaces table - The resource type is `table` and the unique identifier is the table name. Example: `keyspace/mykeyspace/table/mytable` . // - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: `arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5` . // - Amazon ElastiCache replication group - The resource type is `replication-group` and the unique identifier is the replication group name. Example: `replication-group/mycluster` . // - Neptune cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:mycluster` . // - SageMaker serverless endpoint - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering` . // - SageMaker inference component - The resource type is `inference-component` and the unique identifier is the resource ID. Example: `inference-component/my-inference-component` . // - Pool of WorkSpaces - The resource type is `workspacespool` and the unique identifier is the pool ID. Example: `workspacespool/wspool-123456` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-resourceid // ResourceId *string `field:"optional" json:"resourceId" yaml:"resourceId"` // The scalable dimension. This string consists of the service namespace, resource type, and scaling property. // // - `ecs:service:DesiredCount` - The task count of an ECS service. // - `elasticmapreduce:instancegroup:InstanceCount` - The instance count of an EMR Instance Group. // - `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet. // - `appstream:fleet:DesiredCapacity` - The capacity of an AppStream 2.0 fleet. // - `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB table. // - `dynamodb:table:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB table. // - `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB global secondary index. // - `dynamodb:index:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB global secondary index. // - `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. // - `sagemaker:variant:DesiredInstanceCount` - The number of EC2 instances for a SageMaker model endpoint variant. // - `custom-resource:ResourceType:Property` - The scalable dimension for a custom resource provided by your own application or service. // - `comprehend:document-classifier-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend document classification endpoint. // - `comprehend:entity-recognizer-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. // - `lambda:function:ProvisionedConcurrency` - The provisioned concurrency for a Lambda function. // - `cassandra:table:ReadCapacityUnits` - The provisioned read capacity for an Amazon Keyspaces table. // - `cassandra:table:WriteCapacityUnits` - The provisioned write capacity for an Amazon Keyspaces table. // - `kafka:broker-storage:VolumeSize` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. // - `elasticache:replication-group:NodeGroups` - The number of node groups for an Amazon ElastiCache replication group. // - `elasticache:replication-group:Replicas` - The number of replicas per node group for an Amazon ElastiCache replication group. // - `neptune:cluster:ReadReplicaCount` - The count of read replicas in an Amazon Neptune DB cluster. // - `sagemaker:variant:DesiredProvisionedConcurrency` - The provisioned concurrency for a SageMaker serverless endpoint. // - `sagemaker:inference-component:DesiredCopyCount` - The number of copies across an endpoint for a SageMaker inference component. // - `workspaces:workspacespool:DesiredUserSessions` - The number of user sessions for the WorkSpaces in the pool. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-scalabledimension // ScalableDimension *string `field:"optional" json:"scalableDimension" yaml:"scalableDimension"` // The CloudFormation-generated ID of an Application Auto Scaling scalable target. // // For more information about the ID, see the Return Value section of the `AWS::ApplicationAutoScaling::ScalableTarget` resource. // // > You must specify either the `ScalingTargetId` property, or the `ResourceId` , `ScalableDimension` , and `ServiceNamespace` properties, but not both. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-scalingtargetid // ScalingTargetId *string `field:"optional" json:"scalingTargetId" yaml:"scalingTargetId"` // The namespace of the AWS service that provides the resource, or a `custom-resource` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-servicenamespace // ServiceNamespace *string `field:"optional" json:"serviceNamespace" yaml:"serviceNamespace"` // A step scaling policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration // StepScalingPolicyConfiguration interface{} `field:"optional" json:"stepScalingPolicyConfiguration" yaml:"stepScalingPolicyConfiguration"` // A target tracking scaling policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration // TargetTrackingScalingPolicyConfiguration interface{} `field:"optional" json:"targetTrackingScalingPolicyConfiguration" yaml:"targetTrackingScalingPolicyConfiguration"` }
Properties for defining a `CfnScalingPolicy`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnScalingPolicyProps := &CfnScalingPolicyProps{ PolicyName: jsii.String("policyName"), PolicyType: jsii.String("policyType"), // the properties below are optional ResourceId: jsii.String("resourceId"), ScalableDimension: jsii.String("scalableDimension"), ScalingTargetId: jsii.String("scalingTargetId"), ServiceNamespace: jsii.String("serviceNamespace"), StepScalingPolicyConfiguration: &StepScalingPolicyConfigurationProperty{ AdjustmentType: jsii.String("adjustmentType"), Cooldown: jsii.Number(123), MetricAggregationType: jsii.String("metricAggregationType"), MinAdjustmentMagnitude: jsii.Number(123), StepAdjustments: []interface{}{ &StepAdjustmentProperty{ ScalingAdjustment: jsii.Number(123), // the properties below are optional MetricIntervalLowerBound: jsii.Number(123), MetricIntervalUpperBound: jsii.Number(123), }, }, }, TargetTrackingScalingPolicyConfiguration: &TargetTrackingScalingPolicyConfigurationProperty{ TargetValue: jsii.Number(123), // the properties below are optional CustomizedMetricSpecification: &CustomizedMetricSpecificationProperty{ Dimensions: []interface{}{ &MetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Metrics: []interface{}{ &TargetTrackingMetricDataQueryProperty{ Expression: jsii.String("expression"), Id: jsii.String("id"), Label: jsii.String("label"), MetricStat: &TargetTrackingMetricStatProperty{ Metric: &TargetTrackingMetricProperty{ Dimensions: []interface{}{ &TargetTrackingMetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Namespace: jsii.String("namespace"), }, Stat: jsii.String("stat"), Unit: jsii.String("unit"), }, ReturnData: jsii.Boolean(false), }, }, Namespace: jsii.String("namespace"), Statistic: jsii.String("statistic"), Unit: jsii.String("unit"), }, DisableScaleIn: jsii.Boolean(false), PredefinedMetricSpecification: &PredefinedMetricSpecificationProperty{ PredefinedMetricType: jsii.String("predefinedMetricType"), // the properties below are optional ResourceLabel: jsii.String("resourceLabel"), }, ScaleInCooldown: jsii.Number(123), ScaleOutCooldown: jsii.Number(123), }, }
type CfnScalingPolicy_CustomizedMetricSpecificationProperty ¶
type CfnScalingPolicy_CustomizedMetricSpecificationProperty struct { // The dimensions of the metric. // // Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-dimensions // Dimensions interface{} `field:"optional" json:"dimensions" yaml:"dimensions"` // The name of the metric. // // To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that's returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-metricname // MetricName *string `field:"optional" json:"metricName" yaml:"metricName"` // The metrics to include in the target tracking scaling policy, as a metric data query. // // This can include both raw metric and metric math expressions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-metrics // Metrics interface{} `field:"optional" json:"metrics" yaml:"metrics"` // The namespace of the metric. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-namespace // Namespace *string `field:"optional" json:"namespace" yaml:"namespace"` // The statistic of the metric. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-statistic // Statistic *string `field:"optional" json:"statistic" yaml:"statistic"` // The unit of the metric. // // For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-unit // Unit *string `field:"optional" json:"unit" yaml:"unit"` }
Contains customized metric specification information for a target tracking scaling policy for Application Auto Scaling.
For information about the available metrics for a service, see [AWS services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide* .
To create your customized metric specification:
- Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see [Publish custom metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the *Amazon CloudWatch User Guide* . - Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases.
For an example of how creating new metrics can be useful, see [Scaling based on Amazon SQS](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-using-sqs-queue.html) in the *Amazon EC2 Auto Scaling User Guide* . This topic mentions Auto Scaling groups, but the same scenario for Amazon SQS can apply to the target tracking scaling policies that you create for a Spot Fleet by using Application Auto Scaling.
For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) .
`CustomizedMetricSpecification` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customizedMetricSpecificationProperty := &CustomizedMetricSpecificationProperty{ Dimensions: []interface{}{ &MetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Metrics: []interface{}{ &TargetTrackingMetricDataQueryProperty{ Expression: jsii.String("expression"), Id: jsii.String("id"), Label: jsii.String("label"), MetricStat: &TargetTrackingMetricStatProperty{ Metric: &TargetTrackingMetricProperty{ Dimensions: []interface{}{ &TargetTrackingMetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Namespace: jsii.String("namespace"), }, Stat: jsii.String("stat"), Unit: jsii.String("unit"), }, ReturnData: jsii.Boolean(false), }, }, Namespace: jsii.String("namespace"), Statistic: jsii.String("statistic"), Unit: jsii.String("unit"), }
type CfnScalingPolicy_MetricDimensionProperty ¶
type CfnScalingPolicy_MetricDimensionProperty struct { // The name of the dimension. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-metricdimension.html#cfn-applicationautoscaling-scalingpolicy-metricdimension-name // Name *string `field:"required" json:"name" yaml:"name"` // The value of the dimension. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-metricdimension.html#cfn-applicationautoscaling-scalingpolicy-metricdimension-value // Value *string `field:"required" json:"value" yaml:"value"` }
`MetricDimension` specifies a name/value pair that is part of the identity of a CloudWatch metric for the `Dimensions` property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type. Duplicate dimensions are not allowed.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" metricDimensionProperty := &MetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }
type CfnScalingPolicy_PredefinedMetricSpecificationProperty ¶
type CfnScalingPolicy_PredefinedMetricSpecificationProperty struct { // The metric type. // // The `ALBRequestCountPerTarget` metric type applies only to Spot fleet requests and ECS services. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predefinedmetricspecification-predefinedmetrictype // PredefinedMetricType *string `field:"required" json:"predefinedMetricType" yaml:"predefinedMetricType"` // Identifies the resource associated with the metric type. // // You can't specify a resource label unless the metric type is `ALBRequestCountPerTarget` and there is a target group attached to the Spot Fleet or ECS service. // // You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: // // `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff` . // // Where: // // - app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN // - targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN. // // To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predefinedmetricspecification-resourcelabel // ResourceLabel *string `field:"optional" json:"resourceLabel" yaml:"resourceLabel"` }
Contains predefined metric specification information for a target tracking scaling policy for Application Auto Scaling.
`PredefinedMetricSpecification` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" predefinedMetricSpecificationProperty := &PredefinedMetricSpecificationProperty{ PredefinedMetricType: jsii.String("predefinedMetricType"), // the properties below are optional ResourceLabel: jsii.String("resourceLabel"), }
type CfnScalingPolicy_StepAdjustmentProperty ¶
type CfnScalingPolicy_StepAdjustmentProperty struct { // The amount by which to scale. // // The adjustment is based on the value that you specified in the `AdjustmentType` property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepadjustment-scalingadjustment // ScalingAdjustment *float64 `field:"required" json:"scalingAdjustment" yaml:"scalingAdjustment"` // The lower bound for the difference between the alarm threshold and the CloudWatch metric. // // If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. // // You must specify at least one upper or lower bound. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepadjustment-metricintervallowerbound // MetricIntervalLowerBound *float64 `field:"optional" json:"metricIntervalLowerBound" yaml:"metricIntervalLowerBound"` // The upper bound for the difference between the alarm threshold and the CloudWatch metric. // // If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. // // You must specify at least one upper or lower bound. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepadjustment-metricintervalupperbound // MetricIntervalUpperBound *float64 `field:"optional" json:"metricIntervalUpperBound" yaml:"metricIntervalUpperBound"` }
`StepAdjustment` specifies a step adjustment for the `StepAdjustments` property of the [AWS::ApplicationAutoScaling::ScalingPolicy StepScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html) property type.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
- To trigger a step adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10. - To trigger a step adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
For more information, see [Step adjustments](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#as-scaling-steps) in the *Application Auto Scaling User Guide* .
You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#aws-resource-applicationautoscaling-scalingpolicy--examples) section of the `AWS::ApplicationAutoScaling::ScalingPolicy` documentation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" stepAdjustmentProperty := &StepAdjustmentProperty{ ScalingAdjustment: jsii.Number(123), // the properties below are optional MetricIntervalLowerBound: jsii.Number(123), MetricIntervalUpperBound: jsii.Number(123), }
type CfnScalingPolicy_StepScalingPolicyConfigurationProperty ¶
type CfnScalingPolicy_StepScalingPolicyConfigurationProperty struct { // Specifies whether the `ScalingAdjustment` value in the `StepAdjustment` property is an absolute number or a percentage of the current capacity. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-adjustmenttype // AdjustmentType *string `field:"optional" json:"adjustmentType" yaml:"adjustmentType"` // The amount of time, in seconds, to wait for a previous scaling activity to take effect. // // If not specified, the default value is 300. For more information, see [Cooldown period](https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown) in the *Application Auto Scaling User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-cooldown // Cooldown *float64 `field:"optional" json:"cooldown" yaml:"cooldown"` // The aggregation type for the CloudWatch metrics. // // Valid values are `Minimum` , `Maximum` , and `Average` . If the aggregation type is null, the value is treated as `Average` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-metricaggregationtype // MetricAggregationType *string `field:"optional" json:"metricAggregationType" yaml:"metricAggregationType"` // The minimum value to scale by when the adjustment type is `PercentChangeInCapacity` . // // For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a `MinAdjustmentMagnitude` of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a `MinAdjustmentMagnitude` of 2, Application Auto Scaling scales out the service by 2 tasks. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-minadjustmentmagnitude // MinAdjustmentMagnitude *float64 `field:"optional" json:"minAdjustmentMagnitude" yaml:"minAdjustmentMagnitude"` // A set of adjustments that enable you to scale based on the size of the alarm breach. // // At least one step adjustment is required if you are adding a new step scaling policy configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustments // StepAdjustments interface{} `field:"optional" json:"stepAdjustments" yaml:"stepAdjustments"` }
`StepScalingPolicyConfiguration` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a step scaling policy configuration for Application Auto Scaling.
For more information, see [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" stepScalingPolicyConfigurationProperty := &StepScalingPolicyConfigurationProperty{ AdjustmentType: jsii.String("adjustmentType"), Cooldown: jsii.Number(123), MetricAggregationType: jsii.String("metricAggregationType"), MinAdjustmentMagnitude: jsii.Number(123), StepAdjustments: []interface{}{ &StepAdjustmentProperty{ ScalingAdjustment: jsii.Number(123), // the properties below are optional MetricIntervalLowerBound: jsii.Number(123), MetricIntervalUpperBound: jsii.Number(123), }, }, }
type CfnScalingPolicy_TargetTrackingMetricDataQueryProperty ¶ added in v2.109.0
type CfnScalingPolicy_TargetTrackingMetricDataQueryProperty struct { // The math expression to perform on the returned data, if this object is performing a math expression. // // This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. // // Conditional: Within each `TargetTrackingMetricDataQuery` object, you must specify either `Expression` or `MetricStat` , but not both. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-expression // Expression *string `field:"optional" json:"expression" yaml:"expression"` // A short name that identifies the object's results in the response. // // This name must be unique among all `MetricDataQuery` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-id // Id *string `field:"optional" json:"id" yaml:"id"` // A human-readable label for this metric or expression. // // This is especially useful if this is a math expression, so that you know what the value represents. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-label // Label *string `field:"optional" json:"label" yaml:"label"` // Information about the metric data to return. // // Conditional: Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat` , but not both. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-metricstat // MetricStat interface{} `field:"optional" json:"metricStat" yaml:"metricStat"` // Indicates whether to return the timestamps and raw data values of this metric. // // If you use any math expressions, specify `true` for this value for only the final math expression that the metric specification is based on. You must specify `false` for `ReturnData` for all the other metrics and expressions used in the metric specification. // // If you are only retrieving metrics and not performing any math expressions, do not specify anything for `ReturnData` . This sets it to its default ( `true` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-returndata // ReturnData interface{} `field:"optional" json:"returnData" yaml:"returnData"` }
The metric data to return.
Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series.
For more information and examples, see [Create a target tracking scaling policy for Application Auto Scaling using metric math](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) in the *Application Auto Scaling User Guide* .
`TargetTrackingMetricDataQuery` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" targetTrackingMetricDataQueryProperty := &TargetTrackingMetricDataQueryProperty{ Expression: jsii.String("expression"), Id: jsii.String("id"), Label: jsii.String("label"), MetricStat: &TargetTrackingMetricStatProperty{ Metric: &TargetTrackingMetricProperty{ Dimensions: []interface{}{ &TargetTrackingMetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Namespace: jsii.String("namespace"), }, Stat: jsii.String("stat"), Unit: jsii.String("unit"), }, ReturnData: jsii.Boolean(false), }
type CfnScalingPolicy_TargetTrackingMetricDimensionProperty ¶ added in v2.109.0
type CfnScalingPolicy_TargetTrackingMetricDimensionProperty struct { // The name of the dimension. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdimension.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdimension-name // Name *string `field:"optional" json:"name" yaml:"name"` // The value of the dimension. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdimension.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdimension-value // Value *string `field:"optional" json:"value" yaml:"value"` }
`TargetTrackingMetricDimension` specifies a name/value pair that is part of the identity of a CloudWatch metric for the `Dimensions` property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html) property type. Duplicate dimensions are not allowed.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" targetTrackingMetricDimensionProperty := &TargetTrackingMetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }
type CfnScalingPolicy_TargetTrackingMetricProperty ¶ added in v2.109.0
type CfnScalingPolicy_TargetTrackingMetricProperty struct { // The dimensions for the metric. // // For the list of available dimensions, see the AWS documentation available from the table in [AWS services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide* . // // Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetric-dimensions // Dimensions interface{} `field:"optional" json:"dimensions" yaml:"dimensions"` // The name of the metric. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetric-metricname // MetricName *string `field:"optional" json:"metricName" yaml:"metricName"` // The namespace of the metric. // // For more information, see the table in [AWS services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetric-namespace // Namespace *string `field:"optional" json:"namespace" yaml:"namespace"` }
Represents a specific metric for a target tracking scaling policy for Application Auto Scaling.
Metric is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html) property type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" targetTrackingMetricProperty := &TargetTrackingMetricProperty{ Dimensions: []interface{}{ &TargetTrackingMetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Namespace: jsii.String("namespace"), }
type CfnScalingPolicy_TargetTrackingMetricStatProperty ¶ added in v2.109.0
type CfnScalingPolicy_TargetTrackingMetricStatProperty struct { // The CloudWatch metric to return, including the metric name, namespace, and dimensions. // // To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricstat-metric // Metric interface{} `field:"optional" json:"metric" yaml:"metric"` // The statistic to return. // // It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide* . // // The most commonly used metric for scaling is `Average` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricstat-stat // Stat *string `field:"optional" json:"stat" yaml:"stat"` // The unit to use for the returned data points. // // For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricstat-unit // Unit *string `field:"optional" json:"unit" yaml:"unit"` }
This structure defines the CloudWatch metric to return, along with the statistic and unit.
`TargetTrackingMetricStat` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html) property type.
For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" targetTrackingMetricStatProperty := &TargetTrackingMetricStatProperty{ Metric: &TargetTrackingMetricProperty{ Dimensions: []interface{}{ &TargetTrackingMetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Namespace: jsii.String("namespace"), }, Stat: jsii.String("stat"), Unit: jsii.String("unit"), }
type CfnScalingPolicy_TargetTrackingScalingPolicyConfigurationProperty ¶
type CfnScalingPolicy_TargetTrackingScalingPolicyConfigurationProperty struct { // The target value for the metric. // // Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-targetvalue // TargetValue *float64 `field:"required" json:"targetValue" yaml:"targetValue"` // A customized metric. // // You can specify either a predefined metric or a customized metric. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-customizedmetricspecification // CustomizedMetricSpecification interface{} `field:"optional" json:"customizedMetricSpecification" yaml:"customizedMetricSpecification"` // Indicates whether scale in by the target tracking scaling policy is disabled. // // If the value is `true` , scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-disablescalein // DisableScaleIn interface{} `field:"optional" json:"disableScaleIn" yaml:"disableScaleIn"` // A predefined metric. // // You can specify either a predefined metric or a customized metric. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-predefinedmetricspecification // PredefinedMetricSpecification interface{} `field:"optional" json:"predefinedMetricSpecification" yaml:"predefinedMetricSpecification"` // The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. // // For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-scaleincooldown // ScaleInCooldown *float64 `field:"optional" json:"scaleInCooldown" yaml:"scaleInCooldown"` // The amount of time, in seconds, to wait for a previous scale-out activity to take effect. // // For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-scaleoutcooldown // ScaleOutCooldown *float64 `field:"optional" json:"scaleOutCooldown" yaml:"scaleOutCooldown"` }
`TargetTrackingScalingPolicyConfiguration` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a target tracking scaling policy configuration for Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization remains at or near the target utilization value.
For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) in the *Application Auto Scaling User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" targetTrackingScalingPolicyConfigurationProperty := &TargetTrackingScalingPolicyConfigurationProperty{ TargetValue: jsii.Number(123), // the properties below are optional CustomizedMetricSpecification: &CustomizedMetricSpecificationProperty{ Dimensions: []interface{}{ &MetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Metrics: []interface{}{ &TargetTrackingMetricDataQueryProperty{ Expression: jsii.String("expression"), Id: jsii.String("id"), Label: jsii.String("label"), MetricStat: &TargetTrackingMetricStatProperty{ Metric: &TargetTrackingMetricProperty{ Dimensions: []interface{}{ &TargetTrackingMetricDimensionProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, MetricName: jsii.String("metricName"), Namespace: jsii.String("namespace"), }, Stat: jsii.String("stat"), Unit: jsii.String("unit"), }, ReturnData: jsii.Boolean(false), }, }, Namespace: jsii.String("namespace"), Statistic: jsii.String("statistic"), Unit: jsii.String("unit"), }, DisableScaleIn: jsii.Boolean(false), PredefinedMetricSpecification: &PredefinedMetricSpecificationProperty{ PredefinedMetricType: jsii.String("predefinedMetricType"), // the properties below are optional ResourceLabel: jsii.String("resourceLabel"), }, ScaleInCooldown: jsii.Number(123), ScaleOutCooldown: jsii.Number(123), }
type CronOptions ¶
type CronOptions struct { // The day of the month to run this rule at. // Default: - Every day of the month. // Day *string `field:"optional" json:"day" yaml:"day"` // The hour to run this rule at. // Default: - Every hour. // Hour *string `field:"optional" json:"hour" yaml:"hour"` // The minute to run this rule at. // Default: - Every minute. // Minute *string `field:"optional" json:"minute" yaml:"minute"` // The month to run this rule at. // Default: - Every month. // Month *string `field:"optional" json:"month" yaml:"month"` // The day of the week to run this rule at. // Default: - Any day of the week. // WeekDay *string `field:"optional" json:"weekDay" yaml:"weekDay"` // The year to run this rule at. // Default: - Every year. // Year *string `field:"optional" json:"year" yaml:"year"` }
Options to configure a cron expression.
All fields are strings so you can use complex expressions. Absence of a field implies '*' or '?', whichever one is appropriate.
Example:
var cluster cluster loadBalancedFargateService := ecsPatterns.NewApplicationLoadBalancedFargateService(this, jsii.String("Service"), &ApplicationLoadBalancedFargateServiceProps{ Cluster: Cluster, MemoryLimitMiB: jsii.Number(1024), DesiredCount: jsii.Number(1), Cpu: jsii.Number(512), TaskImageOptions: &ApplicationLoadBalancedTaskImageOptions{ Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")), }, }) scalableTarget := loadBalancedFargateService.Service.AutoScaleTaskCount(&EnableScalingProps{ MinCapacity: jsii.Number(5), MaxCapacity: jsii.Number(20), }) scalableTarget.ScaleOnSchedule(jsii.String("DaytimeScaleDown"), &ScalingSchedule{ Schedule: appscaling.Schedule_Cron(&CronOptions{ Hour: jsii.String("8"), Minute: jsii.String("0"), }), MinCapacity: jsii.Number(1), }) scalableTarget.ScaleOnSchedule(jsii.String("EveningRushScaleUp"), &ScalingSchedule{ Schedule: appscaling.Schedule_*Cron(&CronOptions{ Hour: jsii.String("20"), Minute: jsii.String("0"), }), MinCapacity: jsii.Number(10), })
See: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions
type EnableScalingProps ¶
type EnableScalingProps struct { // Maximum capacity to scale to. MaxCapacity *float64 `field:"required" json:"maxCapacity" yaml:"maxCapacity"` // Minimum capacity to scale to. // Default: 1. // MinCapacity *float64 `field:"optional" json:"minCapacity" yaml:"minCapacity"` }
Properties for enabling Application Auto Scaling.
Example:
var cluster cluster loadBalancedFargateService := ecsPatterns.NewApplicationLoadBalancedFargateService(this, jsii.String("Service"), &ApplicationLoadBalancedFargateServiceProps{ Cluster: Cluster, MemoryLimitMiB: jsii.Number(1024), DesiredCount: jsii.Number(1), Cpu: jsii.Number(512), TaskImageOptions: &ApplicationLoadBalancedTaskImageOptions{ Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")), }, }) scalableTarget := loadBalancedFargateService.Service.AutoScaleTaskCount(&EnableScalingProps{ MinCapacity: jsii.Number(1), MaxCapacity: jsii.Number(20), }) scalableTarget.ScaleOnCpuUtilization(jsii.String("CpuScaling"), &CpuUtilizationScalingProps{ TargetUtilizationPercent: jsii.Number(50), }) scalableTarget.ScaleOnMemoryUtilization(jsii.String("MemoryScaling"), &MemoryUtilizationScalingProps{ TargetUtilizationPercent: jsii.Number(50), })
type IScalableTarget ¶
type IScalableTarget interface {
awscdk.IResource
ScalableTargetId() *string
}
func ScalableTarget_FromScalableTargetId ¶
func ScalableTarget_FromScalableTargetId(scope constructs.Construct, id *string, scalableTargetId *string) IScalableTarget
type MetricAggregationType ¶
type MetricAggregationType string
How the scaling metric is going to be aggregated.
const ( // Average. MetricAggregationType_AVERAGE MetricAggregationType = "AVERAGE" // Minimum. MetricAggregationType_MINIMUM MetricAggregationType = "MINIMUM" // Maximum. MetricAggregationType_MAXIMUM MetricAggregationType = "MAXIMUM" )
type PredefinedMetric ¶
type PredefinedMetric string
One of the predefined autoscaling metrics.
Example:
shardsScalableTarget := appscaling.NewScalableTarget(this, jsii.String("ElastiCacheRedisShardsScalableTarget"), &ScalableTargetProps{ ServiceNamespace: appscaling.ServiceNamespace_ELASTICACHE, ScalableDimension: jsii.String("elasticache:replication-group:NodeGroups"), MinCapacity: jsii.Number(2), MaxCapacity: jsii.Number(10), ResourceId: jsii.String("replication-group/main-cluster"), }) shardsScalableTarget.ScaleToTrackMetric(jsii.String("ElastiCacheRedisShardsCPUUtilization"), &BasicTargetTrackingScalingPolicyProps{ TargetValue: jsii.Number(20), PredefinedMetric: appscaling.PredefinedMetric_ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION, })
const ( // Average percentage of instances in an AppStream fleet that are being used. PredefinedMetric_APPSTREAM_AVERAGE_CAPACITY_UTILIZATION PredefinedMetric = "APPSTREAM_AVERAGE_CAPACITY_UTILIZATION" // Percentage of provisioned read capacity units utilized by a Keyspaces table. PredefinedMetric_CASSANDRA_READ_CAPACITY_UTILIZATION PredefinedMetric = "CASSANDRA_READ_CAPACITY_UTILIZATION" // Percentage of provisioned write capacity units utilized by a Keyspaces table. PredefinedMetric_CASSANDRA_WRITE_CAPACITY_UTILIZATION PredefinedMetric = "CASSANDRA_WRITE_CAPACITY_UTILIZATION" // Percentage of provisioned inference units utilized by a Comprehend endpoint. PredefinedMetric_COMPREHEND_INFERENCE_UTILIZATION PredefinedMetric = "COMPREHEND_INFERENCE_UTILIZATION" // Average CPU Utilization of read replica instances in a Neptune DB cluster. PredefinedMetric_NEPTURE_READER_AVERAGE_CPU_UTILIZATION PredefinedMetric = "NEPTURE_READER_AVERAGE_CPU_UTILIZATION" // Percentage of provisioned read capacity units consumed by a DynamoDB table. PredefinedMetric_DYNAMODB_READ_CAPACITY_UTILIZATION PredefinedMetric = "DYNAMODB_READ_CAPACITY_UTILIZATION" // Percentage of provisioned write capacity units consumed by a DynamoDB table. // // Suffix `dummy` is necessary due to jsii bug (https://github.com/aws/jsii/issues/2782). // Duplicate values will be dropped, so this suffix is added as a workaround. // The value will be replaced when this enum is used. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_DYNAMODB_WRITE_CAPACITY_UTILIZATION PredefinedMetric = "DYNAMODB_WRITE_CAPACITY_UTILIZATION" // DYANMODB_WRITE_CAPACITY_UTILIZATION. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // // Deprecated: use `PredefinedMetric.DYNAMODB_WRITE_CAPACITY_UTILIZATION` PredefinedMetric_DYANMODB_WRITE_CAPACITY_UTILIZATION PredefinedMetric = "DYANMODB_WRITE_CAPACITY_UTILIZATION" // ALB_REQUEST_COUNT_PER_TARGET. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_ALB_REQUEST_COUNT_PER_TARGET PredefinedMetric = "ALB_REQUEST_COUNT_PER_TARGET" // RDS_READER_AVERAGE_CPU_UTILIZATION. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_RDS_READER_AVERAGE_CPU_UTILIZATION PredefinedMetric = "RDS_READER_AVERAGE_CPU_UTILIZATION" // RDS_READER_AVERAGE_DATABASE_CONNECTIONS. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_RDS_READER_AVERAGE_DATABASE_CONNECTIONS PredefinedMetric = "RDS_READER_AVERAGE_DATABASE_CONNECTIONS" // EC2_SPOT_FLEET_REQUEST_AVERAGE_CPU_UTILIZATION. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_EC2_SPOT_FLEET_REQUEST_AVERAGE_CPU_UTILIZATION PredefinedMetric = "EC2_SPOT_FLEET_REQUEST_AVERAGE_CPU_UTILIZATION" // EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_IN. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_IN PredefinedMetric = "EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_IN" // EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_OUT. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_OUT PredefinedMetric = "EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_OUT" // SAGEMAKER_VARIANT_INVOCATIONS_PER_INSTANCE. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_SAGEMAKER_VARIANT_INVOCATIONS_PER_INSTANCE PredefinedMetric = "SAGEMAKER_VARIANT_INVOCATIONS_PER_INSTANCE" // SAGEMAKER_VARIANT_PROVISIONED_CONCURRENCY_UTILIZATION. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_SAGEMAKER_VARIANT_PROVISIONED_CONCURRENCY_UTILIZATION PredefinedMetric = "SAGEMAKER_VARIANT_PROVISIONED_CONCURRENCY_UTILIZATION" // SAGEMAKER_INFERENCE_COMPONENT_INVOCATIONS_PER_COPY. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_SAGEMAKER_INFERENCE_COMPONENT_INVOCATIONS_PER_COPY PredefinedMetric = "SAGEMAKER_INFERENCE_COMPONENT_INVOCATIONS_PER_COPY" // ECS_SERVICE_AVERAGE_CPU_UTILIZATION. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_ECS_SERVICE_AVERAGE_CPU_UTILIZATION PredefinedMetric = "ECS_SERVICE_AVERAGE_CPU_UTILIZATION" // ECS_SERVICE_AVERAGE_MEMORY_UTILIZATION. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_ECS_SERVICE_AVERAGE_MEMORY_UTILIZATION PredefinedMetric = "ECS_SERVICE_AVERAGE_MEMORY_UTILIZATION" // LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION. // See: https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics.html#monitoring-metrics-concurrency // PredefinedMetric_LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION PredefinedMetric = "LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION" // KAFKA_BROKER_STORAGE_UTILIZATION. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_KAFKA_BROKER_STORAGE_UTILIZATION PredefinedMetric = "KAFKA_BROKER_STORAGE_UTILIZATION" // ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION PredefinedMetric = "ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION" // ELASTICACHE_REPLICA_ENGINE_CPU_UTILIZATION. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_ELASTICACHE_REPLICA_ENGINE_CPU_UTILIZATION PredefinedMetric = "ELASTICACHE_REPLICA_ENGINE_CPU_UTILIZATION" // ELASTICACHE_DATABASE_MEMORY_USAGE_COUNTED_FOR_EVICT_PERCENTAGE. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_ELASTICACHE_DATABASE_MEMORY_USAGE_COUNTED_FOR_EVICT_PERCENTAGE PredefinedMetric = "ELASTICACHE_DATABASE_MEMORY_USAGE_COUNTED_FOR_EVICT_PERCENTAGE" // ELASTICACHE_DATABASE_CAPACITY_USAGE_COUNTED_FOR_EVICT_PERCENTAGE. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html // PredefinedMetric_ELASTICACHE_DATABASE_CAPACITY_USAGE_COUNTED_FOR_EVICT_PERCENTAGE PredefinedMetric = "ELASTICACHE_DATABASE_CAPACITY_USAGE_COUNTED_FOR_EVICT_PERCENTAGE" )
type ScalableTarget ¶
type ScalableTarget interface { awscdk.Resource IScalableTarget // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *awscdk.ResourceEnvironment // The tree node. Node() constructs.Node // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. PhysicalName() *string // The role used to give AutoScaling permissions to your resource. Role() awsiam.IRole // ID of the Scalable Target. // // Example value: `service/ecsStack-MyECSCluster-AB12CDE3F4GH/ecsStack-MyECSService-AB12CDE3F4GH|ecs:service:DesiredCount|ecs`. ScalableTargetId() *string // The stack in which this resource is defined. Stack() awscdk.Stack // Add a policy statement to the role's policy. AddToRolePolicy(statement awsiam.PolicyStatement) // Apply the given removal policy to this resource. // // 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`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. GetResourceNameAttribute(nameAttr *string) *string // Scale out or in, in response to a metric. ScaleOnMetric(id *string, props *BasicStepScalingPolicyProps) StepScalingPolicy // Scale out or in based on time. ScaleOnSchedule(id *string, action *ScalingSchedule) // Scale out or in in order to keep a metric around a target value. ScaleToTrackMetric(id *string, props *BasicTargetTrackingScalingPolicyProps) TargetTrackingScalingPolicy // Returns a string representation of this construct. ToString() *string }
Define a scalable target.
Example:
shardsScalableTarget := appscaling.NewScalableTarget(this, jsii.String("ElastiCacheRedisShardsScalableTarget"), &ScalableTargetProps{ ServiceNamespace: appscaling.ServiceNamespace_ELASTICACHE, ScalableDimension: jsii.String("elasticache:replication-group:NodeGroups"), MinCapacity: jsii.Number(2), MaxCapacity: jsii.Number(10), ResourceId: jsii.String("replication-group/main-cluster"), }) shardsScalableTarget.ScaleToTrackMetric(jsii.String("ElastiCacheRedisShardsCPUUtilization"), &BasicTargetTrackingScalingPolicyProps{ TargetValue: jsii.Number(20), PredefinedMetric: appscaling.PredefinedMetric_ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION, })
func NewScalableTarget ¶
func NewScalableTarget(scope constructs.Construct, id *string, props *ScalableTargetProps) ScalableTarget
type ScalableTargetProps ¶
type ScalableTargetProps struct { // The maximum value that Application Auto Scaling can use to scale a target during a scaling activity. MaxCapacity *float64 `field:"required" json:"maxCapacity" yaml:"maxCapacity"` // The minimum value that Application Auto Scaling can use to scale a target during a scaling activity. MinCapacity *float64 `field:"required" json:"minCapacity" yaml:"minCapacity"` // The resource identifier to associate with this scalable target. // // This string consists of the resource type and unique identifier. // // Example value: `service/ecsStack-MyECSCluster-AB12CDE3F4GH/ecsStack-MyECSService-AB12CDE3F4GH`. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html // ResourceId *string `field:"required" json:"resourceId" yaml:"resourceId"` // The scalable dimension that's associated with the scalable target. // // Specify the service namespace, resource type, and scaling property. // // Example value: `ecs:service:DesiredCount`. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_ScalingPolicy.html // ScalableDimension *string `field:"required" json:"scalableDimension" yaml:"scalableDimension"` // The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. // // For valid AWS service namespace values, see the RegisterScalableTarget // action in the Application Auto Scaling API Reference. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html // ServiceNamespace ServiceNamespace `field:"required" json:"serviceNamespace" yaml:"serviceNamespace"` // Role that allows Application Auto Scaling to modify your scalable target. // Default: A role is automatically created. // Role awsiam.IRole `field:"optional" json:"role" yaml:"role"` }
Properties for a scalable target.
Example:
shardsScalableTarget := appscaling.NewScalableTarget(this, jsii.String("ElastiCacheRedisShardsScalableTarget"), &ScalableTargetProps{ ServiceNamespace: appscaling.ServiceNamespace_ELASTICACHE, ScalableDimension: jsii.String("elasticache:replication-group:NodeGroups"), MinCapacity: jsii.Number(2), MaxCapacity: jsii.Number(10), ResourceId: jsii.String("replication-group/main-cluster"), }) shardsScalableTarget.ScaleToTrackMetric(jsii.String("ElastiCacheRedisShardsCPUUtilization"), &BasicTargetTrackingScalingPolicyProps{ TargetValue: jsii.Number(20), PredefinedMetric: appscaling.PredefinedMetric_ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION, })
type ScalingInterval ¶
type ScalingInterval struct { // The capacity adjustment to apply in this interval. // // The number is interpreted differently based on AdjustmentType: // // - ChangeInCapacity: add the adjustment to the current capacity. // The number can be positive or negative. // - PercentChangeInCapacity: add or remove the given percentage of the current // capacity to itself. The number can be in the range [-100..100]. // - ExactCapacity: set the capacity to this number. The number must // be positive. Change *float64 `field:"required" json:"change" yaml:"change"` // The lower bound of the interval. // // The scaling adjustment will be applied if the metric is higher than this value. // Default: Threshold automatically derived from neighbouring intervals. // Lower *float64 `field:"optional" json:"lower" yaml:"lower"` // The upper bound of the interval. // // The scaling adjustment will be applied if the metric is lower than this value. // Default: Threshold automatically derived from neighbouring intervals. // Upper *float64 `field:"optional" json:"upper" yaml:"upper"` }
A range of metric values in which to apply a certain scaling operation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scalingInterval := &ScalingInterval{ Change: jsii.Number(123), // the properties below are optional Lower: jsii.Number(123), Upper: jsii.Number(123), }
type ScalingSchedule ¶
type ScalingSchedule struct { // When to perform this action. Schedule Schedule `field:"required" json:"schedule" yaml:"schedule"` // When this scheduled action expires. // Default: The rule never expires. // EndTime *time.Time `field:"optional" json:"endTime" yaml:"endTime"` // The new maximum capacity. // // During the scheduled time, the current capacity is above the maximum // capacity, Application Auto Scaling scales in to the maximum capacity. // // At least one of maxCapacity and minCapacity must be supplied. // Default: No new maximum capacity. // MaxCapacity *float64 `field:"optional" json:"maxCapacity" yaml:"maxCapacity"` // The new minimum capacity. // // During the scheduled time, if the current capacity is below the minimum // capacity, Application Auto Scaling scales out to the minimum capacity. // // At least one of maxCapacity and minCapacity must be supplied. // Default: No new minimum capacity. // MinCapacity *float64 `field:"optional" json:"minCapacity" yaml:"minCapacity"` // When this scheduled action becomes active. // Default: The rule is activate immediately. // StartTime *time.Time `field:"optional" json:"startTime" yaml:"startTime"` // The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression. // Default: - UTC. // TimeZone awscdk.TimeZone `field:"optional" json:"timeZone" yaml:"timeZone"` }
A scheduled scaling action.
Example:
var cluster cluster loadBalancedFargateService := ecsPatterns.NewApplicationLoadBalancedFargateService(this, jsii.String("Service"), &ApplicationLoadBalancedFargateServiceProps{ Cluster: Cluster, MemoryLimitMiB: jsii.Number(1024), DesiredCount: jsii.Number(1), Cpu: jsii.Number(512), TaskImageOptions: &ApplicationLoadBalancedTaskImageOptions{ Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")), }, }) scalableTarget := loadBalancedFargateService.Service.AutoScaleTaskCount(&EnableScalingProps{ MinCapacity: jsii.Number(5), MaxCapacity: jsii.Number(20), }) scalableTarget.ScaleOnSchedule(jsii.String("DaytimeScaleDown"), &ScalingSchedule{ Schedule: appscaling.Schedule_Cron(&CronOptions{ Hour: jsii.String("8"), Minute: jsii.String("0"), }), MinCapacity: jsii.Number(1), }) scalableTarget.ScaleOnSchedule(jsii.String("EveningRushScaleUp"), &ScalingSchedule{ Schedule: appscaling.Schedule_*Cron(&CronOptions{ Hour: jsii.String("20"), Minute: jsii.String("0"), }), MinCapacity: jsii.Number(10), })
type Schedule ¶
type Schedule interface { // Retrieve the expression for this schedule. ExpressionString() *string }
Schedule for scheduled scaling actions.
Example:
import "github.com/aws/aws-cdk-go/awscdk" var resource someScalableResource capacity := resource.autoScaleCapacity(&caps{ minCapacity: jsii.Number(1), maxCapacity: jsii.Number(50), }) capacity.scaleOnSchedule(jsii.String("PrescaleInTheMorning"), &scalingSchedule{ Schedule: appscaling.Schedule_Cron(&CronOptions{ Hour: jsii.String("8"), Minute: jsii.String("0"), }), MinCapacity: jsii.Number(20), TimeZone: awscdk.TimeZone_AMERICA_DENVER(), }) capacity.scaleOnSchedule(jsii.String("AllowDownscalingAtNight"), &scalingSchedule{ Schedule: appscaling.Schedule_*Cron(&CronOptions{ Hour: jsii.String("20"), Minute: jsii.String("0"), }), MinCapacity: jsii.Number(1), TimeZone: awscdk.TimeZone_AMERICA_DENVER(), })
func Schedule_At ¶
Construct a Schedule from a moment in time.
func Schedule_Cron ¶
func Schedule_Cron(options *CronOptions) Schedule
Create a schedule from a set of cron fields.
func Schedule_Expression ¶
Construct a schedule from a literal schedule expression.
func Schedule_Rate ¶
func Schedule_Rate(duration awscdk.Duration) Schedule
Construct a schedule from an interval and a time unit.
type ServiceNamespace ¶
type ServiceNamespace string
The service that supports Application AutoScaling.
Example:
shardsScalableTarget := appscaling.NewScalableTarget(this, jsii.String("ElastiCacheRedisShardsScalableTarget"), &ScalableTargetProps{ ServiceNamespace: appscaling.ServiceNamespace_ELASTICACHE, ScalableDimension: jsii.String("elasticache:replication-group:NodeGroups"), MinCapacity: jsii.Number(2), MaxCapacity: jsii.Number(10), ResourceId: jsii.String("replication-group/main-cluster"), }) shardsScalableTarget.ScaleToTrackMetric(jsii.String("ElastiCacheRedisShardsCPUUtilization"), &BasicTargetTrackingScalingPolicyProps{ TargetValue: jsii.Number(20), PredefinedMetric: appscaling.PredefinedMetric_ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION, })
const ( // Elastic Container Service. ServiceNamespace_ECS ServiceNamespace = "ECS" // Elastic Map Reduce. ServiceNamespace_ELASTIC_MAP_REDUCE ServiceNamespace = "ELASTIC_MAP_REDUCE" // Elastic Compute Cloud. ServiceNamespace_EC2 ServiceNamespace = "EC2" // App Stream. ServiceNamespace_APPSTREAM ServiceNamespace = "APPSTREAM" // Dynamo DB. ServiceNamespace_DYNAMODB ServiceNamespace = "DYNAMODB" // Relational Database Service. ServiceNamespace_RDS ServiceNamespace = "RDS" // SageMaker. ServiceNamespace_SAGEMAKER ServiceNamespace = "SAGEMAKER" // Custom Resource. ServiceNamespace_CUSTOM_RESOURCE ServiceNamespace = "CUSTOM_RESOURCE" // Lambda. ServiceNamespace_LAMBDA ServiceNamespace = "LAMBDA" // Comprehend. ServiceNamespace_COMPREHEND ServiceNamespace = "COMPREHEND" // Kafka. ServiceNamespace_KAFKA ServiceNamespace = "KAFKA" // ElastiCache. ServiceNamespace_ELASTICACHE ServiceNamespace = "ELASTICACHE" // Neptune. ServiceNamespace_NEPTUNE ServiceNamespace = "NEPTUNE" )
type StepScalingAction ¶
type StepScalingAction interface { constructs.Construct // The tree node. Node() constructs.Node // ARN of the scaling policy. ScalingPolicyArn() *string // Add an adjusment interval to the ScalingAction. AddAdjustment(adjustment *AdjustmentTier) // Returns a string representation of this construct. ToString() *string }
Define a step scaling action.
This kind of scaling policy adjusts the target capacity in configurable steps. The size of the step is configurable based on the metric's distance to its alarm threshold.
This Action must be used as the target of a CloudWatch alarm to take effect.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" var scalableTarget scalableTarget stepScalingAction := awscdk.Aws_applicationautoscaling.NewStepScalingAction(this, jsii.String("MyStepScalingAction"), &StepScalingActionProps{ ScalingTarget: scalableTarget, // the properties below are optional AdjustmentType: awscdk.*Aws_applicationautoscaling.AdjustmentType_CHANGE_IN_CAPACITY, Cooldown: cdk.Duration_Minutes(jsii.Number(30)), MetricAggregationType: awscdk.*Aws_applicationautoscaling.MetricAggregationType_AVERAGE, MinAdjustmentMagnitude: jsii.Number(123), PolicyName: jsii.String("policyName"), })
func NewStepScalingAction ¶
func NewStepScalingAction(scope constructs.Construct, id *string, props *StepScalingActionProps) StepScalingAction
type StepScalingActionProps ¶
type StepScalingActionProps struct { // The scalable target. ScalingTarget IScalableTarget `field:"required" json:"scalingTarget" yaml:"scalingTarget"` // How the adjustment numbers are interpreted. // Default: ChangeInCapacity. // AdjustmentType AdjustmentType `field:"optional" json:"adjustmentType" yaml:"adjustmentType"` // Grace period after scaling activity. // // For scale out policies, multiple scale outs during the cooldown period are // squashed so that only the biggest scale out happens. // // For scale in policies, subsequent scale ins during the cooldown period are // ignored. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html // // Default: No cooldown period. // Cooldown awscdk.Duration `field:"optional" json:"cooldown" yaml:"cooldown"` // The aggregation type for the CloudWatch metrics. // Default: Average. // MetricAggregationType MetricAggregationType `field:"optional" json:"metricAggregationType" yaml:"metricAggregationType"` // Minimum absolute number to adjust capacity with as result of percentage scaling. // // Only when using AdjustmentType = PercentChangeInCapacity, this number controls // the minimum absolute effect size. // Default: No minimum scaling effect. // MinAdjustmentMagnitude *float64 `field:"optional" json:"minAdjustmentMagnitude" yaml:"minAdjustmentMagnitude"` // A name for the scaling policy. // Default: Automatically generated name. // PolicyName *string `field:"optional" json:"policyName" yaml:"policyName"` }
Properties for a scaling policy.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" var scalableTarget scalableTarget stepScalingActionProps := &StepScalingActionProps{ ScalingTarget: scalableTarget, // the properties below are optional AdjustmentType: awscdk.Aws_applicationautoscaling.AdjustmentType_CHANGE_IN_CAPACITY, Cooldown: cdk.Duration_Minutes(jsii.Number(30)), MetricAggregationType: awscdk.*Aws_applicationautoscaling.MetricAggregationType_AVERAGE, MinAdjustmentMagnitude: jsii.Number(123), PolicyName: jsii.String("policyName"), }
type StepScalingPolicy ¶
type StepScalingPolicy interface { constructs.Construct LowerAction() StepScalingAction LowerAlarm() awscloudwatch.Alarm // The tree node. Node() constructs.Node UpperAction() StepScalingAction UpperAlarm() awscloudwatch.Alarm // Returns a string representation of this construct. ToString() *string }
Define a scaling strategy which scales depending on absolute values of some metric.
You can specify the scaling behavior for various values of the metric.
Implemented using one or more CloudWatch alarms and Step Scaling Policies.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" var metric metric var scalableTarget scalableTarget stepScalingPolicy := awscdk.Aws_applicationautoscaling.NewStepScalingPolicy(this, jsii.String("MyStepScalingPolicy"), &StepScalingPolicyProps{ Metric: metric, ScalingSteps: []scalingInterval{ &scalingInterval{ Change: jsii.Number(123), // the properties below are optional Lower: jsii.Number(123), Upper: jsii.Number(123), }, }, ScalingTarget: scalableTarget, // the properties below are optional AdjustmentType: awscdk.*Aws_applicationautoscaling.AdjustmentType_CHANGE_IN_CAPACITY, Cooldown: cdk.Duration_Minutes(jsii.Number(30)), DatapointsToAlarm: jsii.Number(123), EvaluationPeriods: jsii.Number(123), MetricAggregationType: awscdk.*Aws_applicationautoscaling.MetricAggregationType_AVERAGE, MinAdjustmentMagnitude: jsii.Number(123), })
func NewStepScalingPolicy ¶
func NewStepScalingPolicy(scope constructs.Construct, id *string, props *StepScalingPolicyProps) StepScalingPolicy
type StepScalingPolicyProps ¶
type StepScalingPolicyProps struct { // Metric to scale on. Metric awscloudwatch.IMetric `field:"required" json:"metric" yaml:"metric"` // The intervals for scaling. // // Maps a range of metric values to a particular scaling behavior. // // Must be between 2 and 40 steps. ScalingSteps *[]*ScalingInterval `field:"required" json:"scalingSteps" yaml:"scalingSteps"` // How the adjustment numbers inside 'intervals' are interpreted. // Default: ChangeInCapacity. // AdjustmentType AdjustmentType `field:"optional" json:"adjustmentType" yaml:"adjustmentType"` // Grace period after scaling activity. // // Subsequent scale outs during the cooldown period are squashed so that only // the biggest scale out happens. // // Subsequent scale ins during the cooldown period are ignored. // See: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html // // Default: No cooldown period. // Cooldown awscdk.Duration `field:"optional" json:"cooldown" yaml:"cooldown"` // The number of data points out of the evaluation periods that must be breaching to trigger a scaling action. // // Creates an "M out of N" alarm, where this property is the M and the value set for // `evaluationPeriods` is the N value. // // Only has meaning if `evaluationPeriods != 1`. // Default: - Same as `evaluationPeriods`. // DatapointsToAlarm *float64 `field:"optional" json:"datapointsToAlarm" yaml:"datapointsToAlarm"` // How many evaluation periods of the metric to wait before triggering a scaling action. // // Raising this value can be used to smooth out the metric, at the expense // of slower response times. // // If `datapointsToAlarm` is not set, then all data points in the evaluation period // must meet the criteria to trigger a scaling action. // Default: 1. // EvaluationPeriods *float64 `field:"optional" json:"evaluationPeriods" yaml:"evaluationPeriods"` // Aggregation to apply to all data points over the evaluation periods. // // Only has meaning if `evaluationPeriods != 1`. // Default: - The statistic from the metric if applicable (MIN, MAX, AVERAGE), otherwise AVERAGE. // MetricAggregationType MetricAggregationType `field:"optional" json:"metricAggregationType" yaml:"metricAggregationType"` // Minimum absolute number to adjust capacity with as result of percentage scaling. // // Only when using AdjustmentType = PercentChangeInCapacity, this number controls // the minimum absolute effect size. // Default: No minimum scaling effect. // MinAdjustmentMagnitude *float64 `field:"optional" json:"minAdjustmentMagnitude" yaml:"minAdjustmentMagnitude"` // The scaling target. ScalingTarget IScalableTarget `field:"required" json:"scalingTarget" yaml:"scalingTarget"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" var metric metric var scalableTarget scalableTarget stepScalingPolicyProps := &StepScalingPolicyProps{ Metric: metric, ScalingSteps: []scalingInterval{ &scalingInterval{ Change: jsii.Number(123), // the properties below are optional Lower: jsii.Number(123), Upper: jsii.Number(123), }, }, ScalingTarget: scalableTarget, // the properties below are optional AdjustmentType: awscdk.Aws_applicationautoscaling.AdjustmentType_CHANGE_IN_CAPACITY, Cooldown: cdk.Duration_Minutes(jsii.Number(30)), DatapointsToAlarm: jsii.Number(123), EvaluationPeriods: jsii.Number(123), MetricAggregationType: awscdk.*Aws_applicationautoscaling.MetricAggregationType_AVERAGE, MinAdjustmentMagnitude: jsii.Number(123), }
type TargetTrackingScalingPolicy ¶
type TargetTrackingScalingPolicy interface { constructs.Construct // The tree node. Node() constructs.Node // ARN of the scaling policy. ScalingPolicyArn() *string // Returns a string representation of this construct. ToString() *string }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" var metric metric var scalableTarget scalableTarget targetTrackingScalingPolicy := awscdk.Aws_applicationautoscaling.NewTargetTrackingScalingPolicy(this, jsii.String("MyTargetTrackingScalingPolicy"), &TargetTrackingScalingPolicyProps{ ScalingTarget: scalableTarget, TargetValue: jsii.Number(123), // the properties below are optional CustomMetric: metric, DisableScaleIn: jsii.Boolean(false), PolicyName: jsii.String("policyName"), PredefinedMetric: awscdk.*Aws_applicationautoscaling.PredefinedMetric_APPSTREAM_AVERAGE_CAPACITY_UTILIZATION, ResourceLabel: jsii.String("resourceLabel"), ScaleInCooldown: cdk.Duration_Minutes(jsii.Number(30)), ScaleOutCooldown: cdk.Duration_*Minutes(jsii.Number(30)), })
func NewTargetTrackingScalingPolicy ¶
func NewTargetTrackingScalingPolicy(scope constructs.Construct, id *string, props *TargetTrackingScalingPolicyProps) TargetTrackingScalingPolicy
type TargetTrackingScalingPolicyProps ¶
type TargetTrackingScalingPolicyProps struct { // 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. // Default: false. // DisableScaleIn *bool `field:"optional" json:"disableScaleIn" yaml:"disableScaleIn"` // A name for the scaling policy. // Default: - Automatically generated name. // PolicyName *string `field:"optional" json:"policyName" yaml:"policyName"` // Period after a scale in activity completes before another scale in activity can start. // Default: Duration.seconds(300) for the following scalable targets: ECS services, // Spot Fleet requests, EMR clusters, AppStream 2.0 fleets, Aurora DB clusters, // Amazon SageMaker endpoint variants, Custom resources. For all other scalable // targets, the default value is Duration.seconds(0): DynamoDB tables, DynamoDB // global secondary indexes, Amazon Comprehend document classification endpoints, // Lambda provisioned concurrency. // ScaleInCooldown awscdk.Duration `field:"optional" json:"scaleInCooldown" yaml:"scaleInCooldown"` // Period after a scale out activity completes before another scale out activity can start. // Default: Duration.seconds(300) for the following scalable targets: ECS services, // Spot Fleet requests, EMR clusters, AppStream 2.0 fleets, Aurora DB clusters, // Amazon SageMaker endpoint variants, Custom resources. For all other scalable // targets, the default value is Duration.seconds(0): DynamoDB tables, DynamoDB // global secondary indexes, Amazon Comprehend document classification endpoints, // Lambda provisioned concurrency. // ScaleOutCooldown awscdk.Duration `field:"optional" json:"scaleOutCooldown" yaml:"scaleOutCooldown"` // The target value for the metric. TargetValue *float64 `field:"required" json:"targetValue" yaml:"targetValue"` // A custom metric for application autoscaling. // // The metric must track utilization. Scaling out will happen if the metric is higher than // the target value, scaling in will happen in the metric is lower than the target value. // // Exactly one of customMetric or predefinedMetric must be specified. // Default: - No custom metric. // CustomMetric awscloudwatch.IMetric `field:"optional" json:"customMetric" yaml:"customMetric"` // A predefined metric for application autoscaling. // // The metric must track utilization. Scaling out will happen if the metric is higher than // the target value, scaling in will happen in the metric is lower than the target value. // // Exactly one of customMetric or predefinedMetric must be specified. // Default: - No predefined metrics. // PredefinedMetric PredefinedMetric `field:"optional" json:"predefinedMetric" yaml:"predefinedMetric"` // Identify the resource associated with the metric type. // // Only used for predefined metric ALBRequestCountPerTarget. // // Example value: `app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>`. // Default: - No resource label. // ResourceLabel *string `field:"optional" json:"resourceLabel" yaml:"resourceLabel"` ScalingTarget IScalableTarget `field:"required" json:"scalingTarget" yaml:"scalingTarget"` }
Properties for a concrete TargetTrackingPolicy.
Adds the scalingTarget.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" var metric metric var scalableTarget scalableTarget targetTrackingScalingPolicyProps := &TargetTrackingScalingPolicyProps{ ScalingTarget: scalableTarget, TargetValue: jsii.Number(123), // the properties below are optional CustomMetric: metric, DisableScaleIn: jsii.Boolean(false), PolicyName: jsii.String("policyName"), PredefinedMetric: awscdk.Aws_applicationautoscaling.PredefinedMetric_APPSTREAM_AVERAGE_CAPACITY_UTILIZATION, ResourceLabel: jsii.String("resourceLabel"), ScaleInCooldown: cdk.Duration_Minutes(jsii.Number(30)), ScaleOutCooldown: cdk.Duration_*Minutes(jsii.Number(30)), }
Source Files ¶
- AdjustmentTier.go
- AdjustmentType.go
- BaseScalableAttribute.go
- BaseScalableAttributeProps.go
- BaseScalableAttribute__checks.go
- BaseTargetTrackingProps.go
- BasicStepScalingPolicyProps.go
- BasicTargetTrackingScalingPolicyProps.go
- CfnScalableTarget.go
- CfnScalableTargetProps.go
- CfnScalableTarget_ScalableTargetActionProperty.go
- CfnScalableTarget_ScheduledActionProperty.go
- CfnScalableTarget_SuspendedStateProperty.go
- CfnScalableTarget__checks.go
- CfnScalingPolicy.go
- CfnScalingPolicyProps.go
- CfnScalingPolicy_CustomizedMetricSpecificationProperty.go
- CfnScalingPolicy_MetricDimensionProperty.go
- CfnScalingPolicy_PredefinedMetricSpecificationProperty.go
- CfnScalingPolicy_StepAdjustmentProperty.go
- CfnScalingPolicy_StepScalingPolicyConfigurationProperty.go
- CfnScalingPolicy_TargetTrackingMetricDataQueryProperty.go
- CfnScalingPolicy_TargetTrackingMetricDimensionProperty.go
- CfnScalingPolicy_TargetTrackingMetricProperty.go
- CfnScalingPolicy_TargetTrackingMetricStatProperty.go
- CfnScalingPolicy_TargetTrackingScalingPolicyConfigurationProperty.go
- CfnScalingPolicy__checks.go
- CronOptions.go
- EnableScalingProps.go
- IScalableTarget.go
- MetricAggregationType.go
- PredefinedMetric.go
- ScalableTarget.go
- ScalableTargetProps.go
- ScalableTarget__checks.go
- ScalingInterval.go
- ScalingSchedule.go
- Schedule.go
- Schedule__checks.go
- ServiceNamespace.go
- StepScalingAction.go
- StepScalingActionProps.go
- StepScalingAction__checks.go
- StepScalingPolicy.go
- StepScalingPolicyProps.go
- StepScalingPolicy__checks.go
- TargetTrackingScalingPolicy.go
- TargetTrackingScalingPolicyProps.go
- TargetTrackingScalingPolicy__checks.go
- main.go