Class: AWSCDK::ApplicationAutoScaling::CfnScalingPolicyProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
application_auto_scaling/cfn_scaling_policy_props.rb

Overview

Properties for defining a CfnScalingPolicy.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(policy_name:, policy_type:, predictive_scaling_policy_configuration: nil, resource_id: nil, scalable_dimension: nil, scaling_target_id: nil, service_namespace: nil, step_scaling_policy_configuration: nil, target_tracking_scaling_policy_configuration: nil) ⇒ CfnScalingPolicyProps

Returns a new instance of CfnScalingPolicyProps.

Parameters:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 18

def initialize(policy_name:, policy_type:, predictive_scaling_policy_configuration: nil, resource_id: nil, scalable_dimension: nil, scaling_target_id: nil, service_namespace: nil, step_scaling_policy_configuration: nil, target_tracking_scaling_policy_configuration: nil)
  @policy_name = policy_name
  Jsii::Type.check_type(@policy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyName")
  @policy_type = policy_type
  Jsii::Type.check_type(@policy_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyType")
  @predictive_scaling_policy_configuration = predictive_scaling_policy_configuration.is_a?(Hash) ? ::AWSCDK::ApplicationAutoScaling::CfnScalingPolicy::PredictiveScalingPolicyConfigurationProperty.new(**predictive_scaling_policy_configuration.transform_keys(&:to_sym)) : predictive_scaling_policy_configuration
  Jsii::Type.check_type(@predictive_scaling_policy_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBsaWNhdGlvbmF1dG9zY2FsaW5nLkNmblNjYWxpbmdQb2xpY3kuUHJlZGljdGl2ZVNjYWxpbmdQb2xpY3lDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "predictiveScalingPolicyConfiguration") unless @predictive_scaling_policy_configuration.nil?
  @resource_id = resource_id
  Jsii::Type.check_type(@resource_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceId") unless @resource_id.nil?
  @scalable_dimension = scalable_dimension
  Jsii::Type.check_type(@scalable_dimension, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scalableDimension") unless @scalable_dimension.nil?
  @scaling_target_id = scaling_target_id
  Jsii::Type.check_type(@scaling_target_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBsaWNhdGlvbmF1dG9zY2FsaW5nLklTY2FsYWJsZVRhcmdldFJlZiJ9XX19")), "scalingTargetId") unless @scaling_target_id.nil?
  @service_namespace = service_namespace
  Jsii::Type.check_type(@service_namespace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceNamespace") unless @service_namespace.nil?
  @step_scaling_policy_configuration = step_scaling_policy_configuration.is_a?(Hash) ? ::AWSCDK::ApplicationAutoScaling::CfnScalingPolicy::StepScalingPolicyConfigurationProperty.new(**step_scaling_policy_configuration.transform_keys(&:to_sym)) : step_scaling_policy_configuration
  Jsii::Type.check_type(@step_scaling_policy_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBsaWNhdGlvbmF1dG9zY2FsaW5nLkNmblNjYWxpbmdQb2xpY3kuU3RlcFNjYWxpbmdQb2xpY3lDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "stepScalingPolicyConfiguration") unless @step_scaling_policy_configuration.nil?
  @target_tracking_scaling_policy_configuration = target_tracking_scaling_policy_configuration.is_a?(Hash) ? ::AWSCDK::ApplicationAutoScaling::CfnScalingPolicy::TargetTrackingScalingPolicyConfigurationProperty.new(**target_tracking_scaling_policy_configuration.transform_keys(&:to_sym)) : target_tracking_scaling_policy_configuration
  Jsii::Type.check_type(@target_tracking_scaling_policy_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBsaWNhdGlvbmF1dG9zY2FsaW5nLkNmblNjYWxpbmdQb2xpY3kuVGFyZ2V0VHJhY2tpbmdTY2FsaW5nUG9saWN5Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "targetTrackingScalingPolicyConfiguration") unless @target_tracking_scaling_policy_configuration.nil?
end

Instance Attribute Details

#policy_name ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



45
46
47
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 45

def policy_name
  @policy_name
end

#policy_type ⇒ String (readonly)

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.

PredictiveScaling —Only supported for Amazon ECS

Returns:

  • (String)

See Also:



58
59
60
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 58

def policy_type
  @policy_type
end

#predictive_scaling_policy_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The predictive scaling policy configuration.

Returns:

See Also:



63
64
65
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 63

def predictive_scaling_policy_configuration
  @predictive_scaling_policy_configuration
end

#resource_id ⇒ String? (readonly)

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 .
  • 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 .
  • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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 .

Returns:

  • (String, nil)

See Also:



91
92
93
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 91

def resource_id
  @resource_id
end

#scalable_dimension ⇒ String? (readonly)

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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.

Returns:

  • (String, nil)

See Also:



121
122
123
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 121

def scalable_dimension
  @scalable_dimension
end

#scaling_target_id ⇒ String, ... (readonly)

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.

Returns:

See Also:



130
131
132
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 130

def scaling_target_id
  @scaling_target_id
end

#service_namespace ⇒ String? (readonly)

The namespace of the AWS service that provides the resource, or a custom-resource .

Returns:

  • (String, nil)

See Also:



135
136
137
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 135

def service_namespace
  @service_namespace
end

#step_scaling_policy_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

A step scaling policy.

Returns:

See Also:



140
141
142
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 140

def step_scaling_policy_configuration
  @step_scaling_policy_configuration
end

#target_tracking_scaling_policy_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

A target tracking scaling policy.

Returns:

See Also:



145
146
147
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 145

def target_tracking_scaling_policy_configuration
  @target_tracking_scaling_policy_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 147

def self.jsii_properties
  {
    :policy_name => "policyName",
    :policy_type => "policyType",
    :predictive_scaling_policy_configuration => "predictiveScalingPolicyConfiguration",
    :resource_id => "resourceId",
    :scalable_dimension => "scalableDimension",
    :scaling_target_id => "scalingTargetId",
    :service_namespace => "serviceNamespace",
    :step_scaling_policy_configuration => "stepScalingPolicyConfiguration",
    :target_tracking_scaling_policy_configuration => "targetTrackingScalingPolicyConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'application_auto_scaling/cfn_scaling_policy_props.rb', line 161

def to_jsii
  result = {}
  result.merge!({
    "policyName" => @policy_name,
    "policyType" => @policy_type,
    "predictiveScalingPolicyConfiguration" => @predictive_scaling_policy_configuration,
    "resourceId" => @resource_id,
    "scalableDimension" => @scalable_dimension,
    "scalingTargetId" => @scaling_target_id,
    "serviceNamespace" => @service_namespace,
    "stepScalingPolicyConfiguration" => @step_scaling_policy_configuration,
    "targetTrackingScalingPolicyConfiguration" => @target_tracking_scaling_policy_configuration,
  })
  result.compact
end