CfnAutoScalingGroup

class aws_cdk.aws_autoscaling.CfnAutoScalingGroup(scope, id, *, max_size, min_size, auto_scaling_group_name=None, availability_zones=None, capacity_rebalance=None, context=None, cooldown=None, desired_capacity=None, health_check_grace_period=None, health_check_type=None, instance_id=None, launch_configuration_name=None, launch_template=None, lifecycle_hook_specification_list=None, load_balancer_names=None, max_instance_lifetime=None, metrics_collection=None, mixed_instances_policy=None, new_instances_protected_from_scale_in=None, notification_configurations=None, placement_group=None, service_linked_role_arn=None, tags=None, target_group_arns=None, termination_policies=None, vpc_zone_identifier=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::AutoScaling::AutoScalingGroup.

CloudformationResource

AWS::AutoScaling::AutoScalingGroup

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html

Create a new AWS::AutoScaling::AutoScalingGroup.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • max_size (str) – AWS::AutoScaling::AutoScalingGroup.MaxSize.

  • min_size (str) – AWS::AutoScaling::AutoScalingGroup.MinSize.

  • auto_scaling_group_name (Optional[str]) – AWS::AutoScaling::AutoScalingGroup.AutoScalingGroupName.

  • availability_zones (Optional[Sequence[str]]) – AWS::AutoScaling::AutoScalingGroup.AvailabilityZones.

  • capacity_rebalance (Union[bool, IResolvable, None]) – AWS::AutoScaling::AutoScalingGroup.CapacityRebalance.

  • context (Optional[str]) – AWS::AutoScaling::AutoScalingGroup.Context.

  • cooldown (Optional[str]) – AWS::AutoScaling::AutoScalingGroup.Cooldown.

  • desired_capacity (Optional[str]) – AWS::AutoScaling::AutoScalingGroup.DesiredCapacity.

  • health_check_grace_period (Union[int, float, None]) – AWS::AutoScaling::AutoScalingGroup.HealthCheckGracePeriod.

  • health_check_type (Optional[str]) – AWS::AutoScaling::AutoScalingGroup.HealthCheckType.

  • instance_id (Optional[str]) – AWS::AutoScaling::AutoScalingGroup.InstanceId.

  • launch_configuration_name (Optional[str]) – AWS::AutoScaling::AutoScalingGroup.LaunchConfigurationName.

  • launch_template (Union[IResolvable, LaunchTemplateSpecificationProperty, None]) – AWS::AutoScaling::AutoScalingGroup.LaunchTemplate.

  • lifecycle_hook_specification_list (Union[IResolvable, Sequence[Union[IResolvable, LifecycleHookSpecificationProperty]], None]) – AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecificationList.

  • load_balancer_names (Optional[Sequence[str]]) – AWS::AutoScaling::AutoScalingGroup.LoadBalancerNames.

  • max_instance_lifetime (Union[int, float, None]) – AWS::AutoScaling::AutoScalingGroup.MaxInstanceLifetime.

  • metrics_collection (Union[IResolvable, Sequence[Union[IResolvable, MetricsCollectionProperty]], None]) – AWS::AutoScaling::AutoScalingGroup.MetricsCollection.

  • mixed_instances_policy (Union[IResolvable, MixedInstancesPolicyProperty, None]) – AWS::AutoScaling::AutoScalingGroup.MixedInstancesPolicy.

  • new_instances_protected_from_scale_in (Union[bool, IResolvable, None]) – AWS::AutoScaling::AutoScalingGroup.NewInstancesProtectedFromScaleIn.

  • notification_configurations (Union[IResolvable, Sequence[Union[IResolvable, NotificationConfigurationProperty]], None]) – AWS::AutoScaling::AutoScalingGroup.NotificationConfigurations.

  • placement_group (Optional[str]) – AWS::AutoScaling::AutoScalingGroup.PlacementGroup.

  • service_linked_role_arn (Optional[str]) – AWS::AutoScaling::AutoScalingGroup.ServiceLinkedRoleARN.

  • tags (Optional[Sequence[TagPropertyProperty]]) – AWS::AutoScaling::AutoScalingGroup.Tags.

  • target_group_arns (Optional[Sequence[str]]) – AWS::AutoScaling::AutoScalingGroup.TargetGroupARNs.

  • termination_policies (Optional[Sequence[str]]) – AWS::AutoScaling::AutoScalingGroup.TerminationPolicies.

  • vpc_zone_identifier (Optional[Sequence[str]]) – AWS::AutoScaling::AutoScalingGroup.VPCZoneIdentifier.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AutoScaling::AutoScalingGroup'
auto_scaling_group_name

AWS::AutoScaling::AutoScalingGroup.AutoScalingGroupName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-autoscaling-autoscalinggroup-autoscalinggroupname

Return type

Optional[str]

availability_zones

AWS::AutoScaling::AutoScalingGroup.AvailabilityZones.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-availabilityzones

Return type

Optional[List[str]]

capacity_rebalance

AWS::AutoScaling::AutoScalingGroup.CapacityRebalance.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-capacityrebalance

Return type

Union[bool, IResolvable, None]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

context

AWS::AutoScaling::AutoScalingGroup.Context.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-context

Return type

Optional[str]

cooldown

AWS::AutoScaling::AutoScalingGroup.Cooldown.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-cooldown

Return type

Optional[str]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

desired_capacity

AWS::AutoScaling::AutoScalingGroup.DesiredCapacity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity

Return type

Optional[str]

health_check_grace_period

AWS::AutoScaling::AutoScalingGroup.HealthCheckGracePeriod.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-healthcheckgraceperiod

Return type

Union[int, float, None]

health_check_type

AWS::AutoScaling::AutoScalingGroup.HealthCheckType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-healthchecktype

Return type

Optional[str]

instance_id

AWS::AutoScaling::AutoScalingGroup.InstanceId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-instanceid

Return type

Optional[str]

launch_configuration_name

AWS::AutoScaling::AutoScalingGroup.LaunchConfigurationName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-launchconfigurationname

Return type

Optional[str]

launch_template

AWS::AutoScaling::AutoScalingGroup.LaunchTemplate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-launchtemplate

Return type

Union[IResolvable, LaunchTemplateSpecificationProperty, None]

lifecycle_hook_specification_list

AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecificationList.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecificationlist

Return type

Union[IResolvable, List[Union[IResolvable, LifecycleHookSpecificationProperty]], None]

load_balancer_names

AWS::AutoScaling::AutoScalingGroup.LoadBalancerNames.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-loadbalancernames

Return type

Optional[List[str]]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

max_instance_lifetime

AWS::AutoScaling::AutoScalingGroup.MaxInstanceLifetime.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-maxinstancelifetime

Return type

Union[int, float, None]

max_size

AWS::AutoScaling::AutoScalingGroup.MaxSize.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-maxsize

Return type

str

metrics_collection

AWS::AutoScaling::AutoScalingGroup.MetricsCollection.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-metricscollection

Return type

Union[IResolvable, List[Union[IResolvable, MetricsCollectionProperty]], None]

min_size

AWS::AutoScaling::AutoScalingGroup.MinSize.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-minsize

Return type

str

mixed_instances_policy

AWS::AutoScaling::AutoScalingGroup.MixedInstancesPolicy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-mixedinstancespolicy

Return type

Union[IResolvable, MixedInstancesPolicyProperty, None]

new_instances_protected_from_scale_in

AWS::AutoScaling::AutoScalingGroup.NewInstancesProtectedFromScaleIn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-newinstancesprotectedfromscalein

Return type

Union[bool, IResolvable, None]

node

The construct tree node associated with this construct.

Return type

ConstructNode

notification_configurations

AWS::AutoScaling::AutoScalingGroup.NotificationConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, NotificationConfigurationProperty]], None]

