@datafire/amazonaws_autoscaling

5.0.0 • Public • Published

@datafire/amazonaws_autoscaling

Client library for Auto Scaling

Installation and Usage

npm install --save @datafire/amazonaws_autoscaling
let amazonaws_autoscaling = require('@datafire/amazonaws_autoscaling').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_autoscaling.AttachInstances({
  "AutoScalingGroupName": ""
}).then(data => {
  console.log(data);
});

Description

Auto Scaling

Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services.

Actions

AttachInstances

amazonaws_autoscaling.AttachInstances({
  "AutoScalingGroupName": ""
}, context)

Input

Output

Output schema unknown

AttachLoadBalancerTargetGroups

amazonaws_autoscaling.AttachLoadBalancerTargetGroups({
  "AutoScalingGroupName": "",
  "TargetGroupARNs": []
}, context)

Input

Output

AttachLoadBalancers

amazonaws_autoscaling.AttachLoadBalancers({
  "AutoScalingGroupName": "",
  "LoadBalancerNames": []
}, context)

Input

Output

CompleteLifecycleAction

amazonaws_autoscaling.CompleteLifecycleAction({
  "LifecycleHookName": "",
  "AutoScalingGroupName": "",
  "LifecycleActionResult": ""
}, context)

Input

Output

CreateAutoScalingGroup

amazonaws_autoscaling.CreateAutoScalingGroup({
  "AutoScalingGroupName": "",
  "MinSize": 0,
  "MaxSize": 0
}, context)

Input

Output

Output schema unknown

CreateLaunchConfiguration

amazonaws_autoscaling.CreateLaunchConfiguration({
  "LaunchConfigurationName": ""
}, context)

Input

Output

Output schema unknown

CreateOrUpdateTags

amazonaws_autoscaling.CreateOrUpdateTags({
  "Tags": []
}, context)

Input

  • input object
    • Tags required Tags

Output

Output schema unknown

DeleteAutoScalingGroup

amazonaws_autoscaling.DeleteAutoScalingGroup({
  "AutoScalingGroupName": ""
}, context)

Input

Output

Output schema unknown

DeleteLaunchConfiguration

amazonaws_autoscaling.DeleteLaunchConfiguration({
  "LaunchConfigurationName": ""
}, context)

Input

  • input object

Output

Output schema unknown

DeleteLifecycleHook

amazonaws_autoscaling.DeleteLifecycleHook({
  "LifecycleHookName": "",
  "AutoScalingGroupName": ""
}, context)

Input

Output

DeleteNotificationConfiguration

amazonaws_autoscaling.DeleteNotificationConfiguration({
  "AutoScalingGroupName": "",
  "TopicARN": ""
}, context)

Input

Output

Output schema unknown

DeletePolicy

amazonaws_autoscaling.DeletePolicy({
  "PolicyName": ""
}, context)

Input

Output

Output schema unknown

DeleteScheduledAction

amazonaws_autoscaling.DeleteScheduledAction({
  "AutoScalingGroupName": "",
  "ScheduledActionName": ""
}, context)

Input

Output

Output schema unknown

DeleteTags

amazonaws_autoscaling.DeleteTags({
  "Tags": []
}, context)

Input

  • input object
    • Tags required Tags

Output

Output schema unknown

DescribeAccountLimits

amazonaws_autoscaling.DescribeAccountLimits({}, context)

Input

  • input object

Output

DescribeAdjustmentTypes

amazonaws_autoscaling.DescribeAdjustmentTypes({}, context)

Input

  • input object

Output

DescribeAutoScalingGroups

amazonaws_autoscaling.DescribeAutoScalingGroups({}, context)

Input

Output

DescribeAutoScalingInstances

amazonaws_autoscaling.DescribeAutoScalingInstances({}, context)

Input

Output

DescribeAutoScalingNotificationTypes

amazonaws_autoscaling.DescribeAutoScalingNotificationTypes({}, context)

Input

  • input object

Output

DescribeLaunchConfigurations

amazonaws_autoscaling.DescribeLaunchConfigurations({}, context)

Input

Output

DescribeLifecycleHookTypes

amazonaws_autoscaling.DescribeLifecycleHookTypes({}, context)

Input

  • input object

Output

DescribeLifecycleHooks

amazonaws_autoscaling.DescribeLifecycleHooks({
  "AutoScalingGroupName": ""
}, context)

