class CfnAutoScalingGroup (construct)

Language	Type name
.NET	Amazon.CDK.AWS.AutoScaling.CfnAutoScalingGroup
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsautoscaling#CfnAutoScalingGroup
Java	software.amazon.awscdk.services.autoscaling.CfnAutoScalingGroup
Python	aws_cdk.aws_autoscaling.CfnAutoScalingGroup
TypeScript	aws-cdk-lib » aws_autoscaling » CfnAutoScalingGroup

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::AutoScaling::AutoScalingGroup resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management.

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

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide .

For help migrating from launch configurations to launch templates, see Migrate AWS CloudFormation stacks from launch configurations to launch templates in the Amazon EC2 Auto Scaling User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
const cfnAutoScalingGroup = new autoscaling.CfnAutoScalingGroup(this, 'MyCfnAutoScalingGroup', {
  maxSize: 'maxSize',
  minSize: 'minSize',

  // the properties below are optional
  autoScalingGroupName: 'autoScalingGroupName',
  availabilityZoneDistribution: {
    capacityDistributionStrategy: 'capacityDistributionStrategy',
  },
  availabilityZoneImpairmentPolicy: {
    impairedZoneHealthCheckBehavior: 'impairedZoneHealthCheckBehavior',
    zonalShiftEnabled: false,
  },
  availabilityZones: ['availabilityZones'],
  capacityRebalance: false,
  capacityReservationSpecification: {
    capacityReservationPreference: 'capacityReservationPreference',

    // the properties below are optional
    capacityReservationTarget: {
      capacityReservationIds: ['capacityReservationIds'],
      capacityReservationResourceGroupArns: ['capacityReservationResourceGroupArns'],
    },
  },
  context: 'context',
  cooldown: 'cooldown',
  defaultInstanceWarmup: 123,
  desiredCapacity: 'desiredCapacity',
  desiredCapacityType: 'desiredCapacityType',
  healthCheckGracePeriod: 123,
  healthCheckType: 'healthCheckType',
  instanceId: 'instanceId',
  instanceMaintenancePolicy: {
    maxHealthyPercentage: 123,
    minHealthyPercentage: 123,
  },
  launchConfigurationName: 'launchConfigurationName',
  launchTemplate: {
    version: 'version',

    // the properties below are optional
    launchTemplateId: 'launchTemplateId',
    launchTemplateName: 'launchTemplateName',
  },
  lifecycleHookSpecificationList: [{
    lifecycleHookName: 'lifecycleHookName',
    lifecycleTransition: 'lifecycleTransition',

    // the properties below are optional
    defaultResult: 'defaultResult',
    heartbeatTimeout: 123,
    notificationMetadata: 'notificationMetadata',
    notificationTargetArn: 'notificationTargetArn',
    roleArn: 'roleArn',
  }],
  loadBalancerNames: ['loadBalancerNames'],
  maxInstanceLifetime: 123,
  metricsCollection: [{
    granularity: 'granularity',

    // the properties below are optional
    metrics: ['metrics'],
  }],
  mixedInstancesPolicy: {
    launchTemplate: {
      launchTemplateSpecification: {
        version: 'version',

        // the properties below are optional
        launchTemplateId: 'launchTemplateId',
        launchTemplateName: 'launchTemplateName',
      },

      // the properties below are optional
      overrides: [{
        instanceRequirements: {
          memoryMiB: {
            max: 123,
            min: 123,
          },
          vCpuCount: {
            max: 123,
            min: 123,
          },

          // the properties below are optional
          acceleratorCount: {
            max: 123,
            min: 123,
          },
          acceleratorManufacturers: ['acceleratorManufacturers'],
          acceleratorNames: ['acceleratorNames'],
          acceleratorTotalMemoryMiB: {
            max: 123,
            min: 123,
          },
          acceleratorTypes: ['acceleratorTypes'],
          allowedInstanceTypes: ['allowedInstanceTypes'],
          bareMetal: 'bareMetal',
          baselineEbsBandwidthMbps: {
            max: 123,
            min: 123,
          },
          baselinePerformanceFactors: {
            cpu: {
              references: [{
                instanceFamily: 'instanceFamily',
              }],
            },
          },
          burstablePerformance: 'burstablePerformance',
          cpuManufacturers: ['cpuManufacturers'],
          excludedInstanceTypes: ['excludedInstanceTypes'],
          instanceGenerations: ['instanceGenerations'],
          localStorage: 'localStorage',
          localStorageTypes: ['localStorageTypes'],
          maxSpotPriceAsPercentageOfOptimalOnDemandPrice: 123,
          memoryGiBPerVCpu: {
            max: 123,
            min: 123,
          },
          networkBandwidthGbps: {
            max: 123,
            min: 123,
          },
          networkInterfaceCount: {
            max: 123,
            min: 123,
          },
          onDemandMaxPricePercentageOverLowestPrice: 123,
          requireHibernateSupport: false,
          spotMaxPricePercentageOverLowestPrice: 123,
          totalLocalStorageGb: {
            max: 123,
            min: 123,
          },
        },
        instanceType: 'instanceType',
        launchTemplateSpecification: {
          version: 'version',

          // the properties below are optional
          launchTemplateId: 'launchTemplateId',
          launchTemplateName: 'launchTemplateName',
        },
        weightedCapacity: 'weightedCapacity',
      }],
    },

    // the properties below are optional
    instancesDistribution: {
      onDemandAllocationStrategy: 'onDemandAllocationStrategy',
      onDemandBaseCapacity: 123,
      onDemandPercentageAboveBaseCapacity: 123,
      spotAllocationStrategy: 'spotAllocationStrategy',
      spotInstancePools: 123,
      spotMaxPrice: 'spotMaxPrice',
    },
  },
  newInstancesProtectedFromScaleIn: false,
  notificationConfiguration: {
    topicArn: 'topicArn',

    // the properties below are optional
    notificationTypes: ['notificationTypes'],
  },
  notificationConfigurations: [{
    topicArn: 'topicArn',

    // the properties below are optional
    notificationTypes: ['notificationTypes'],
  }],
  placementGroup: 'placementGroup',
  serviceLinkedRoleArn: 'serviceLinkedRoleArn',
  skipZonalShiftValidation: false,
  tags: [{
    key: 'key',
    propagateAtLaunch: false,
    value: 'value',
  }],
  targetGroupArns: ['targetGroupArns'],
  terminationPolicies: ['terminationPolicies'],
  trafficSources: [{
    identifier: 'identifier',
    type: 'type',
  }],
  vpcZoneIdentifier: ['vpcZoneIdentifier'],
});

