AWSAutoScalingCreateAutoScalingGroupType

Objective-C

@interface AWSAutoScalingCreateAutoScalingGroupType

Swift

class AWSAutoScalingCreateAutoScalingGroupType

  • The name of the Auto Scaling group. This name must be unique per Region per account.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable autoScalingGroupName;

    Swift

    var autoScalingGroupName: String? { get set }

  • A list of Availability Zones where instances in the Auto Scaling group can be created. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier.

    Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable availabilityZones;

    Swift

    var availabilityZones: [String]? { get set }

  • Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see Amazon EC2 Auto Scaling Capacity Rebalancing in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable capacityRebalance;

    Swift

    var capacityRebalance: NSNumber? { get set }

  • Reserved.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable context;

    Swift

    var context: String? { get set }

  • Only needed if you use simple scaling policies.

    The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    Default: 300 seconds

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable defaultCooldown;

    Swift

    var defaultCooldown: NSNumber? { get set }

  • The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

    To manage your warm-up settings at the group level, we recommend that you set the default instance warmup, even if its value is set to 0 seconds. This also optimizes the performance of scaling policies that scale continuously, such as target tracking and step scaling policies.

    If you need to remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a minimum value of 0.

    Default: None

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable defaultInstanceWarmup;

    Swift

    var defaultInstanceWarmup: NSNumber? { get set }

  • The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure auto scaling. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable desiredCapacity;

    Swift

    var desiredCapacity: NSNumber? { get set }

  • The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.

    By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.

    Valid values: units | vcpu | memory-mib

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable desiredCapacityType;

    Swift

    var desiredCapacityType: String? { get set }

  • The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass these health checks after they enter the InService state. For more information, see Health check grace period in the Amazon EC2 Auto Scaling User Guide.

    Default: 0 seconds

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable healthCheckGracePeriod;

    Swift

    var healthCheckGracePeriod: NSNumber? { get set }

  • The service to use for the health checks. The valid values are EC2 (default) and ELB. If you configure an Auto Scaling group to use load balancer (ELB) health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable healthCheckType;

    Swift

    var healthCheckType: String? { get set }

  • The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Creating an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable instanceId;

    Swift

    var instanceId: String? { get set }

  • The name of the launch configuration to use to launch instances.

    Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable launchConfigurationName;

    Swift

    var launchConfigurationName: String? { get set }

  • Parameters used to specify the launch template and version to use to launch instances.

    Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).

    The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSAutoScalingLaunchTemplateSpecification *_Nullable launchTemplate;

    Swift

    var launchTemplate: AWSAutoScalingLaunchTemplateSpecification? { get set }

  • One or more lifecycle hooks for the group, which specify actions to perform when Amazon EC2 Auto Scaling launches or terminates instances.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSAutoScalingLifecycleHookSpecification *> *_Nullable lifecycleHookSpecificationList;

    Swift

    var lifecycleHookSpecificationList: [AWSAutoScalingLifecycleHookSpecification]? { get set }

  • A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs property instead.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable loadBalancerNames;

    Swift

    var loadBalancerNames: [String]? { get set }

  • The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maxInstanceLifetime;

    Swift

    var maxInstanceLifetime: NSNumber? { get set }

  • The maximum size of the group.

    With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maxSize;

    Swift

    var maxSize: NSNumber? { get set }

  • The minimum size of the group.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable minSize;

    Swift

    var minSize: NSNumber? { get set }

  • An embedded object that specifies a mixed instances policy.

    For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSAutoScalingMixedInstancesPolicy *_Nullable mixedInstancesPolicy;

    Swift

    var mixedInstancesPolicy: AWSAutoScalingMixedInstancesPolicy? { get set }

  • Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable latestInstancesProtectedFromScaleIn;

    Swift

    var latestInstancesProtectedFromScaleIn: NSNumber? { get set }

  • The name of an existing placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

    A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable placementGroup;

    Swift

    var placementGroup: String? { get set }

  • The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable serviceLinkedRoleARN;

    Swift

    var serviceLinkedRoleARN: String? { get set }

  • One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSAutoScalingTag *> *_Nullable tags;

    Swift

    var tags: [AWSAutoScalingTag]? { get set }

  • The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group. For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable targetGroupARNs;

    Swift

    var targetGroupARNs: [String]? { get set }

  • A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see Controlling which Auto Scaling instances terminate during scale in in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable terminationPolicies;

    Swift

    var terminationPolicies: [String]? { get set }

  • A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

    Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable VPCZoneIdentifier;

    Swift

    var vpcZoneIdentifier: String? { get set }