@Stability(value=Experimental) @Internal public static final class CommonAutoScalingGroupProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CommonAutoScalingGroupProps
CommonAutoScalingGroupPropssoftware.amazon.jsii.JsiiObject.InitializationModeCommonAutoScalingGroupProps.Builder, CommonAutoScalingGroupProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(Boolean allowAllOutbound,
Boolean associatePublicIpAddress,
String autoScalingGroupName,
List<? extends BlockDevice> blockDevices,
Duration cooldown,
Number desiredCapacity,
List<? extends GroupMetrics> groupMetrics,
HealthCheck healthCheck,
Boolean ignoreUnmodifiedSizeProperties,
Monitoring instanceMonitoring,
String keyName,
Number maxCapacity,
Duration maxInstanceLifetime,
Number minCapacity,
Boolean newInstancesProtectedFromScaleIn,
List<? extends NotificationConfiguration> notifications,
Signals signals,
String spotPrice,
UpdatePolicy updatePolicy,
SubnetSelection vpcSubnets)
Constructor that initializes the object based on literal property values passed by the
CommonAutoScalingGroupProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
Boolean |
getAllowAllOutbound()
(experimental) Whether the instances can initiate connections to anywhere by default.
|
Boolean |
getAssociatePublicIpAddress()
(experimental) Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
|
String |
getAutoScalingGroupName()
(experimental) The name of the Auto Scaling group.
|
List<BlockDevice> |
getBlockDevices()
(experimental) Specifies how block devices are exposed to the instance.
|
Duration |
getCooldown()
(experimental) Default scaling cooldown for this AutoScalingGroup.
|
Number |
getDesiredCapacity()
(experimental) Initial amount of instances in the fleet.
|
List<GroupMetrics> |
getGroupMetrics()
(experimental) Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
|
HealthCheck |
getHealthCheck()
(experimental) Configuration for health checks.
|
Boolean |
getIgnoreUnmodifiedSizeProperties()
(experimental) If the ASG has scheduled actions, don't reset unchanged group sizes.
|
Monitoring |
getInstanceMonitoring()
(experimental) Controls whether instances in this group are launched with detailed or basic monitoring.
|
String |
getKeyName()
(experimental) Name of SSH keypair to grant access to instances.
|
Number |
getMaxCapacity()
(experimental) Maximum number of instances in the fleet.
|
Duration |
getMaxInstanceLifetime()
(experimental) The maximum amount of time that an instance can be in service.
|
Number |
getMinCapacity()
(experimental) Minimum number of instances in the fleet.
|
Boolean |
getNewInstancesProtectedFromScaleIn()
(experimental) Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
|
List<NotificationConfiguration> |
getNotifications()
(experimental) Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
|
Signals |
getSignals()
(experimental) Configure waiting for signals during deployment.
|
String |
getSpotPrice()
(experimental) The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
|
UpdatePolicy |
getUpdatePolicy()
(experimental) What to do when an AutoScalingGroup's instance configuration is changed.
|
SubnetSelection |
getVpcSubnets()
(experimental) Where to place instances within the VPC.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(Boolean allowAllOutbound, Boolean associatePublicIpAddress, String autoScalingGroupName, List<? extends BlockDevice> blockDevices, Duration cooldown, Number desiredCapacity, List<? extends GroupMetrics> groupMetrics, HealthCheck healthCheck, Boolean ignoreUnmodifiedSizeProperties, Monitoring instanceMonitoring, String keyName, Number maxCapacity, Duration maxInstanceLifetime, Number minCapacity, Boolean newInstancesProtectedFromScaleIn, List<? extends NotificationConfiguration> notifications, Signals signals, String spotPrice, UpdatePolicy updatePolicy, SubnetSelection vpcSubnets)
CommonAutoScalingGroupProps.Builder.public final Boolean getAllowAllOutbound()
CommonAutoScalingGroupPropsDefault: true
getAllowAllOutbound in interface CommonAutoScalingGroupPropspublic final Boolean getAssociatePublicIpAddress()
CommonAutoScalingGroupPropsDefault: - Use subnet setting.
getAssociatePublicIpAddress in interface CommonAutoScalingGroupPropspublic final String getAutoScalingGroupName()
CommonAutoScalingGroupPropsThis name must be unique per Region per account.
Default: - Auto generated by CloudFormation
getAutoScalingGroupName in interface CommonAutoScalingGroupPropspublic final List<BlockDevice> getBlockDevices()
CommonAutoScalingGroupPropsEach instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.
Default: - Uses the block device mapping of the AMI
getBlockDevices in interface CommonAutoScalingGroupPropshttps://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.htmlpublic final Duration getCooldown()
CommonAutoScalingGroupPropsDefault: Duration.minutes(5)
getCooldown in interface CommonAutoScalingGroupPropspublic final Number getDesiredCapacity()
CommonAutoScalingGroupPropsIf this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank.
Default: minCapacity, and leave unchanged during deployment
getDesiredCapacity in interface CommonAutoScalingGroupPropshttps://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacitypublic final List<GroupMetrics> getGroupMetrics()
CommonAutoScalingGroupProps
To report all group metrics use GroupMetrics.all()
Group metrics are reported in a granularity of 1 minute at no additional charge.
Default: - no group metrics will be reported
getGroupMetrics in interface CommonAutoScalingGroupPropspublic final HealthCheck getHealthCheck()
CommonAutoScalingGroupPropsDefault: - HealthCheck.ec2 with no grace period
getHealthCheck in interface CommonAutoScalingGroupPropspublic final Boolean getIgnoreUnmodifiedSizeProperties()
CommonAutoScalingGroupPropsOnly used if the ASG has scheduled actions (which may scale your ASG up or down regardless of cdk deployments). If true, the size of the group will only be reset if it has been changed in the CDK app. If false, the sizes will always be changed back to what they were in the CDK app on deployment.
Default: true
getIgnoreUnmodifiedSizeProperties in interface CommonAutoScalingGroupPropspublic final Monitoring getInstanceMonitoring()
CommonAutoScalingGroupPropsWhen detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes.
Default: - Monitoring.DETAILED
getInstanceMonitoring in interface CommonAutoScalingGroupPropshttps://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metricspublic final String getKeyName()
CommonAutoScalingGroupPropsDefault: - No SSH access will be possible.
getKeyName in interface CommonAutoScalingGroupPropspublic final Number getMaxCapacity()
CommonAutoScalingGroupPropsDefault: desiredCapacity
getMaxCapacity in interface CommonAutoScalingGroupPropspublic final Duration getMaxInstanceLifetime()
CommonAutoScalingGroupPropsThe maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again.
You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined.
Default: none
getMaxInstanceLifetime in interface CommonAutoScalingGroupPropshttps://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.htmlpublic final Number getMinCapacity()
CommonAutoScalingGroupPropsDefault: 1
getMinCapacity in interface CommonAutoScalingGroupPropspublic final Boolean getNewInstancesProtectedFromScaleIn()
CommonAutoScalingGroupPropsBy default, Auto Scaling can terminate an instance at any time after launch when scaling in an Auto Scaling Group, subject to the group's termination policy. However, you may wish to protect newly-launched instances from being scaled in if they are going to run critical applications that should not be prematurely terminated.
This flag must be enabled if the Auto Scaling Group will be associated with an ECS Capacity Provider with managed termination protection.
Default: false
getNewInstancesProtectedFromScaleIn in interface CommonAutoScalingGroupPropspublic final List<NotificationConfiguration> getNotifications()
CommonAutoScalingGroupPropsDefault: - No fleet change notifications will be sent.
getNotifications in interface CommonAutoScalingGroupPropshttps://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurationspublic final Signals getSignals()
CommonAutoScalingGroupProps
Use this to pause the CloudFormation deployment to wait for the instances
in the AutoScalingGroup to report successful startup during
creation and updates. The UserData script needs to invoke cfn-signal
with a success or failure code after it is done setting up the instance.
Without waiting for signals, the CloudFormation deployment will proceed as soon as the AutoScalingGroup has been created or updated but before the instances in the group have been started.
For example, to have instances wait for an Elastic Load Balancing health check before they signal success, add a health-check verification by using the cfn-init helper script. For an example, see the verify_instance_health command in the Auto Scaling rolling updates sample template:
https://github.com/awslabs/aws-cloudformation-templates/blob/master/aws/services/AutoScaling/AutoScalingRollingUpdates.yaml
Default: - Do not wait for signals
getSignals in interface CommonAutoScalingGroupPropspublic final String getSpotPrice()
CommonAutoScalingGroupPropsSpot Instances are launched when the price you specify exceeds the current Spot market price.
Default: none
getSpotPrice in interface CommonAutoScalingGroupPropspublic final UpdatePolicy getUpdatePolicy()
CommonAutoScalingGroupPropsThis is applied when any of the settings on the ASG are changed that affect how the instances should be created (VPC, instance type, startup scripts, etc.). It indicates how the existing instances should be replaced with new instances matching the new config. By default, nothing is done and only new instances are launched with the new config.
Default: - `UpdatePolicy.rollingUpdate()` if using `init`, `UpdatePolicy.none()` otherwise
getUpdatePolicy in interface CommonAutoScalingGroupPropspublic final SubnetSelection getVpcSubnets()
CommonAutoScalingGroupPropsDefault: - All Private subnets.
getVpcSubnets in interface CommonAutoScalingGroupProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2021. All rights reserved.