AWSAutoScalingCreateAutoScalingGroupType

@interface AWSAutoScalingCreateAutoScalingGroupType

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

    Declaration

    Objective-C

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

    Swift

    var autoScalingGroupName: String? { get set }

  • One or more Availability Zones for the group. 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 (readwrite, strong, nonatomic)
    NSArray<NSString *> *_Nullable availabilityZones;

    Swift

    var availabilityZones: [String]? { get set }

  • The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.

    For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

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

    Swift

    var defaultCooldown: NSNumber? { get set }

  • The number of Amazon EC2 instances that the Auto Scaling group attempts to maintain. 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 (readwrite, strong, nonatomic) NSNumber *_Nullable desiredCapacity;

    Swift

    var desiredCapacity: NSNumber? { 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. During this time, any health check failures for the instance are ignored. The default value is 0.

    For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide.

    Conditional: This parameter is required if you are adding an ELB health check.

    Declaration

    Objective-C

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

    Swift

    var healthCheckGracePeriod: NSNumber? { get set }

  • The service to use for the health checks. The valid values are EC2 and ELB. The default value is EC2. If you configure an Auto Scaling group to use 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 (readwrite, strong, nonatomic) NSString *_Nullable healthCheckType;

    Swift

    var healthCheckType: String? { get set }

  • The ID of the instance used to create a launch configuration for the group.

    When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.

    For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

    You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.

    Declaration

    Objective-C

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

    Swift

    var instanceId: String? { get set }

  • The name of the launch configuration.

    If you do not specify LaunchConfigurationName, you must specify one of the following parameters: InstanceId, LaunchTemplate, or MixedInstancesPolicy.

    Declaration

    Objective-C

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

    Swift

    var launchConfigurationName: String? { get set }

  • The launch template to use to launch instances.

    For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.

    If you do not specify LaunchTemplate, you must specify one of the following parameters: InstanceId, LaunchConfigurationName, or MixedInstancesPolicy.

    Declaration

    Objective-C

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

    Swift

    var launchTemplate: AWSAutoScalingLaunchTemplateSpecification? { get set }

  • One or more lifecycle hooks.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
    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 and Network Load Balancers, specify a list of target groups using the TargetGroupARNs property instead.

    For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

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

    Swift

    var loadBalancerNames: [String]? { get set }

  • The maximum amount of time, in seconds, that an instance can be in service.

    For more information, see Replacing Auto Scaling Instances Based on Maximum Instance Lifetime in the Amazon EC2 Auto Scaling User Guide.

    Valid Range: Minimum value of 604800.

    Declaration

    Objective-C

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

    Swift

    var maxInstanceLifetime: NSNumber? { get set }

  • The maximum size of the group.

    Declaration

    Objective-C

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

    Swift

    var maxSize: NSNumber? { get set }

  • The minimum size of the group.

    Declaration

    Objective-C

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

    Swift

    var minSize: NSNumber? { get set }

  • An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used.

    The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the parameters that specify the instance configuration information—the launch template and instance types.

    For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

    You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
    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 Instance Protection in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

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

    Swift

    var latestInstancesProtectedFromScaleIn: NSNumber? { get set }

  • The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) 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 AWS 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 (readwrite, strong, nonatomic)
    NSString *_Nullable serviceLinkedRoleARN;

    Swift

    var serviceLinkedRoleARN: String? { get set }

  • One or more tags.

    For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
    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 Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

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

    Swift

    var targetGroupARNs: [String]? { get set }

  • One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.

    For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

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

    Swift

    var terminationPolicies: [String]? { get set }

  • A comma-separated list of subnet IDs for your virtual private cloud (VPC).

    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 (readwrite, strong, nonatomic) NSString *_Nullable VPCZoneIdentifier;

    Swift

    var vpcZoneIdentifier: String? { get set }