Input

Output

DescribeLoadBalancerTargetGroups

amazonaws_autoscaling.DescribeLoadBalancerTargetGroups({
  "AutoScalingGroupName": ""
}, context)

Input

Output

DescribeLoadBalancers

amazonaws_autoscaling.DescribeLoadBalancers({
  "AutoScalingGroupName": ""
}, context)

Input

Output

DescribeMetricCollectionTypes

amazonaws_autoscaling.DescribeMetricCollectionTypes({}, context)

Input

  • input object

Output

DescribeNotificationConfigurations

amazonaws_autoscaling.DescribeNotificationConfigurations({}, context)

Input

Output

DescribePolicies

amazonaws_autoscaling.DescribePolicies({}, context)

Input

Output

DescribeScalingActivities

amazonaws_autoscaling.DescribeScalingActivities({}, context)

Input

Output

DescribeScalingProcessTypes

amazonaws_autoscaling.DescribeScalingProcessTypes({}, context)

Input

  • input object

Output

DescribeScheduledActions

amazonaws_autoscaling.DescribeScheduledActions({}, context)

Input

Output

DescribeTags

amazonaws_autoscaling.DescribeTags({}, context)

Input

Output

DescribeTerminationPolicyTypes

amazonaws_autoscaling.DescribeTerminationPolicyTypes({}, context)

Input

  • input object

Output

DetachInstances

amazonaws_autoscaling.DetachInstances({
  "AutoScalingGroupName": "",
  "ShouldDecrementDesiredCapacity": true
}, context)

Input

Output

DetachLoadBalancerTargetGroups

amazonaws_autoscaling.DetachLoadBalancerTargetGroups({
  "AutoScalingGroupName": "",
  "TargetGroupARNs": []
}, context)

Input

Output

DetachLoadBalancers

amazonaws_autoscaling.DetachLoadBalancers({
  "AutoScalingGroupName": "",
  "LoadBalancerNames": []
}, context)

Input

Output

DisableMetricsCollection

amazonaws_autoscaling.DisableMetricsCollection({
  "AutoScalingGroupName": ""
}, context)

Input

Output

Output schema unknown

EnableMetricsCollection

amazonaws_autoscaling.EnableMetricsCollection({
  "AutoScalingGroupName": "",
  "Granularity": ""
}, context)

Input

Output

Output schema unknown

EnterStandby

amazonaws_autoscaling.EnterStandby({
  "AutoScalingGroupName": "",
  "ShouldDecrementDesiredCapacity": true
}, context)

Input

Output

ExecutePolicy

amazonaws_autoscaling.ExecutePolicy({
  "PolicyName": ""
}, context)

Input

Output

Output schema unknown

ExitStandby

amazonaws_autoscaling.ExitStandby({
  "AutoScalingGroupName": ""
}, context)

Input

Output

PutLifecycleHook

amazonaws_autoscaling.PutLifecycleHook({
  "LifecycleHookName": "",
  "AutoScalingGroupName": ""
}, context)

Input

Output

PutNotificationConfiguration

amazonaws_autoscaling.PutNotificationConfiguration({
  "AutoScalingGroupName": "",
  "TopicARN": "",
  "NotificationTypes": []
}, context)

Input

Output

Output schema unknown

PutScalingPolicy

amazonaws_autoscaling.PutScalingPolicy({
  "AutoScalingGroupName": "",
  "PolicyName": ""
}, context)

Input

Output

PutScheduledUpdateGroupAction

amazonaws_autoscaling.PutScheduledUpdateGroupAction({
  "AutoScalingGroupName": "",
  "ScheduledActionName": ""
}, context)

Input

Output

Output schema unknown

RecordLifecycleActionHeartbeat

amazonaws_autoscaling.RecordLifecycleActionHeartbeat({
  "LifecycleHookName": "",
  "AutoScalingGroupName": ""
}, context)

Input

Output

ResumeProcesses

amazonaws_autoscaling.ResumeProcesses({
  "AutoScalingGroupName": ""
}, context)

Input

Output

Output schema unknown

SetDesiredCapacity

amazonaws_autoscaling.SetDesiredCapacity({
  "AutoScalingGroupName": "",
  "DesiredCapacity": 0
}, context)

Input

Output

Output schema unknown

SetInstanceHealth