Initializer

new CfnAutoScalingGroup(scope: Construct, id: string, props: CfnAutoScalingGroupProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnAutoScalingGroupProps — Resource properties.

Construct Props

Name	Type	Description
maxSize	string	The maximum size of the group.
minSize	string	The minimum size of the group.
autoScalingGroupName?	string	The name of the Auto Scaling group. This name must be unique per Region per account.
availabilityZoneDistribution?	IResolvable | AvailabilityZoneDistributionProperty	The instance capacity distribution across Availability Zones.
availabilityZoneImpairmentPolicy?	IResolvable | AvailabilityZoneImpairmentPolicyProperty	The Availability Zone impairment policy.
availabilityZones?	string[]	A list of Availability Zones where instances in the Auto Scaling group can be created.
capacityRebalance?	boolean | IResolvable	Indicates whether Capacity Rebalancing is enabled.
capacityReservationSpecification?	IResolvable | CapacityReservationSpecificationProperty	The capacity reservation specification.
context?	string	Reserved.
cooldown?	string	Only needed if you use simple scaling policies..
defaultInstanceWarmup?	number	The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.
desiredCapacity?	string	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.
desiredCapacityType?	string	The unit of measurement for the value specified for desired capacity.
healthCheckGracePeriod?	number	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 health check.
healthCheckType?	string	A comma-separated value string of one or more health check types.
instanceId?	string	The ID of the instance used to base the launch configuration on.
instanceMaintenancePolicy?	IResolvable | InstanceMaintenancePolicyProperty	An instance maintenance policy.
launchConfigurationName?	string	The name of the launch configuration to use to launch instances.
launchTemplate?	IResolvable | LaunchTemplateSpecificationProperty	Information used to specify the launch template and version to use to launch instances.
lifecycleHookSpecificationList?	IResolvable | IResolvable | LifecycleHookSpecificationProperty[]	One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
loadBalancerNames?	string[]	A list of Classic Load Balancers associated with this Auto Scaling group.
maxInstanceLifetime?	number	The maximum amount of time, in seconds, that an instance can be in service.
metricsCollection?	IResolvable | IResolvable | MetricsCollectionProperty[]	Enables the monitoring of group metrics of an Auto Scaling group.
mixedInstancesPolicy?	IResolvable | MixedInstancesPolicyProperty	An embedded object that specifies a mixed instances policy.
newInstancesProtectedFromScaleIn?	boolean | IResolvable	Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
notificationConfiguration?⚠️	IResolvable | NotificationConfigurationProperty	A structure that specifies an Amazon SNS notification configuration for the NotificationConfigurations property of the AWS::AutoScaling::AutoScalingGroup resource. For an example template snippet, see Configure Amazon EC2 Auto Scaling resources. For more information, see Get Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.
notificationConfigurations?	IResolvable | IResolvable | NotificationConfigurationProperty[]	Configures an Auto Scaling group to send notifications when specified events take place.
placementGroup?	string	The name of the placement group into which to launch your instances.
serviceLinkedRoleArn?	string	The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf.
skipZonalShiftValidation?	boolean | IResolvable
tags?	TagPropertyProperty[]	One or more tags.
targetGroupArns?	string[]	The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.
terminationPolicies?	string[]	A policy or a list of policies that are used to select the instance to terminate.
trafficSources?	IResolvable | IResolvable | TrafficSourceIdentifierProperty[]	The traffic sources associated with this Auto Scaling group.
vpcZoneIdentifier?	string[]	A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.

---

maxSize

Type: string

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).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-maxsize