placement_group

AWS::AutoScaling::AutoScalingGroup.PlacementGroup.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-placementgroup

Return type

Optional[str]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

service_linked_role_arn

AWS::AutoScaling::AutoScalingGroup.ServiceLinkedRoleARN.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-autoscaling-autoscalinggroup-servicelinkedrolearn

Return type

Optional[str]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::AutoScaling::AutoScalingGroup.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-tags

Return type

TagManager

target_group_arns

AWS::AutoScaling::AutoScalingGroup.TargetGroupARNs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-targetgrouparns

Return type

Optional[List[str]]

termination_policies

AWS::AutoScaling::AutoScalingGroup.TerminationPolicies.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-termpolicy

Return type

Optional[List[str]]

vpc_zone_identifier

AWS::AutoScaling::AutoScalingGroup.VPCZoneIdentifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-vpczoneidentifier

Return type

Optional[List[str]]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

InstancesDistributionProperty

class CfnAutoScalingGroup.InstancesDistributionProperty(*, on_demand_allocation_strategy=None, on_demand_base_capacity=None, on_demand_percentage_above_base_capacity=None, spot_allocation_strategy=None, spot_instance_pools=None, spot_max_price=None)

Bases: object

Parameters
  • on_demand_allocation_strategy (Optional[str]) – CfnAutoScalingGroup.InstancesDistributionProperty.OnDemandAllocationStrategy.

  • on_demand_base_capacity (Union[int, float, None]) – CfnAutoScalingGroup.InstancesDistributionProperty.OnDemandBaseCapacity.

  • on_demand_percentage_above_base_capacity (Union[int, float, None]) – CfnAutoScalingGroup.InstancesDistributionProperty.OnDemandPercentageAboveBaseCapacity.

  • spot_allocation_strategy (Optional[str]) – CfnAutoScalingGroup.InstancesDistributionProperty.SpotAllocationStrategy.

  • spot_instance_pools (Union[int, float, None]) – CfnAutoScalingGroup.InstancesDistributionProperty.SpotInstancePools.

  • spot_max_price (Optional[str]) – CfnAutoScalingGroup.InstancesDistributionProperty.SpotMaxPrice.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-instancesdistribution.html

