View on GitHub
AutoScalingPlans Structure Reference
AutoScalingPlans
public struct AutoScalingPlansClient object for interacting with AWS AutoScalingPlans service.
AWS Auto Scaling Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling and predictive scaling for your resources using scaling plans. Use this service in conjunction with the Amazon EC2 Auto Scaling, Application Auto Scaling, Amazon CloudWatch, and AWS CloudFormation services. Currently, predictive scaling is only available for Amazon EC2 Auto Scaling groups. For more information about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the AutoScalingPlans client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Creates a scaling plan.
Declaration
Swift
public func createScalingPlan(_ input: CreateScalingPlanRequest) -> EventLoopFuture<CreateScalingPlanResponse> -
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.
Declaration
Swift
public func deleteScalingPlan(_ input: DeleteScalingPlanRequest) -> EventLoopFuture<DeleteScalingPlanResponse> -
Describes the scalable resources in the specified scaling plan.
Declaration
Swift
public func describeScalingPlanResources(_ input: DescribeScalingPlanResourcesRequest) -> EventLoopFuture<DescribeScalingPlanResourcesResponse> -
Describes one or more of your scaling plans.
Declaration
Swift
public func describeScalingPlans(_ input: DescribeScalingPlansRequest) -> EventLoopFuture<DescribeScalingPlansResponse> -
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.
Declaration
Swift
public func getScalingPlanResourceForecastData(_ input: GetScalingPlanResourceForecastDataRequest) -> EventLoopFuture<GetScalingPlanResourceForecastDataResponse> -
Updates the specified scaling plan. You cannot update a scaling plan if it is in the process of being created, updated, or deleted.
Declaration
Swift
public func updateScalingPlan(_ input: UpdateScalingPlanRequest) -> EventLoopFuture<UpdateScalingPlanResponse>
-
Undocumented
See moreDeclaration
Swift
public enum ForecastDataType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum LoadMetricType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum MetricStatistic : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PolicyType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PredictiveScalingMaxCapacityBehavior : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PredictiveScalingMode : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ScalableDimension : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ScalingMetricType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ScalingPlanStatusCode : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ScalingPolicyUpdateBehavior : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ScalingStatusCode : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ServiceNamespace : String, CustomStringConvertible, Codable