---

minSize

Type: string

The minimum size of the group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-minsize

---

autoScalingGroupName?

Type: string (optional)

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

The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.

You cannot use a colon (:) in the name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-autoscalinggroupname

---

availabilityZoneDistribution?

Type: IResolvable | AvailabilityZoneDistributionProperty (optional)

The instance capacity distribution across Availability Zones.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-availabilityzonedistribution

---

availabilityZoneImpairmentPolicy?

Type: IResolvable | AvailabilityZoneImpairmentPolicyProperty (optional)

The Availability Zone impairment policy.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-availabilityzoneimpairmentpolicy

---

availabilityZones?

Type: string[] (optional)

A list of Availability Zones where instances in the Auto Scaling group can be created.

Used for launching into the default VPC subnet in each Availability Zone when not using the VPCZoneIdentifier property, or for attaching a network interface when an existing network interface ID is specified in a launch template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-availabilityzones

---

capacityRebalance?

Type: boolean | IResolvable (optional)

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 Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-capacityrebalance

---

capacityReservationSpecification?

Type: IResolvable | CapacityReservationSpecificationProperty (optional)

The capacity reservation specification.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-capacityreservationspecification

---

context?

Type: string (optional)

Reserved.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-context

---

cooldown?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-cooldown

---

defaultInstanceWarmup?

Type: number (optional)

The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.

During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .

To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds . 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 value of 0 or other nominal value.

Default: None

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-defaultinstancewarmup

---

desiredCapacity?

Type: string (optional)

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 automatic scaling.

The 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 when creating the stack, the default is the minimum size of the group.

CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-desiredcapacity

---

desiredCapacityType?

Type: string (optional)

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 Create a mixed instances 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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-desiredcapacitytype

---

healthCheckGracePeriod?

Type: number (optional)

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 health check.

This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .

Default: 0 seconds

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-healthcheckgraceperiod

---

healthCheckType?

Type: string (optional)

A comma-separated value string of one or more health check types.

The valid values are EC2 , EBS , ELB , and VPC_LATTICE . EC2 is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .

Only specify EC2 if you must clear a value that was previously set.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-healthchecktype

---

instanceId?

Type: string (optional)

The ID of the instance used to base the launch configuration on.

For more information, see Create an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide .

If you specify LaunchTemplate , MixedInstancesPolicy , or LaunchConfigurationName , don't specify InstanceId .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-instanceid

---

instanceMaintenancePolicy?

Type: IResolvable | InstanceMaintenancePolicyProperty (optional)

An instance maintenance policy.

For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-instancemaintenancepolicy

---

launchConfigurationName?

Type: string (optional)

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

Required only if you don't specify LaunchTemplate , MixedInstancesPolicy , or InstanceId .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-launchconfigurationname

---

launchTemplate?

Type: IResolvable | LaunchTemplateSpecificationProperty (optional)

Information used to specify the launch template and version to use to launch instances.

You can alternatively associate a launch template to the Auto Scaling group by specifying a MixedInstancesPolicy . For more information about creating launch templates, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .

If you omit this property, you must specify MixedInstancesPolicy , LaunchConfigurationName , or InstanceId .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-launchtemplate

---

lifecycleHookSpecificationList?

Type: IResolvable | IResolvable | LifecycleHookSpecificationProperty[] (optional)

One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecificationlist

---

loadBalancerNames?