amazonaws_autoscaling.SetInstanceHealth({
  "InstanceId": "",
  "HealthStatus": ""
}, context)

Input

Output

Output schema unknown

SetInstanceProtection

amazonaws_autoscaling.SetInstanceProtection({
  "InstanceIds": [],
  "AutoScalingGroupName": "",
  "ProtectedFromScaleIn": true
}, context)

Input

Output

SuspendProcesses

amazonaws_autoscaling.SuspendProcesses({
  "AutoScalingGroupName": ""
}, context)

Input

Output

Output schema unknown

TerminateInstanceInAutoScalingGroup

amazonaws_autoscaling.TerminateInstanceInAutoScalingGroup({
  "InstanceId": "",
  "ShouldDecrementDesiredCapacity": true
}, context)

Input

Output

UpdateAutoScalingGroup

amazonaws_autoscaling.UpdateAutoScalingGroup({
  "AutoScalingGroupName": ""
}, context)

Input

Output

Output schema unknown

Definitions

Activities

ActivitiesType

Activity

ActivityIds

ActivityType

AdjustmentType

  • AdjustmentType object:

    Describes a policy adjustment type.

    For more information, see Dynamic Scaling in the Auto Scaling User Guide.

AdjustmentTypes

Alarm

Alarms

  • Alarms array

AlreadyExistsFault

  • AlreadyExistsFault object: You already have an Auto Scaling group or launch configuration with this name.

AsciiStringMaxLen255

  • AsciiStringMaxLen255 string

AssociatePublicIpAddress

  • AssociatePublicIpAddress boolean

AttachInstancesQuery

AttachLoadBalancerTargetGroupsResultType

  • AttachLoadBalancerTargetGroupsResultType object

AttachLoadBalancerTargetGroupsType

AttachLoadBalancersResultType

  • AttachLoadBalancersResultType object

AttachLoadBalancersType

AutoScalingGroup

AutoScalingGroupDesiredCapacity

  • AutoScalingGroupDesiredCapacity integer

AutoScalingGroupMaxSize

  • AutoScalingGroupMaxSize integer

AutoScalingGroupMinSize

  • AutoScalingGroupMinSize integer

AutoScalingGroupNames

AutoScalingGroupNamesType

AutoScalingGroups

AutoScalingGroupsType

AutoScalingInstanceDetails

AutoScalingInstances

AutoScalingInstancesType

AutoScalingNotificationTypes

AvailabilityZones

BlockDeviceEbsDeleteOnTermination

  • BlockDeviceEbsDeleteOnTermination boolean

BlockDeviceEbsEncrypted

  • BlockDeviceEbsEncrypted boolean

BlockDeviceEbsIops

  • BlockDeviceEbsIops integer

BlockDeviceEbsVolumeSize

  • BlockDeviceEbsVolumeSize integer

BlockDeviceEbsVolumeType

  • BlockDeviceEbsVolumeType string

BlockDeviceMapping

BlockDeviceMappings

ClassicLinkVPCSecurityGroups

CompleteLifecycleActionAnswer

  • CompleteLifecycleActionAnswer object

CompleteLifecycleActionType

Cooldown

  • Cooldown integer

CreateAutoScalingGroupType

CreateLaunchConfigurationType

CreateOrUpdateTagsType

  • CreateOrUpdateTagsType object
    • Tags required Tags

CustomizedMetricSpecification

DeleteAutoScalingGroupType

DeleteLifecycleHookAnswer

  • DeleteLifecycleHookAnswer object

DeleteLifecycleHookType

DeleteNotificationConfigurationType

DeletePolicyType

DeleteScheduledActionType

DeleteTagsType

  • DeleteTagsType object
    • Tags required Tags

DescribeAccountLimitsAnswer

DescribeAdjustmentTypesAnswer

DescribeAutoScalingInstancesType

DescribeAutoScalingNotificationTypesAnswer

DescribeLifecycleHookTypesAnswer

DescribeLifecycleHooksAnswer

DescribeLifecycleHooksType

DescribeLoadBalancerTargetGroupsRequest

DescribeLoadBalancerTargetGroupsResponse

DescribeLoadBalancersRequest

DescribeLoadBalancersResponse

DescribeMetricCollectionTypesAnswer

DescribeNotificationConfigurationsAnswer

DescribeNotificationConfigurationsType

DescribePoliciesType

DescribeScalingActivitiesType

