Class: Aws::AutoScalingPlans::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AutoScalingPlans::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/client.rb
Overview
An API client for AutoScalingPlans. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::AutoScalingPlans::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_scaling_plan(params = {}) ⇒ Types::CreateScalingPlanResponse
Creates a scaling plan.
-
#delete_scaling_plan(params = {}) ⇒ Struct
Deletes the specified scaling plan.
-
#describe_scaling_plan_resources(params = {}) ⇒ Types::DescribeScalingPlanResourcesResponse
Describes the scalable resources in the specified scaling plan.
-
#describe_scaling_plans(params = {}) ⇒ Types::DescribeScalingPlansResponse
Describes one or more of your scaling plans.
-
#get_scaling_plan_resource_forecast_data(params = {}) ⇒ Types::GetScalingPlanResourceForecastDataResponse
Retrieves the forecast data for a scalable resource.
-
#update_scaling_plan(params = {}) ⇒ Struct
Updates the specified scaling plan.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
Parameters:
- options (Hash)
Options Hash (options):
-
:credentials
(required, Aws::CredentialProvider)
—
Your AWS credentials. This can be an instance of any one of the following classes:
Aws::Credentials
- Used for configuring static, non-refreshing credentials.Aws::SharedCredentials
- Used for loading static credentials from a shared file, such as~/.aws/config
.Aws::AssumeRoleCredentials
- Used when you need to assume a role.Aws::AssumeRoleWebIdentityCredentials
- Used when you need to assume a role after providing credentials via the web.Aws::SSOCredentials
- Used for loading credentials from AWS SSO using an access token generated fromaws login
.Aws::ProcessCredentials
- Used for loading credentials from a process that outputs to stdout.Aws::InstanceProfileCredentials
- Used for loading credentials from an EC2 IMDS on an EC2 instance.Aws::ECSCredentials
- Used for loading credentials from instances running in ECS.Aws::CognitoIdentityCredentials
- Used for loading credentials from the Cognito Identity service.
When
:credentials
are not configured directly, the following locations will be searched for credentials:Aws.config[:credentials]
- The
:access_key_id
,:secret_access_key
, and:session_token
options. - ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
~/.aws/credentials
~/.aws/config
- EC2/ECS IMDS instance profile - When used by default, the timeouts
are very aggressive. Construct and pass an instance of
Aws::InstanceProfileCredentails
orAws::ECSCredentials
to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
-
:region
(required, String)
—
The AWS region to connect to. The configured
:region
is used to determine the service:endpoint
. When not passed, a default:region
is searched for in the following locations:Aws.config[:region]
ENV['AWS_REGION']
ENV['AMAZON_REGION']
ENV['AWS_DEFAULT_REGION']
~/.aws/credentials
~/.aws/config
- :access_key_id (String)
-
:active_endpoint_cache
(Boolean)
— default:
false
—
When set to
true
, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults tofalse
. -
:adaptive_retry_wait_to_fill
(Boolean)
— default:
true
—
Used only in
adaptive
retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise aRetryCapacityNotAvailableError
and will not retry instead of sleeping. -
:client_side_monitoring
(Boolean)
— default:
false
—
When
true
, client-side metrics will be collected for all API requests from this client. -
:client_side_monitoring_client_id
(String)
— default:
""
—
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
-
:client_side_monitoring_host
(String)
— default:
"127.0.0.1"
—
Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_port
(Integer)
— default:
31000
—
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_publisher
(Aws::ClientSideMonitoring::Publisher)
— default:
Aws::ClientSideMonitoring::Publisher
—
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
-
:convert_params
(Boolean)
— default:
true
—
When
true
, an attempt is made to coerce request parameters into the required types. -
:correct_clock_skew
(Boolean)
— default:
true
—
Used only in
standard
and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. -
:defaults_mode
(String)
— default:
"legacy"
—
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
-
:disable_host_prefix_injection
(Boolean)
— default:
false
—
Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
-
:endpoint
(String)
—
The client endpoint is normally constructed from the
:region
option. You should only configure an:endpoint
when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. -
:endpoint_cache_max_entries
(Integer)
— default:
1000
—
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
-
:endpoint_cache_max_threads
(Integer)
— default:
10
—
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
-
:endpoint_cache_poll_interval
(Integer)
— default:
60
—
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
-
:endpoint_discovery
(Boolean)
— default:
false
—
When set to
true
, endpoint discovery will be enabled for operations when available. -
:log_formatter
(Aws::Log::Formatter)
— default:
Aws::Log::Formatter.default
—
The log formatter.
-
:log_level
(Symbol)
— default:
:info
—
The log level to send messages to the
:logger
at. -
:logger
(Logger)
—
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
-
:max_attempts
(Integer)
— default:
3
—
An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in
standard
andadaptive
retry modes. -
:profile
(String)
— default:
"default"
—
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.
-
:retry_backoff
(Proc)
—
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the
legacy
retry mode. -
:retry_base_delay
(Float)
— default:
0.3
—
The base delay in seconds used by the default backoff function. This option is only used in the
legacy
retry mode. -
:retry_jitter
(Symbol)
— default:
:none
—
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the
legacy
retry mode.@see https://www.awsarchitectureblog.com/2015/03/backoff.html
-
:retry_limit
(Integer)
— default:
3
—
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the
legacy
retry mode. -
:retry_max_delay
(Integer)
— default:
0
—
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the
legacy
retry mode. -
:retry_mode
(String)
— default:
"legacy"
—
Specifies which retry algorithm to use. Values are:
legacy
- The pre-existing retry behavior. This is default value if no retry mode is provided.standard
- A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.adaptive
- An experimental retry mode that includes all the functionality ofstandard
mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
- :secret_access_key (String)
- :session_token (String)
-
:simple_json
(Boolean)
— default:
false
—
Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.
When
:simple_json
is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. -
:stub_responses
(Boolean)
— default:
false
—
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.
Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
-
:token_provider
(Aws::TokenProvider)
—
A Bearer Token Provider. This can be an instance of any one of the following classes:
Aws::StaticTokenProvider
- Used for configuring static, non-refreshing tokens.Aws::SSOTokenProvider
- Used for loading tokens from AWS SSO using an access token generated fromaws login
.
When
:token_provider
is not configured directly, theAws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files. -
:use_dualstack_endpoint
(Boolean)
—
When set to
true
, dualstack enabled endpoints (with.aws
TLD) will be used if available. -
:use_fips_endpoint
(Boolean)
—
When set to
true
, fips compatible endpoints will be used if available. When afips
region is used, the region is normalized and this config is set totrue
. -
:validate_params
(Boolean)
— default:
true
—
When
true
, request parameters are validated before sending the request. -
:endpoint_provider
(Aws::AutoScalingPlans::EndpointProvider)
—
The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters)
whereparameters
is a Struct similar toAws::AutoScalingPlans::EndpointParameters
-
:http_proxy
(URI::HTTP, String)
—
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
-
:http_open_timeout
(Float)
— default:
15
—
The number of seconds to wait when opening a HTTP session before raising a
Timeout::Error
. -
:http_read_timeout
(Float)
— default:
60
—
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
-
:http_idle_timeout
(Float)
— default:
5
—
The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
-
:http_continue_timeout
(Float)
— default:
1
—
The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to
nil
which disables this behaviour. This value can safely be set per request on the session. -
:ssl_timeout
(Float)
— default:
nil
—
Sets the SSL timeout in seconds.
-
:http_wire_trace
(Boolean)
— default:
false
—
When
true
, HTTP debug output will be sent to the:logger
. -
:ssl_verify_peer
(Boolean)
— default:
true
—
When
true
, SSL peer certificates are verified when establishing a connection. -
:ssl_ca_bundle
(String)
—
Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass
:ssl_ca_bundle
or:ssl_ca_directory
the the system default will be used if available. -
:ssl_ca_directory
(String)
—
Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass
:ssl_ca_bundle
or:ssl_ca_directory
the the system default will be used if available.
375 376 377 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/client.rb', line 375 def initialize(*args) super end |
Instance Method Details
#create_scaling_plan(params = {}) ⇒ Types::CreateScalingPlanResponse
Creates a scaling plan.
Examples:
Request syntax with placeholder values
resp = client.create_scaling_plan({
scaling_plan_name: "ScalingPlanName", # required
application_source: { # required
cloud_formation_stack_arn: "XmlString",
tag_filters: [
{
key: "XmlStringMaxLen128",
values: ["XmlStringMaxLen256"],
},
],
},
scaling_instructions: [ # required
{
service_namespace: "autoscaling", # required, accepts autoscaling, ecs, ec2, rds, dynamodb
resource_id: "ResourceIdMaxLen1600", # required
scalable_dimension: "autoscaling:autoScalingGroup:DesiredCapacity", # required, accepts autoscaling:autoScalingGroup:DesiredCapacity, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits
min_capacity: 1, # required
max_capacity: 1, # required
target_tracking_configurations: [ # required
{
predefined_scaling_metric_specification: {
predefined_scaling_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut
resource_label: "ResourceLabel",
},
customized_scaling_metric_specification: {
metric_name: "MetricName", # required
namespace: "MetricNamespace", # required
dimensions: [
{
name: "MetricDimensionName", # required
value: "MetricDimensionValue", # required
},
],
statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
unit: "MetricUnit",
},
target_value: 1.0, # required
disable_scale_in: false,
scale_out_cooldown: 1,
scale_in_cooldown: 1,
estimated_instance_warmup: 1,
},
],
predefined_load_metric_specification: {
predefined_load_metric_type: "ASGTotalCPUUtilization", # required, accepts ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut, ALBTargetGroupRequestCount
resource_label: "ResourceLabel",
},
customized_load_metric_specification: {
metric_name: "MetricName", # required
namespace: "MetricNamespace", # required
dimensions: [
{
name: "MetricDimensionName", # required
value: "MetricDimensionValue", # required
},
],
statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
unit: "MetricUnit",
},
scheduled_action_buffer_time: 1,
predictive_scaling_max_capacity_behavior: "SetForecastCapacityToMaxCapacity", # accepts SetForecastCapacityToMaxCapacity, SetMaxCapacityToForecastCapacity, SetMaxCapacityAboveForecastCapacity
predictive_scaling_max_capacity_buffer: 1,
predictive_scaling_mode: "ForecastAndScale", # accepts ForecastAndScale, ForecastOnly
scaling_policy_update_behavior: "KeepExternalPolicies", # accepts KeepExternalPolicies, ReplaceExternalPolicies
disable_dynamic_scaling: false,
},
],
})
Response structure
resp.scaling_plan_version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:scaling_plan_name
(required, String)
—
The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
-
:application_source
(required, Types::ApplicationSource)
—
A CloudFormation stack or set of tags. You can create one scaling plan per application source.
For more information, see ApplicationSource in the AWS Auto Scaling API Reference.
-
:scaling_instructions
(required, Array<Types::ScalingInstruction>)
—
The scaling instructions.
For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.
Returns:
-
(Types::CreateScalingPlanResponse)
—
Returns a response object which responds to the following methods:
- #scaling_plan_version => Integer
See Also:
491 492 493 494 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/client.rb', line 491 def create_scaling_plan(params = {}, options = {}) req = build_request(:create_scaling_plan, params) req.send_request(options) end |
#delete_scaling_plan(params = {}) ⇒ Struct
Deletes the specified scaling plan.
Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.
If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.
Examples:
Request syntax with placeholder values
resp = client.delete_scaling_plan({
scaling_plan_name: "ScalingPlanName", # required
scaling_plan_version: 1, # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:scaling_plan_name
(required, String)
—
The name of the scaling plan.
-
:scaling_plan_version
(required, Integer)
—
The version number of the scaling plan. Currently, the only valid value is
1
.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
524 525 526 527 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/client.rb', line 524 def delete_scaling_plan(params = {}, options = {}) req = build_request(:delete_scaling_plan, params) req.send_request(options) end |
#describe_scaling_plan_resources(params = {}) ⇒ Types::DescribeScalingPlanResourcesResponse
Describes the scalable resources in the specified scaling plan.
Examples:
Request syntax with placeholder values
resp = client.describe_scaling_plan_resources({
scaling_plan_name: "ScalingPlanName", # required
scaling_plan_version: 1, # required
max_results: 1,
next_token: "NextToken",
})
Response structure
resp.scaling_plan_resources #=> Array
resp.scaling_plan_resources[0].scaling_plan_name #=> String
resp.scaling_plan_resources[0].scaling_plan_version #=> Integer
resp.scaling_plan_resources[0].service_namespace #=> String, one of "autoscaling", "ecs", "ec2", "rds", "dynamodb"
resp.scaling_plan_resources[0].resource_id #=> String
resp.scaling_plan_resources[0].scalable_dimension #=> String, one of "autoscaling:autoScalingGroup:DesiredCapacity", "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "rds:cluster:ReadReplicaCount", "dynamodb:table:ReadCapacityUnits", "dynamodb:table:WriteCapacityUnits", "dynamodb:index:ReadCapacityUnits", "dynamodb:index:WriteCapacityUnits"
resp.scaling_plan_resources[0].scaling_policies #=> Array
resp.scaling_plan_resources[0].scaling_policies[0].policy_name #=> String
resp.scaling_plan_resources[0].scaling_policies[0].policy_type #=> String, one of "TargetTrackingScaling"
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.predefined_scaling_metric_specification.predefined_scaling_metric_type #=> String, one of "ASGAverageCPUUtilization", "ASGAverageNetworkIn", "ASGAverageNetworkOut", "DynamoDBReadCapacityUtilization", "DynamoDBWriteCapacityUtilization", "ECSServiceAverageCPUUtilization", "ECSServiceAverageMemoryUtilization", "ALBRequestCountPerTarget", "RDSReaderAverageCPUUtilization", "RDSReaderAverageDatabaseConnections", "EC2SpotFleetRequestAverageCPUUtilization", "EC2SpotFleetRequestAverageNetworkIn", "EC2SpotFleetRequestAverageNetworkOut"
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.predefined_scaling_metric_specification.resource_label #=> String
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.metric_name #=> String
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.namespace #=> String
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.dimensions #=> Array
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.dimensions[0].name #=> String
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.dimensions[0].value #=> String
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.unit #=> String
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.target_value #=> Float
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.disable_scale_in #=> Boolean
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.scale_out_cooldown #=> Integer
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.scale_in_cooldown #=> Integer
resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.estimated_instance_warmup #=> Integer
resp.scaling_plan_resources[0].scaling_status_code #=> String, one of "Inactive", "PartiallyActive", "Active"
resp.scaling_plan_resources[0].scaling_status_message #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:scaling_plan_name
(required, String)
—
The name of the scaling plan.
-
:scaling_plan_version
(required, Integer)
—
The version number of the scaling plan. Currently, the only valid value is
1
. -
:max_results
(Integer)
—
The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50.
-
:next_token
(String)
—
The token for the next set of results.
Returns:
-
(Types::DescribeScalingPlanResourcesResponse)
—
Returns a response object which responds to the following methods:
- #scaling_plan_resources => Array<Types::ScalingPlanResource>
- #next_token => String
See Also:
592 593 594 595 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/client.rb', line 592 def describe_scaling_plan_resources(params = {}, options = {}) req = build_request(:describe_scaling_plan_resources, params) req.send_request(options) end |
#describe_scaling_plans(params = {}) ⇒ Types::DescribeScalingPlansResponse
Describes one or more of your scaling plans.
Examples:
Request syntax with placeholder values
resp = client.describe_scaling_plans({
scaling_plan_names: ["ScalingPlanName"],
scaling_plan_version: 1,
application_sources: [
{
cloud_formation_stack_arn: "XmlString",
tag_filters: [
{
key: "XmlStringMaxLen128",
values: ["XmlStringMaxLen256"],
},
],
},
],
max_results: 1,
next_token: "NextToken",
})
Response structure
resp.scaling_plans #=> Array
resp.scaling_plans[0].scaling_plan_name #=> String
resp.scaling_plans[0].scaling_plan_version #=> Integer
resp.scaling_plans[0].application_source.cloud_formation_stack_arn #=> String
resp.scaling_plans[0].application_source.tag_filters #=> Array
resp.scaling_plans[0].application_source.tag_filters[0].key #=> String
resp.scaling_plans[0].application_source.tag_filters[0].values #=> Array
resp.scaling_plans[0].application_source.tag_filters[0].values[0] #=> String
resp.scaling_plans[0].scaling_instructions #=> Array
resp.scaling_plans[0].scaling_instructions[0].service_namespace #=> String, one of "autoscaling", "ecs", "ec2", "rds", "dynamodb"
resp.scaling_plans[0].scaling_instructions[0].resource_id #=> String
resp.scaling_plans[0].scaling_instructions[0].scalable_dimension #=> String, one of "autoscaling:autoScalingGroup:DesiredCapacity", "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "rds:cluster:ReadReplicaCount", "dynamodb:table:ReadCapacityUnits", "dynamodb:table:WriteCapacityUnits", "dynamodb:index:ReadCapacityUnits", "dynamodb:index:WriteCapacityUnits"
resp.scaling_plans[0].scaling_instructions[0].min_capacity #=> Integer
resp.scaling_plans[0].scaling_instructions[0].max_capacity #=> Integer
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations #=> Array
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].predefined_scaling_metric_specification.predefined_scaling_metric_type #=> String, one of "ASGAverageCPUUtilization", "ASGAverageNetworkIn", "ASGAverageNetworkOut", "DynamoDBReadCapacityUtilization", "DynamoDBWriteCapacityUtilization", "ECSServiceAverageCPUUtilization", "ECSServiceAverageMemoryUtilization", "ALBRequestCountPerTarget", "RDSReaderAverageCPUUtilization", "RDSReaderAverageDatabaseConnections", "EC2SpotFleetRequestAverageCPUUtilization", "EC2SpotFleetRequestAverageNetworkIn", "EC2SpotFleetRequestAverageNetworkOut"
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].predefined_scaling_metric_specification.resource_label #=> String
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.metric_name #=> String
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.namespace #=> String
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.dimensions #=> Array
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.dimensions[0].name #=> String
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.dimensions[0].value #=> String
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.unit #=> String
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].target_value #=> Float
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].disable_scale_in #=> Boolean
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].scale_out_cooldown #=> Integer
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].scale_in_cooldown #=> Integer
resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].estimated_instance_warmup #=> Integer
resp.scaling_plans[0].scaling_instructions[0].predefined_load_metric_specification.predefined_load_metric_type #=> String, one of "ASGTotalCPUUtilization", "ASGTotalNetworkIn", "ASGTotalNetworkOut", "ALBTargetGroupRequestCount"
resp.scaling_plans[0].scaling_instructions[0].predefined_load_metric_specification.resource_label #=> String
resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.metric_name #=> String
resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.namespace #=> String
resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.dimensions #=> Array
resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.dimensions[0].name #=> String
resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.dimensions[0].value #=> String
resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.unit #=> String
resp.scaling_plans[0].scaling_instructions[0].scheduled_action_buffer_time #=> Integer
resp.scaling_plans[0].scaling_instructions[0].predictive_scaling_max_capacity_behavior #=> String, one of "SetForecastCapacityToMaxCapacity", "SetMaxCapacityToForecastCapacity", "SetMaxCapacityAboveForecastCapacity"
resp.scaling_plans[0].scaling_instructions[0].predictive_scaling_max_capacity_buffer #=> Integer
resp.scaling_plans[0].scaling_instructions[0].predictive_scaling_mode #=> String, one of "ForecastAndScale", "ForecastOnly"
resp.scaling_plans[0].scaling_instructions[0].scaling_policy_update_behavior #=> String, one of "KeepExternalPolicies", "ReplaceExternalPolicies"
resp.scaling_plans[0].scaling_instructions[0].disable_dynamic_scaling #=> Boolean
resp.scaling_plans[0].status_code #=> String, one of "Active", "ActiveWithProblems", "CreationInProgress", "CreationFailed", "DeletionInProgress", "DeletionFailed", "UpdateInProgress", "UpdateFailed"
resp.scaling_plans[0].status_message #=> String
resp.scaling_plans[0].status_start_time #=> Time
resp.scaling_plans[0].creation_time #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:scaling_plan_names
(Array<String>)
—
The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.
-
:scaling_plan_version
(Integer)
—
The version number of the scaling plan. Currently, the only valid value is
1
.If you specify a scaling plan version, you must also specify a scaling plan name. -
:application_sources
(Array<Types::ApplicationSource>)
—
The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.
-
:max_results
(Integer)
—
The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.
-
:next_token
(String)
—
The token for the next set of results.
Returns:
-
(Types::DescribeScalingPlansResponse)
—
Returns a response object which responds to the following methods:
- #scaling_plans => Array<Types::ScalingPlan>
- #next_token => String
See Also:
704 705 706 707 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/client.rb', line 704 def describe_scaling_plans(params = {}, options = {}) req = build_request(:describe_scaling_plans, params) req.send_request(options) end |
#get_scaling_plan_resource_forecast_data(params = {}) ⇒ Types::GetScalingPlanResourceForecastDataResponse
Retrieves the forecast data for a scalable resource.
Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.
Examples:
Request syntax with placeholder values
resp = client.get_scaling_plan_resource_forecast_data({
scaling_plan_name: "ScalingPlanName", # required
scaling_plan_version: 1, # required
service_namespace: "autoscaling", # required, accepts autoscaling, ecs, ec2, rds, dynamodb
resource_id: "XmlString", # required
scalable_dimension: "autoscaling:autoScalingGroup:DesiredCapacity", # required, accepts autoscaling:autoScalingGroup:DesiredCapacity, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits
forecast_data_type: "CapacityForecast", # required, accepts CapacityForecast, LoadForecast, ScheduledActionMinCapacity, ScheduledActionMaxCapacity
start_time: Time.now, # required
end_time: Time.now, # required
})
Response structure
resp.datapoints #=> Array
resp.datapoints[0].timestamp #=> Time
resp.datapoints[0].value #=> Float
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:scaling_plan_name
(required, String)
—
The name of the scaling plan.
-
:scaling_plan_version
(required, Integer)
—
The version number of the scaling plan. Currently, the only valid value is
1
. -
:service_namespace
(required, String)
—
The namespace of the AWS service. The only valid value is
autoscaling
. -
:resource_id
(required, String)
—
The ID of the resource. This string consists of a prefix (
autoScalingGroup
) followed by the name of a specified Auto Scaling group (my-asg
). Example:autoScalingGroup/my-asg
. -
:scalable_dimension
(required, String)
—
The scalable dimension for the resource. The only valid value is
autoscaling:autoScalingGroup:DesiredCapacity
. -
:forecast_data_type
(required, String)
—
The type of forecast data to get.
LoadForecast
: The load metric forecast.CapacityForecast
: The capacity forecast.ScheduledActionMinCapacity
: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.ScheduledActionMaxCapacity
: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.
-
:start_time
(required, Time, DateTime, Date, Integer, String)
—
The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time.
-
:end_time
(required, Time, DateTime, Date, Integer, String)
—
The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days.
Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.
Returns:
-
(Types::GetScalingPlanResourceForecastDataResponse)
—
Returns a response object which responds to the following methods:
- #datapoints => Array<Types::Datapoint>
See Also:
795 796 797 798 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/client.rb', line 795 def get_scaling_plan_resource_forecast_data(params = {}, options = {}) req = build_request(:get_scaling_plan_resource_forecast_data, params) req.send_request(options) end |
#update_scaling_plan(params = {}) ⇒ Struct
Updates the specified scaling plan.
You cannot update a scaling plan if it is in the process of being created, updated, or deleted.
Examples:
Request syntax with placeholder values
resp = client.update_scaling_plan({
scaling_plan_name: "ScalingPlanName", # required
scaling_plan_version: 1, # required
application_source: {
cloud_formation_stack_arn: "XmlString",
tag_filters: [
{
key: "XmlStringMaxLen128",
values: ["XmlStringMaxLen256"],
},
],
},
scaling_instructions: [
{
service_namespace: "autoscaling", # required, accepts autoscaling, ecs, ec2, rds, dynamodb
resource_id: "ResourceIdMaxLen1600", # required
scalable_dimension: "autoscaling:autoScalingGroup:DesiredCapacity", # required, accepts autoscaling:autoScalingGroup:DesiredCapacity, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits
min_capacity: 1, # required
max_capacity: 1, # required
target_tracking_configurations: [ # required
{
predefined_scaling_metric_specification: {
predefined_scaling_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut
resource_label: "ResourceLabel",
},
customized_scaling_metric_specification: {
metric_name: "MetricName", # required
namespace: "MetricNamespace", # required
dimensions: [
{
name: "MetricDimensionName", # required
value: "MetricDimensionValue", # required
},
],
statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
unit: "MetricUnit",
},
target_value: 1.0, # required
disable_scale_in: false,
scale_out_cooldown: 1,
scale_in_cooldown: 1,
estimated_instance_warmup: 1,
},
],
predefined_load_metric_specification: {
predefined_load_metric_type: "ASGTotalCPUUtilization", # required, accepts ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut, ALBTargetGroupRequestCount
resource_label: "ResourceLabel",
},
customized_load_metric_specification: {
metric_name: "MetricName", # required
namespace: "MetricNamespace", # required
dimensions: [
{
name: "MetricDimensionName", # required
value: "MetricDimensionValue", # required
},
],
statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
unit: "MetricUnit",
},
scheduled_action_buffer_time: 1,
predictive_scaling_max_capacity_behavior: "SetForecastCapacityToMaxCapacity", # accepts SetForecastCapacityToMaxCapacity, SetMaxCapacityToForecastCapacity, SetMaxCapacityAboveForecastCapacity
predictive_scaling_max_capacity_buffer: 1,
predictive_scaling_mode: "ForecastAndScale", # accepts ForecastAndScale, ForecastOnly
scaling_policy_update_behavior: "KeepExternalPolicies", # accepts KeepExternalPolicies, ReplaceExternalPolicies
disable_dynamic_scaling: false,
},
],
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:scaling_plan_name
(required, String)
—
The name of the scaling plan.
-
:scaling_plan_version
(required, Integer)
—
The version number of the scaling plan. The only valid value is
1
. Currently, you cannot have multiple scaling plan versions. -
:application_source
(Types::ApplicationSource)
—
A CloudFormation stack or set of tags.
For more information, see ApplicationSource in the AWS Auto Scaling API Reference.
-
:scaling_instructions
(Array<Types::ScalingInstruction>)
—
The scaling instructions.
For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
910 911 912 913 |
# File 'gems/aws-sdk-autoscalingplans/lib/aws-sdk-autoscalingplans/client.rb', line 910 def update_scaling_plan(params = {}, options = {}) req = build_request(:update_scaling_plan, params) req.send_request(options) end |