Skip to content

AutoScalingGroup

Source code in docs_src/capo_auto_scaling/types/auto_scaling_group.py
class AutoScalingGroup(TypedDict, closed=True):
    auto_scaling_group_name: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The name of the Auto Scaling group.</p>"""
    auto_scaling_group_arn: NotRequired[
        "capo_auto_scaling.types.resource_name.ResourceName"
    ]
    """<p>The Amazon Resource Name (ARN) of the Auto Scaling group.</p>"""
    launch_configuration_name: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The name of the associated launch configuration for the Auto Scaling group.</p>"""
    launch_template: NotRequired[
        "capo_auto_scaling.types.launch_template_specification.LaunchTemplateSpecification"
    ]
    """<p>The launch template for the Auto Scaling group.</p>"""
    mixed_instances_policy: NotRequired[
        "capo_auto_scaling.types.mixed_instances_policy.MixedInstancesPolicy"
    ]
    """<p>The mixed instances policy for the group.</p>"""
    min_size: NotRequired[
        "capo_auto_scaling.types.auto_scaling_group_min_size.AutoScalingGroupMinSize"
    ]
    """<p>The minimum size of the Auto Scaling group.</p>"""
    max_size: NotRequired[
        "capo_auto_scaling.types.auto_scaling_group_max_size.AutoScalingGroupMaxSize"
    ]
    """<p>The maximum size of the Auto Scaling group.</p>"""
    desired_capacity: NotRequired[
        "capo_auto_scaling.types.auto_scaling_group_desired_capacity.AutoScalingGroupDesiredCapacity"
    ]
    """<p>The desired size of the Auto Scaling group.</p>"""
    predicted_capacity: NotRequired[
        "capo_auto_scaling.types.auto_scaling_group_predicted_capacity.AutoScalingGroupPredictedCapacity"
    ]
    """<p>The predicted capacity of the group when it has a predictive scaling policy.</p>"""
    default_cooldown: NotRequired["capo_auto_scaling.types.cooldown.Cooldown"]
    """<p>The duration of the default cooldown period, in seconds, for the Auto Scaling group.</p>"""
    availability_zones: NotRequired[
        "capo_auto_scaling.types.availability_zones.AvailabilityZones"
    ]
    """<p>One or more Availability Zones for the Auto Scaling group.</p>"""
    availability_zone_ids: NotRequired[
        "capo_auto_scaling.types.availability_zone_ids.AvailabilityZoneIds"
    ]
    """<p> The Availability Zone IDs where the Auto Scaling group can launch instances. </p>"""
    load_balancer_names: NotRequired[
        "capo_auto_scaling.types.load_balancer_names.LoadBalancerNames"
    ]
    """<p>One or more load balancers associated with the group.</p>"""
    target_group_ar_ns: NotRequired[
        "capo_auto_scaling.types.target_group_ar_ns.TargetGroupARNs"
    ]
    """<p>The Amazon Resource Names (ARN) of the target groups for your load balancer.</p>"""
    health_check_type: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len32.XmlStringMaxLen32"
    ]
    """<p>One or more comma-separated health check types for the Auto Scaling group.</p>"""
    health_check_grace_period: NotRequired[
        "capo_auto_scaling.types.health_check_grace_period.HealthCheckGracePeriod"
    ]
    """<p>The duration of the health check grace period, in seconds, for the Auto Scaling group.</p>"""
    instances: NotRequired["capo_auto_scaling.types.instances.Instances"]
    """<p>The EC2 instances associated with the Auto Scaling group.</p>"""
    created_time: NotRequired["capo_auto_scaling.types.timestamp_type.TimestampType"]
    """<p>The date and time the Auto Scaling group was created.</p>"""
    suspended_processes: NotRequired[
        "capo_auto_scaling.types.suspended_processes.SuspendedProcesses"
    ]
    """<p>The suspended processes associated with the Auto Scaling group.</p>"""
    placement_group: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The name of the placement group into which to launch EC2 instances for the Auto Scaling group.</p>"""
    vpc_zone_identifier: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len5000.XmlStringMaxLen5000"
    ]
    """<p>One or more comma-separated subnet IDs for the Auto Scaling group.</p>"""
    enabled_metrics: NotRequired[
        "capo_auto_scaling.types.enabled_metrics.EnabledMetrics"
    ]
    """<p>The metrics enabled for the Auto Scaling group.</p>"""
    status: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The current state of the Auto Scaling group when the <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DeleteAutoScalingGroup.html">DeleteAutoScalingGroup</a> operation is in progress.</p>"""
    tags: NotRequired["capo_auto_scaling.types.tag_description_list.TagDescriptionList"]
    """<p>The tags for the Auto Scaling group.</p>"""
    termination_policies: NotRequired[
        "capo_auto_scaling.types.termination_policies.TerminationPolicies"
    ]
    """<p>The termination policies for the Auto Scaling group.</p>"""
    new_instances_protected_from_scale_in: NotRequired[
        "capo_auto_scaling.types.instance_protected.InstanceProtected"
    ]
    """<p>Indicates whether newly launched EC2 instances are protected from termination when scaling in for the Auto Scaling group.</p> <p> For more information about preventing instances from terminating on scale in, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html">Use instance scale-in protection</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>"""
    service_linked_role_arn: NotRequired[
        "capo_auto_scaling.types.resource_name.ResourceName"
    ]
    """<p>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.</p>"""
    max_instance_lifetime: NotRequired[
        "capo_auto_scaling.types.max_instance_lifetime.MaxInstanceLifetime"
    ]
    """<p>The maximum amount of time, in seconds, that an EC2 instance can be in service for the Auto Scaling group.</p>"""
    capacity_rebalance: NotRequired[
        "capo_auto_scaling.types.capacity_rebalance_enabled.CapacityRebalanceEnabled"
    ]
    """<p>Indicates whether Capacity Rebalancing is enabled.</p>"""
    warm_pool_configuration: NotRequired[
        "capo_auto_scaling.types.warm_pool_configuration.WarmPoolConfiguration"
    ]
    """<p>The warm pool for the group.</p>"""
    warm_pool_size: NotRequired["capo_auto_scaling.types.warm_pool_size.WarmPoolSize"]
    """<p>The current size of the warm pool.</p>"""
    context: NotRequired["capo_auto_scaling.types.context.Context"]
    """<p>Reserved.</p>"""
    desired_capacity_type: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports <code>DesiredCapacityType</code> for attribute-based instance type selection only.</p>"""
    default_instance_warmup: NotRequired[
        "capo_auto_scaling.types.default_instance_warmup.DefaultInstanceWarmup"
    ]
    """<p>The duration of the default EC2 instance warmup time, in seconds, for the Auto Scaling group.</p>"""
    traffic_sources: NotRequired[
        "capo_auto_scaling.types.traffic_sources.TrafficSources"
    ]
    """<p>The traffic sources associated with this Auto Scaling group.</p>"""
    instance_maintenance_policy: NotRequired[
        "capo_auto_scaling.types.instance_maintenance_policy.InstanceMaintenancePolicy"
    ]
    """<p>An instance maintenance policy.</p>"""
    deletion_protection: NotRequired[
        "capo_auto_scaling.types.deletion_protection.DeletionProtection"
    ]
    """<p>The deletion protection setting for the Auto Scaling group.</p>"""
    availability_zone_distribution: NotRequired[
        "capo_auto_scaling.types.availability_zone_distribution.AvailabilityZoneDistribution"
    ]
    """<p>The EC2 instance capacity distribution across Availability Zones for the Auto Scaling group.</p>"""
    availability_zone_impairment_policy: NotRequired[
        "capo_auto_scaling.types.availability_zone_impairment_policy.AvailabilityZoneImpairmentPolicy"
    ]
    """<p>The Availability Zone impairment policy for the Auto Scaling group.</p>"""
    capacity_reservation_specification: NotRequired[
        "capo_auto_scaling.types.capacity_reservation_specification.CapacityReservationSpecification"
    ]
    """<p>The capacity reservation specification for the Auto Scaling group.</p>"""
    instance_lifecycle_policy: NotRequired[
        "capo_auto_scaling.types.instance_lifecycle_policy.InstanceLifecyclePolicy"
    ]
    """<p>The instance lifecycle policy for the Auto Scaling group.</p>"""
    operator: NotRequired["capo_auto_scaling.types.operator.Operator"]
    """<p>The entity that manages the Auto Scaling group, if applicable. When set, only the designated operator can make changes to the group configuration.</p>"""

auto_scaling_group_arn instance-attribute

auto_scaling_group_arn: NotRequired[ResourceName]

The Amazon Resource Name (ARN) of the Auto Scaling group.

auto_scaling_group_name instance-attribute

auto_scaling_group_name: NotRequired[XmlStringMaxLen255]

The name of the Auto Scaling group.

availability_zone_distribution instance-attribute

availability_zone_distribution: NotRequired[AvailabilityZoneDistribution]

The EC2 instance capacity distribution across Availability Zones for the Auto Scaling group.

availability_zone_ids instance-attribute

availability_zone_ids: NotRequired[AvailabilityZoneIds]

The Availability Zone IDs where the Auto Scaling group can launch instances.

availability_zone_impairment_policy instance-attribute

availability_zone_impairment_policy: NotRequired[AvailabilityZoneImpairmentPolicy]

The Availability Zone impairment policy for the Auto Scaling group.

availability_zones instance-attribute

availability_zones: NotRequired[AvailabilityZones]

One or more Availability Zones for the Auto Scaling group.

capacity_rebalance instance-attribute

capacity_rebalance: NotRequired[CapacityRebalanceEnabled]

Indicates whether Capacity Rebalancing is enabled.

capacity_reservation_specification instance-attribute

capacity_reservation_specification: NotRequired[CapacityReservationSpecification]

The capacity reservation specification for the Auto Scaling group.

context instance-attribute

context: NotRequired[Context]

Reserved.

created_time instance-attribute

created_time: NotRequired[TimestampType]

The date and time the Auto Scaling group was created.

default_cooldown instance-attribute

default_cooldown: NotRequired[Cooldown]

The duration of the default cooldown period, in seconds, for the Auto Scaling group.

default_instance_warmup instance-attribute

default_instance_warmup: NotRequired[DefaultInstanceWarmup]

The duration of the default EC2 instance warmup time, in seconds, for the Auto Scaling group.

deletion_protection instance-attribute

deletion_protection: NotRequired[DeletionProtection]

The deletion protection setting for the Auto Scaling group.

desired_capacity instance-attribute

desired_capacity: NotRequired[AutoScalingGroupDesiredCapacity]

The desired size of the Auto Scaling group.

desired_capacity_type instance-attribute

desired_capacity_type: NotRequired[XmlStringMaxLen255]

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only.

enabled_metrics instance-attribute

enabled_metrics: NotRequired[EnabledMetrics]

The metrics enabled for the Auto Scaling group.

health_check_grace_period instance-attribute

health_check_grace_period: NotRequired[HealthCheckGracePeriod]

The duration of the health check grace period, in seconds, for the Auto Scaling group.

health_check_type instance-attribute

health_check_type: NotRequired[XmlStringMaxLen32]

One or more comma-separated health check types for the Auto Scaling group.

instance_lifecycle_policy instance-attribute

instance_lifecycle_policy: NotRequired[InstanceLifecyclePolicy]

The instance lifecycle policy for the Auto Scaling group.

instance_maintenance_policy instance-attribute

instance_maintenance_policy: NotRequired[InstanceMaintenancePolicy]

An instance maintenance policy.

instances instance-attribute

instances: NotRequired[Instances]

The EC2 instances associated with the Auto Scaling group.

launch_configuration_name instance-attribute

launch_configuration_name: NotRequired[XmlStringMaxLen255]

The name of the associated launch configuration for the Auto Scaling group.

launch_template instance-attribute

launch_template: NotRequired[LaunchTemplateSpecification]

The launch template for the Auto Scaling group.

load_balancer_names instance-attribute

load_balancer_names: NotRequired[LoadBalancerNames]

One or more load balancers associated with the group.

max_instance_lifetime instance-attribute

max_instance_lifetime: NotRequired[MaxInstanceLifetime]

The maximum amount of time, in seconds, that an EC2 instance can be in service for the Auto Scaling group.

max_size instance-attribute

max_size: NotRequired[AutoScalingGroupMaxSize]

The maximum size of the Auto Scaling group.

min_size instance-attribute

min_size: NotRequired[AutoScalingGroupMinSize]

The minimum size of the Auto Scaling group.

mixed_instances_policy instance-attribute

mixed_instances_policy: NotRequired[MixedInstancesPolicy]

The mixed instances policy for the group.

new_instances_protected_from_scale_in instance-attribute

new_instances_protected_from_scale_in: NotRequired[InstanceProtected]

Indicates whether newly launched EC2 instances are protected from termination when scaling in for the Auto Scaling group.

For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.

operator instance-attribute

operator: NotRequired[Operator]

The entity that manages the Auto Scaling group, if applicable. When set, only the designated operator can make changes to the group configuration.

placement_group instance-attribute

placement_group: NotRequired[XmlStringMaxLen255]

The name of the placement group into which to launch EC2 instances for the Auto Scaling group.

predicted_capacity instance-attribute

predicted_capacity: NotRequired[AutoScalingGroupPredictedCapacity]

The predicted capacity of the group when it has a predictive scaling policy.

service_linked_role_arn instance-attribute

service_linked_role_arn: NotRequired[ResourceName]

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.

status instance-attribute

status: NotRequired[XmlStringMaxLen255]

The current state of the Auto Scaling group when the DeleteAutoScalingGroup operation is in progress.

suspended_processes instance-attribute

suspended_processes: NotRequired[SuspendedProcesses]

The suspended processes associated with the Auto Scaling group.

tags instance-attribute

tags: NotRequired[TagDescriptionList]

The tags for the Auto Scaling group.

target_group_ar_ns instance-attribute

target_group_ar_ns: NotRequired[TargetGroupARNs]

The Amazon Resource Names (ARN) of the target groups for your load balancer.

termination_policies instance-attribute

termination_policies: NotRequired[TerminationPolicies]

The termination policies for the Auto Scaling group.

traffic_sources instance-attribute

traffic_sources: NotRequired[TrafficSources]

The traffic sources associated with this Auto Scaling group.

vpc_zone_identifier instance-attribute

vpc_zone_identifier: NotRequired[XmlStringMaxLen5000]

One or more comma-separated subnet IDs for the Auto Scaling group.

warm_pool_configuration instance-attribute

warm_pool_configuration: NotRequired[WarmPoolConfiguration]

The warm pool for the group.

warm_pool_size instance-attribute

warm_pool_size: NotRequired[WarmPoolSize]

The current size of the warm pool.