DescribeScheduledActionsType

DescribeTagsType

DescribeTerminationPolicyTypesAnswer

DetachInstancesAnswer

  • DetachInstancesAnswer object

DetachInstancesQuery

DetachLoadBalancerTargetGroupsResultType

  • DetachLoadBalancerTargetGroupsResultType object

DetachLoadBalancerTargetGroupsType

DetachLoadBalancersResultType

  • DetachLoadBalancersResultType object

DetachLoadBalancersType

DisableMetricsCollectionQuery

  • DisableMetricsCollectionQuery object

DisableScaleIn

  • DisableScaleIn boolean

Ebs

EbsOptimized

  • EbsOptimized boolean

EnableMetricsCollectionQuery

EnabledMetric

EnabledMetrics

EnterStandbyAnswer

EnterStandbyQuery

EstimatedInstanceWarmup

  • EstimatedInstanceWarmup integer

ExecutePolicyType

ExitStandbyAnswer

ExitStandbyQuery

Filter

Filters

ForceDelete

  • ForceDelete boolean

GlobalTimeout

  • GlobalTimeout integer

HealthCheckGracePeriod

  • HealthCheckGracePeriod integer

HeartbeatTimeout

  • HeartbeatTimeout integer

HonorCooldown

  • HonorCooldown boolean

Instance

InstanceIds

InstanceMonitoring

  • InstanceMonitoring object: Describes whether detailed monitoring is enabled for the Auto Scaling instances.

InstanceProtected

  • InstanceProtected boolean

Instances

InvalidNextToken

LaunchConfiguration

LaunchConfigurationNameType

  • LaunchConfigurationNameType object

LaunchConfigurationNames

LaunchConfigurationNamesType

LaunchConfigurations

LaunchConfigurationsType

LaunchTemplateName

  • LaunchTemplateName string

LaunchTemplateSpecification

LifecycleActionResult

  • LifecycleActionResult string

LifecycleActionToken

  • LifecycleActionToken string

LifecycleHook

LifecycleHookNames

LifecycleHookSpecification

LifecycleHookSpecifications

LifecycleHooks

LifecycleState

  • LifecycleState string (values: Pending, Pending:Wait, Pending:Proceed, Quarantined, InService, Terminating, Terminating:Wait, Terminating:Proceed, Terminated, Detaching, Detached, EnteringStandby, Standby)

LifecycleTransition

  • LifecycleTransition string

LimitExceededFault

  • LimitExceededFault object: You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

LoadBalancerNames

LoadBalancerState

  • LoadBalancerState object:

    Describes the state of a Classic Load Balancer.

    If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is InService.

    If you attach a load balancer to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all instances in the group are registered with the load balancer. If ELB health checks are enabled for the load balancer, the state transitions to InService after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the Added state.

LoadBalancerStates

LoadBalancerTargetGroupState

  • LoadBalancerTargetGroupState object:

    Describes the state of a target group.

    If you attach a target group to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If ELB health checks are enabled, the state transitions to InService after at least one Auto Scaling instance passes the health check. If EC2 health checks are enabled instead, the target group remains in the Added state.

LoadBalancerTargetGroupStates

MaxNumberOfAutoScalingGroups

  • MaxNumberOfAutoScalingGroups integer

MaxNumberOfLaunchConfigurations

  • MaxNumberOfLaunchConfigurations integer

MaxRecords

  • MaxRecords integer

MetricCollectionType

MetricCollectionTypes

MetricDimension

MetricDimensionName

  • MetricDimensionName string

MetricDimensionValue

  • MetricDimensionValue string

MetricDimensions

MetricGranularityType

  • MetricGranularityType object: Describes a granularity of a metric.

MetricGranularityTypes

MetricName

  • MetricName string

MetricNamespace

  • MetricNamespace string

MetricScale

  • MetricScale number

MetricStatistic

  • MetricStatistic string (values: Average, Minimum, Maximum, SampleCount, Sum)

MetricType

  • MetricType string (values: ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, ALBRequestCountPerTarget)

MetricUnit

  • MetricUnit string

Metrics

MinAdjustmentMagnitude

  • MinAdjustmentMagnitude integer

MinAdjustmentStep

  • MinAdjustmentStep integer

MonitoringEnabled

  • MonitoringEnabled boolean

NoDevice

  • NoDevice boolean

NotificationConfiguration