Attributes

on_demand_allocation_strategy

CfnAutoScalingGroup.InstancesDistributionProperty.OnDemandAllocationStrategy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-ondemandallocationstrategy

Return type

Optional[str]

on_demand_base_capacity

CfnAutoScalingGroup.InstancesDistributionProperty.OnDemandBaseCapacity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-ondemandbasecapacity

Return type

Union[int, float, None]

on_demand_percentage_above_base_capacity

CfnAutoScalingGroup.InstancesDistributionProperty.OnDemandPercentageAboveBaseCapacity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-ondemandpercentageabovebasecapacity

Return type

Union[int, float, None]

spot_allocation_strategy

CfnAutoScalingGroup.InstancesDistributionProperty.SpotAllocationStrategy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-spotallocationstrategy

Return type

Optional[str]

spot_instance_pools

CfnAutoScalingGroup.InstancesDistributionProperty.SpotInstancePools.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-spotinstancepools

Return type

Union[int, float, None]

spot_max_price

CfnAutoScalingGroup.InstancesDistributionProperty.SpotMaxPrice.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-spotmaxprice

Return type

Optional[str]

LaunchTemplateOverridesProperty

class CfnAutoScalingGroup.LaunchTemplateOverridesProperty(*, instance_type=None, launch_template_specification=None, weighted_capacity=None)

Bases: object

Parameters
  • instance_type (Optional[str]) – CfnAutoScalingGroup.LaunchTemplateOverridesProperty.InstanceType.

  • launch_template_specification (Union[IResolvable, LaunchTemplateSpecificationProperty, None]) – CfnAutoScalingGroup.LaunchTemplateOverridesProperty.LaunchTemplateSpecification.

  • weighted_capacity (Optional[str]) – CfnAutoScalingGroup.LaunchTemplateOverridesProperty.WeightedCapacity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-launchtemplateoverrides.html

Attributes

instance_type

CfnAutoScalingGroup.LaunchTemplateOverridesProperty.InstanceType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-launchtemplateoverrides.html#cfn-autoscaling-autoscalinggroup-launchtemplateoverrides-instancetype

Return type

Optional[str]

launch_template_specification

CfnAutoScalingGroup.LaunchTemplateOverridesProperty.LaunchTemplateSpecification.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-launchtemplateoverrides.html#cfn-autoscaling-autoscalinggroup-launchtemplateoverrides-launchtemplatespecification