Type: string[] (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-loadbalancernames

---

maxInstanceLifetime?

Type: number (optional)

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 Replace Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-maxinstancelifetime

---

metricsCollection?

Type: IResolvable | IResolvable | MetricsCollectionProperty[] (optional)

Enables the monitoring of group metrics of an Auto Scaling group.

By default, these metrics are disabled.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-metricscollection

---

mixedInstancesPolicy?

Type: IResolvable | MixedInstancesPolicyProperty (optional)

An embedded object that specifies a mixed instances policy.

The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-mixedinstancespolicy

---

newInstancesProtectedFromScaleIn?

Type: boolean | IResolvable (optional)

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 Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-newinstancesprotectedfromscalein

---

notificationConfiguration?⚠️

⚠️ Deprecated: this property has been deprecated

Type: IResolvable | NotificationConfigurationProperty (optional)

A structure that specifies an Amazon SNS notification configuration for the NotificationConfigurations property of the AWS::AutoScaling::AutoScalingGroup resource. For an example template snippet, see Configure Amazon EC2 Auto Scaling resources. For more information, see Get Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-notificationconfiguration

---

notificationConfigurations?

Type: IResolvable | IResolvable | NotificationConfigurationProperty[] (optional)

Configures an Auto Scaling group to send notifications when specified events take place.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-notificationconfigurations

---

placementGroup?

Type: string (optional)

The name of the 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-placementgroup

---

serviceLinkedRoleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service 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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-servicelinkedrolearn

---

skipZonalShiftValidation?

Type: boolean | IResolvable (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-skipzonalshiftvalidation

---

tags?

Type: TagPropertyProperty[] (optional)

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 Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-tags

---

targetGroupArns?

Type: string[] (optional)

The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.

Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-targetgrouparns

---

terminationPolicies?

Type: string[] (optional)

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 Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-terminationpolicies

---

trafficSources?

Type: IResolvable | IResolvable | TrafficSourceIdentifierProperty[] (optional)

The traffic sources associated with this Auto Scaling group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-trafficsources

---

vpcZoneIdentifier?

Type: string[] (optional)

A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.

If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment .

When you update VPCZoneIdentifier , this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an UpdatePolicy attribute .

Required to launch instances into a nondefault VPC. If you specify VPCZoneIdentifier with AvailabilityZones , the subnets that you specify for this property must reside in those Availability Zones.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-vpczoneidentifier

Properties

Name	Type	Description
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
maxSize	string	The maximum size of the group.
minSize	string	The minimum size of the group.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
autoScalingGroupName?	string	The name of the Auto Scaling group.
availabilityZoneDistribution?	IResolvable | AvailabilityZoneDistributionProperty	The instance capacity distribution across Availability Zones.
availabilityZoneImpairmentPolicy?	IResolvable | AvailabilityZoneImpairmentPolicyProperty	The Availability Zone impairment policy.
availabilityZones?	string[]	A list of Availability Zones where instances in the Auto Scaling group can be created.
capacityRebalance?	boolean | IResolvable	Indicates whether Capacity Rebalancing is enabled.
capacityReservationSpecification?	IResolvable | CapacityReservationSpecificationProperty	The capacity reservation specification.
context?	string	Reserved.
cooldown?	string	Only needed if you use simple scaling policies..
defaultInstanceWarmup?	number	The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.
desiredCapacity?	string	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.
desiredCapacityType?	string	The unit of measurement for the value specified for desired capacity.
healthCheckGracePeriod?	number	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 health check.
healthCheckType?	string	A comma-separated value string of one or more health check types.
instanceId?	string	The ID of the instance used to base the launch configuration on.
instanceMaintenancePolicy?	IResolvable | InstanceMaintenancePolicyProperty	An instance maintenance policy.
launchConfigurationName?	string	The name of the launch configuration to use to launch instances.
launchTemplate?	IResolvable | LaunchTemplateSpecificationProperty	Information used to specify the launch template and version to use to launch instances.
lifecycleHookSpecificationList?	IResolvable | IResolvable | LifecycleHookSpecificationProperty[]	One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
loadBalancerNames?	string[]	A list of Classic Load Balancers associated with this Auto Scaling group.
maxInstanceLifetime?	number	The maximum amount of time, in seconds, that an instance can be in service.
metricsCollection?	IResolvable | IResolvable | MetricsCollectionProperty[]	Enables the monitoring of group metrics of an Auto Scaling group.
mixedInstancesPolicy?	IResolvable | MixedInstancesPolicyProperty	An embedded object that specifies a mixed instances policy.
newInstancesProtectedFromScaleIn?	boolean | IResolvable	Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
notificationConfiguration?⚠️	IResolvable | NotificationConfigurationProperty	A structure that specifies an Amazon SNS notification configuration for the NotificationConfigurations property of the AWS::AutoScaling::AutoScalingGroup resource. For an example template snippet, see Configure Amazon EC2 Auto Scaling resources. For more information, see Get Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.
notificationConfigurations?	IResolvable | IResolvable | NotificationConfigurationProperty[]	Configures an Auto Scaling group to send notifications when specified events take place.
placementGroup?	string	The name of the placement group into which to launch your instances.
serviceLinkedRoleArn?	string	The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf.
skipZonalShiftValidation?	boolean | IResolvable
tagsRaw?	TagPropertyProperty[]	One or more tags.
targetGroupArns?	string[]	The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.
terminationPolicies?	string[]	A policy or a list of policies that are used to select the instance to terminate.
trafficSources?	IResolvable | IResolvable | TrafficSourceIdentifierProperty[]	The traffic sources associated with this Auto Scaling group.
vpcZoneIdentifier?	string[]	A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

cfnOptions

Type: ICfnResourceOptions

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

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

logicalId

Type: string

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).

---

maxSize

Type: string

The maximum size of the group.

---

minSize

Type: string

The minimum size of the group.

---

node

Type: Node

The tree node.

---

ref

Type: string

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 }).

---

stack

Type: Stack

The stack in which this element is defined.

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

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

autoScalingGroupName?