NotificationConfigurations

NotificationTargetResourceName

  • NotificationTargetResourceName string

NumberOfAutoScalingGroups

  • NumberOfAutoScalingGroups integer

NumberOfLaunchConfigurations

  • NumberOfLaunchConfigurations integer

PoliciesType

PolicyARNType

  • PolicyARNType object: Contains the output of PutScalingPolicy.

PolicyIncrement

  • PolicyIncrement integer

PolicyNames

PolicyTypes

PredefinedMetricSpecification

  • PredefinedMetricSpecification object: Configures a predefined metric for a target tracking policy.

ProcessNames

ProcessType

Processes

ProcessesType

Progress

  • Progress integer

PropagateAtLaunch

  • PropagateAtLaunch boolean

ProtectedFromScaleIn

  • ProtectedFromScaleIn boolean

PutLifecycleHookAnswer

  • PutLifecycleHookAnswer object

PutLifecycleHookType

PutNotificationConfigurationType

PutScalingPolicyType

PutScheduledUpdateGroupActionType

RecordLifecycleActionHeartbeatAnswer

  • RecordLifecycleActionHeartbeatAnswer object

RecordLifecycleActionHeartbeatType

ResourceContentionFault

  • ResourceContentionFault object: You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

ResourceInUseFault

  • ResourceInUseFault object: The operation can't be performed because the resource is in use.

ResourceName

  • ResourceName string

ScalingActivityInProgressFault

  • ScalingActivityInProgressFault object: The operation can't be performed because there are scaling activities in progress.

ScalingActivityStatusCode

  • ScalingActivityStatusCode string (values: PendingSpotBidPlacement, WaitingForSpotInstanceRequestId, WaitingForSpotInstanceId, WaitingForInstanceId, PreInService, InProgress, WaitingForELBConnectionDraining, MidLifecycleAction, WaitingForInstanceWarmup, Successful, Failed, Cancelled)

ScalingPolicies

ScalingPolicy

ScalingProcessQuery

ScheduledActionNames

ScheduledActionsType

ScheduledUpdateGroupAction

ScheduledUpdateGroupActions

SecurityGroups

SetDesiredCapacityType

SetInstanceHealthQuery

SetInstanceProtectionAnswer

  • SetInstanceProtectionAnswer object

SetInstanceProtectionQuery

ShouldDecrementDesiredCapacity

  • ShouldDecrementDesiredCapacity boolean

ShouldRespectGracePeriod

  • ShouldRespectGracePeriod boolean

SpotPrice

  • SpotPrice string

StepAdjustment

  • StepAdjustment object:

    Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.

    For the following examples, suppose that you have an alarm with a breach threshold of 50:

    • If you want the adjustment to be triggered 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.

    • If you want the adjustment to be triggered 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.

    There are a few rules for the step adjustments for your step policy:

    • The ranges of your step adjustments can't overlap or have a gap.

    • At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

    • At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

    • The upper and lower bound can't be null in the same step adjustment.

StepAdjustments

SuspendedProcess

  • SuspendedProcess object: Describes an Auto Scaling process that has been suspended. For more information, see ProcessType.

SuspendedProcesses

Tag

TagDescription

TagDescriptionList

TagKey

  • TagKey string

TagValue

  • TagValue string

Tags

  • Tags array

TagsType

TargetGroupARNs

TargetTrackingConfiguration

TerminateInstanceInAutoScalingGroupType

TerminationPolicies

TimestampType

  • TimestampType string

UpdateAutoScalingGroupType

Values

XmlString

  • XmlString string

XmlStringMaxLen1023

  • XmlStringMaxLen1023 string

XmlStringMaxLen1600

  • XmlStringMaxLen1600 string

XmlStringMaxLen19

  • XmlStringMaxLen19 string

XmlStringMaxLen2047

  • XmlStringMaxLen2047 string

XmlStringMaxLen255

  • XmlStringMaxLen255 string

XmlStringMaxLen32

  • XmlStringMaxLen32 string

XmlStringMaxLen511

  • XmlStringMaxLen511 string

XmlStringMaxLen64

  • XmlStringMaxLen64 string

XmlStringUserData

  • XmlStringUserData string

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_autoscaling

Weekly Downloads

0

Version

5.0.0

License

MIT

Unpacked Size

328 kB

Total Files

5

Last publish

Collaborators

  • datafire