Return type

Union[IResolvable, LaunchTemplateSpecificationProperty, None]

weighted_capacity

CfnAutoScalingGroup.LaunchTemplateOverridesProperty.WeightedCapacity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-launchtemplateoverrides.html#cfn-autoscaling-autoscalinggroup-launchtemplateoverrides-weightedcapacity

Return type

Optional[str]

LaunchTemplateProperty

class CfnAutoScalingGroup.LaunchTemplateProperty(*, launch_template_specification, overrides=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-launchtemplate.html

Attributes

launch_template_specification

CfnAutoScalingGroup.LaunchTemplateProperty.LaunchTemplateSpecification.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-launchtemplate.html#cfn-as-group-launchtemplate

Return type

Union[IResolvable, LaunchTemplateSpecificationProperty]

overrides

CfnAutoScalingGroup.LaunchTemplateProperty.Overrides.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-mixedinstancespolicy-launchtemplate.html#cfn-as-mixedinstancespolicy-overrides

Return type

Union[IResolvable, List[Union[IResolvable, LaunchTemplateOverridesProperty]], None]

LaunchTemplateSpecificationProperty

class CfnAutoScalingGroup.LaunchTemplateSpecificationProperty(*, version, launch_template_id=None, launch_template_name=None)

Bases: object

Parameters
  • version (str) – CfnAutoScalingGroup.LaunchTemplateSpecificationProperty.Version.

  • launch_template_id (Optional[str]) – CfnAutoScalingGroup.LaunchTemplateSpecificationProperty.LaunchTemplateId.

  • launch_template_name (Optional[str]) – CfnAutoScalingGroup.LaunchTemplateSpecificationProperty.LaunchTemplateName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html

Attributes

launch_template_id

CfnAutoScalingGroup.LaunchTemplateSpecificationProperty.LaunchTemplateId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html#cfn-autoscaling-autoscalinggroup-launchtemplatespecification-launchtemplateid

Return type

Optional[str]

launch_template_name

CfnAutoScalingGroup.LaunchTemplateSpecificationProperty.LaunchTemplateName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html#cfn-autoscaling-autoscalinggroup-launchtemplatespecification-launchtemplatename

Return type

Optional[str]

version

CfnAutoScalingGroup.LaunchTemplateSpecificationProperty.Version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html#cfn-autoscaling-autoscalinggroup-launchtemplatespecification-version

Return type

str

LifecycleHookSpecificationProperty

class CfnAutoScalingGroup.LifecycleHookSpecificationProperty(*, lifecycle_hook_name, lifecycle_transition, default_result=None, heartbeat_timeout=None, notification_metadata=None, notification_target_arn=None, role_arn=None)

Bases: object

Parameters
  • lifecycle_hook_name (str) – CfnAutoScalingGroup.LifecycleHookSpecificationProperty.LifecycleHookName.

  • lifecycle_transition (str) – CfnAutoScalingGroup.LifecycleHookSpecificationProperty.LifecycleTransition.

  • default_result (Optional[str]) – CfnAutoScalingGroup.LifecycleHookSpecificationProperty.DefaultResult.

  • heartbeat_timeout (Union[int, float, None]) – CfnAutoScalingGroup.LifecycleHookSpecificationProperty.HeartbeatTimeout.

  • notification_metadata (Optional[str]) – CfnAutoScalingGroup.LifecycleHookSpecificationProperty.NotificationMetadata.

  • notification_target_arn (Optional[str]) – CfnAutoScalingGroup.LifecycleHookSpecificationProperty.NotificationTargetARN.

  • role_arn (Optional[str]) – CfnAutoScalingGroup.LifecycleHookSpecificationProperty.RoleARN.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html

Attributes

default_result

CfnAutoScalingGroup.LifecycleHookSpecificationProperty.DefaultResult.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-defaultresult

Return type

Optional[str]

heartbeat_timeout

CfnAutoScalingGroup.LifecycleHookSpecificationProperty.HeartbeatTimeout.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-heartbeattimeout

Return type

Union[int, float, None]

lifecycle_hook_name

CfnAutoScalingGroup.LifecycleHookSpecificationProperty.LifecycleHookName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-lifecyclehookname

Return type

str

lifecycle_transition

CfnAutoScalingGroup.LifecycleHookSpecificationProperty.LifecycleTransition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-lifecycletransition

Return type

str

notification_metadata

CfnAutoScalingGroup.LifecycleHookSpecificationProperty.NotificationMetadata.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-notificationmetadata

Return type

Optional[str]

notification_target_arn

CfnAutoScalingGroup.LifecycleHookSpecificationProperty.NotificationTargetARN.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-notificationtargetarn

Return type

Optional[str]

role_arn

CfnAutoScalingGroup.LifecycleHookSpecificationProperty.RoleARN.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-rolearn

Return type

Optional[str]

MetricsCollectionProperty

class CfnAutoScalingGroup.MetricsCollectionProperty(*, granularity, metrics=None)

Bases: object

Parameters
  • granularity (str) – CfnAutoScalingGroup.MetricsCollectionProperty.Granularity.

  • metrics (Optional[Sequence[str]]) – CfnAutoScalingGroup.MetricsCollectionProperty.Metrics.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-metricscollection.html

Attributes

granularity

CfnAutoScalingGroup.MetricsCollectionProperty.Granularity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-metricscollection.html#cfn-as-metricscollection-granularity

Return type

str

metrics

CfnAutoScalingGroup.MetricsCollectionProperty.Metrics.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-metricscollection.html#cfn-as-metricscollection-metrics

Return type

Optional[List[str]]

MixedInstancesPolicyProperty

class CfnAutoScalingGroup.MixedInstancesPolicyProperty(*, launch_template, instances_distribution=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-group-mixedinstancespolicy.html

Attributes

instances_distribution

CfnAutoScalingGroup.MixedInstancesPolicyProperty.InstancesDistribution.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-group-mixedinstancespolicy.html#cfn-as-mixedinstancespolicy-instancesdistribution

Return type

Union[IResolvable, InstancesDistributionProperty, None]

launch_template

CfnAutoScalingGroup.MixedInstancesPolicyProperty.LaunchTemplate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-as-group-mixedinstancespolicy.html#cfn-as-mixedinstancespolicy-launchtemplate

Return type

Union[IResolvable, LaunchTemplateProperty]

NotificationConfigurationProperty

class CfnAutoScalingGroup.NotificationConfigurationProperty(*, topic_arn, notification_types=None)

Bases: object

Parameters
  • topic_arn (str) – CfnAutoScalingGroup.NotificationConfigurationProperty.TopicARN.

  • notification_types (Optional[Sequence[str]]) – CfnAutoScalingGroup.NotificationConfigurationProperty.NotificationTypes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-notificationconfigurations.html

Attributes

notification_types

CfnAutoScalingGroup.NotificationConfigurationProperty.NotificationTypes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-notificationconfigurations.html#cfn-as-group-notificationconfigurations-notificationtypes

Return type

Optional[List[str]]

topic_arn

CfnAutoScalingGroup.NotificationConfigurationProperty.TopicARN.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-notificationconfigurations.html#cfn-autoscaling-autoscalinggroup-notificationconfigurations-topicarn

Return type

str

TagPropertyProperty

class CfnAutoScalingGroup.TagPropertyProperty(*, key, propagate_at_launch, value)

Bases: object

Parameters
  • key (str) – CfnAutoScalingGroup.TagPropertyProperty.Key.

  • propagate_at_launch (Union[bool, IResolvable]) – CfnAutoScalingGroup.TagPropertyProperty.PropagateAtLaunch.

  • value (str) – CfnAutoScalingGroup.TagPropertyProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html

Attributes

key

CfnAutoScalingGroup.TagPropertyProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html#cfn-as-tags-Key

Return type

str

propagate_at_launch

CfnAutoScalingGroup.TagPropertyProperty.PropagateAtLaunch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html#cfn-as-tags-PropagateAtLaunch

Return type

Union[bool, IResolvable]

value

CfnAutoScalingGroup.TagPropertyProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html#cfn-as-tags-Value

Return type

str