Type: string (optional)

The name of the Auto Scaling group.

This name must be unique per Region per account.

---

availabilityZoneDistribution?

Type: IResolvable | AvailabilityZoneDistributionProperty (optional)

The instance capacity distribution across Availability Zones.

---

availabilityZoneImpairmentPolicy?

Type: IResolvable | AvailabilityZoneImpairmentPolicyProperty (optional)

The Availability Zone impairment policy.

---

availabilityZones?

Type: string[] (optional)

A list of Availability Zones where instances in the Auto Scaling group can be created.

---

capacityRebalance?

Type: boolean | IResolvable (optional)

Indicates whether Capacity Rebalancing is enabled.

---

capacityReservationSpecification?

Type: IResolvable | CapacityReservationSpecificationProperty (optional)

The capacity reservation specification.

---

context?

Type: string (optional)

Reserved.

---

cooldown?

Type: string (optional)

Only needed if you use simple scaling policies..

---

defaultInstanceWarmup?

Type: number (optional)

The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.

---

desiredCapacity?

Type: string (optional)

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.

---

desiredCapacityType?

Type: string (optional)

The unit of measurement for the value specified for desired capacity.

---

healthCheckGracePeriod?

Type: number (optional)

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 health check.

---

healthCheckType?

Type: string (optional)

A comma-separated value string of one or more health check types.

---

instanceId?

Type: string (optional)

The ID of the instance used to base the launch configuration on.

---

instanceMaintenancePolicy?

Type: IResolvable | InstanceMaintenancePolicyProperty (optional)

An instance maintenance policy.

---

launchConfigurationName?

Type: string (optional)

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

---

launchTemplate?

Type: IResolvable | LaunchTemplateSpecificationProperty (optional)

Information used to specify the launch template and version to use to launch instances.

---

lifecycleHookSpecificationList?

Type: IResolvable | IResolvable | LifecycleHookSpecificationProperty[] (optional)

One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.

---

loadBalancerNames?

Type: string[] (optional)

A list of Classic Load Balancers associated with this Auto Scaling group.

---

maxInstanceLifetime?

Type: number (optional)

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

---

metricsCollection?

Type: IResolvable | IResolvable | MetricsCollectionProperty[] (optional)

Enables the monitoring of group metrics of an Auto Scaling group.

---

mixedInstancesPolicy?

Type: IResolvable | MixedInstancesPolicyProperty (optional)

An embedded object that specifies a mixed instances policy.

---

newInstancesProtectedFromScaleIn?

Type: boolean | IResolvable (optional)

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

---

notificationConfiguration?⚠️

⚠️ Deprecated: this property has been deprecated

Type: IResolvable | NotificationConfigurationProperty (optional)

A structure that specifies an Amazon SNS notification configuration for the NotificationConfigurations property of the AWS::AutoScaling::AutoScalingGroup resource. For an example template snippet, see Configure Amazon EC2 Auto Scaling resources. For more information, see Get Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.

---

notificationConfigurations?

Type: IResolvable | IResolvable | NotificationConfigurationProperty[] (optional)

Configures an Auto Scaling group to send notifications when specified events take place.

---

placementGroup?

Type: string (optional)

The name of the placement group into which to launch your instances.

---

serviceLinkedRoleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf.

---

skipZonalShiftValidation?

Type: boolean | IResolvable (optional)

---

tagsRaw?

Type: TagPropertyProperty[] (optional)

One or more tags.

---

targetGroupArns?

Type: string[] (optional)

The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.

---

terminationPolicies?

Type: string[] (optional)

A policy or a list of policies that are used to select the instance to terminate.

---

trafficSources?

Type: IResolvable | IResolvable | TrafficSourceIdentifierProperty[] (optional)

The traffic sources associated with this Auto Scaling group.

---

vpcZoneIdentifier?

Type: string[] (optional)

A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

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.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

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

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [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.](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.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

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

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

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

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

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.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [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.](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.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

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

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }