java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions.Jsii$Proxy

All Implemented Interfaces:: CommonAutoScalingGroupProps, AutoScalingGroupCapacityOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:: AutoScalingGroupCapacityOptions

@Stability(Stable) @Internal public static final class AutoScalingGroupCapacityOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements AutoScalingGroupCapacityOptions

An implementation for AutoScalingGroupCapacityOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions
AutoScalingGroupCapacityOptions.Builder, AutoScalingGroupCapacityOptions.Jsii$Proxy
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Jsii$Proxy(AutoScalingGroupCapacityOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the AutoScalingGroupCapacityOptions.Builder.

protected

Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.
Method Summary

Modifier and Type

Method

Description

com.fasterxml.jackson.databind.JsonNode

$jsii$toJson()

final boolean

equals(Object o)

final Boolean

getAllowAllOutbound()

Whether the instances can initiate connections to anywhere by default.

final Boolean

getAssociatePublicIpAddress()

Whether instances in the Auto Scaling Group should have public IP addresses associated with them.

final String

getAutoScalingGroupName()

The name of the Auto Scaling group.

final List<BlockDevice>

getBlockDevices()

Specifies how block devices are exposed to the instance.

final Boolean

getBootstrapEnabled()

Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke /etc/eks/bootstrap.sh) and associate it with the EKS cluster.

final BootstrapOptions

getBootstrapOptions()

EKS node bootstrapping options.

final Duration

getCooldown()

Default scaling cooldown for this AutoScalingGroup.

final Number

getDesiredCapacity()

Initial amount of instances in the fleet.

final List<GroupMetrics>

getGroupMetrics()

Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.

final HealthCheck

getHealthCheck()

Configuration for health checks.

final Boolean

getIgnoreUnmodifiedSizeProperties()

If the ASG has scheduled actions, don't reset unchanged group sizes.

final Monitoring

getInstanceMonitoring()

Controls whether instances in this group are launched with detailed or basic monitoring.

final InstanceType

getInstanceType()

Instance type of the instances to start.

final String

getKeyName()

Name of SSH keypair to grant access to instances.

final MachineImageType

getMachineImageType()

Machine image type.

final Boolean

getMapRole()

Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC.

final Number

getMaxCapacity()

Maximum number of instances in the fleet.

final Duration

getMaxInstanceLifetime()

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

final Number

getMinCapacity()

Minimum number of instances in the fleet.

final Boolean

getNewInstancesProtectedFromScaleIn()

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

final List<NotificationConfiguration>

getNotifications()

Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).

final ITopic

getNotificationsTopic()

(deprecated) SNS topic to send notifications about fleet changes.

final Number

getReplacingUpdateMinSuccessfulInstancesPercent()

(deprecated) Configuration for replacing updates.

final Number

getResourceSignalCount()

(deprecated) How many ResourceSignal calls CloudFormation expects before the resource is considered created.

final Duration

getResourceSignalTimeout()

(deprecated) The length of time to wait for the resourceSignalCount.

final RollingUpdateConfiguration

getRollingUpdateConfiguration()

(deprecated) Configuration for rolling updates.

final Signals

getSignals()

Configure waiting for signals during deployment.

final Boolean

getSpotInterruptHandler()

Installs the AWS spot instance interrupt handler on the cluster if it's not already added.

final String

getSpotPrice()

The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.

final List<TerminationPolicy>

getTerminationPolicies()

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

final UpdatePolicy

getUpdatePolicy()

What to do when an AutoScalingGroup's instance configuration is changed.

final UpdateType

getUpdateType()

(deprecated) What to do when an AutoScalingGroup's instance configuration is changed.

final SubnetSelection

getVpcSubnets()

Where to place instances within the VPC.

final int

hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Jsii$Proxy
  
  protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
  
  Constructor that initializes the object based on values retrieved from the JsiiObject.
  
  Parameters:
  
  objRef - Reference to the JSII managed object.
- Jsii$Proxy
  
  protected Jsii$Proxy(AutoScalingGroupCapacityOptions.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the AutoScalingGroupCapacityOptions.Builder.
Method Details
- getInstanceType
  
  public final InstanceType getInstanceType()
  
  Description copied from interface: AutoScalingGroupCapacityOptions
  
  Instance type of the instances to start.
  
  Specified by:
  
  getInstanceType in interface AutoScalingGroupCapacityOptions
- getBootstrapEnabled
  
  public final Boolean getBootstrapEnabled()
  
  Description copied from interface: AutoScalingGroupCapacityOptions
  
  Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke /etc/eks/bootstrap.sh) and associate it with the EKS cluster.
  If you wish to provide a custom user data script, set this to false and manually invoke autoscalingGroup.addUserData().
  Default: true
  
  Specified by:
  
  getBootstrapEnabled in interface AutoScalingGroupCapacityOptions
- getBootstrapOptions
  
  public final BootstrapOptions getBootstrapOptions()
  
  Description copied from interface: AutoScalingGroupCapacityOptions
  
  EKS node bootstrapping options.
  Default: - none
  
  Specified by:
  
  getBootstrapOptions in interface AutoScalingGroupCapacityOptions
- getMachineImageType
  
  public final MachineImageType getMachineImageType()
  
  Description copied from interface: AutoScalingGroupCapacityOptions
  
  Machine image type.
  Default: MachineImageType.AMAZON_LINUX_2
  
  Specified by:
  
  getMachineImageType in interface AutoScalingGroupCapacityOptions
- getMapRole
  
  public final Boolean getMapRole()
  
  Description copied from interface: AutoScalingGroupCapacityOptions
  
  Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC.
  This cannot be explicitly set to true if the cluster has kubectl disabled.
  Default: - true if the cluster has kubectl enabled (which is the default).
  
  Specified by:
  
  getMapRole in interface AutoScalingGroupCapacityOptions
- getSpotInterruptHandler
  
  public final Boolean getSpotInterruptHandler()
  
  Description copied from interface: AutoScalingGroupCapacityOptions
  
  Installs the AWS spot instance interrupt handler on the cluster if it's not already added.
  Only relevant if spotPrice is used.
  Default: true
  
  Specified by:
  
  getSpotInterruptHandler in interface AutoScalingGroupCapacityOptions
- getAllowAllOutbound
  
  public final Boolean getAllowAllOutbound()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Whether the instances can initiate connections to anywhere by default.
  Default: true
  
  Specified by:
  
  getAllowAllOutbound in interface CommonAutoScalingGroupProps
- getAssociatePublicIpAddress
  
  public final Boolean getAssociatePublicIpAddress()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
  Default: - Use subnet setting.
  
  Specified by:
  
  getAssociatePublicIpAddress in interface CommonAutoScalingGroupProps
- getAutoScalingGroupName
  
  public final String getAutoScalingGroupName()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  The name of the Auto Scaling group.
  This name must be unique per Region per account.
  Default: - Auto generated by CloudFormation
  
  Specified by:
  
  getAutoScalingGroupName in interface CommonAutoScalingGroupProps
- getBlockDevices
  
  public final List<BlockDevice> getBlockDevices()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
  Each 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
  Specified by:
  
  getBlockDevices in interface CommonAutoScalingGroupProps
  
  See Also:
  
  https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
- getCooldown
  
  public final Duration getCooldown()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Default scaling cooldown for this AutoScalingGroup.
  Default: Duration.minutes(5)
  
  Specified by:
  
  getCooldown in interface CommonAutoScalingGroupProps
- getDesiredCapacity
  
  public final Number getDesiredCapacity()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Initial amount of instances in the fleet.
  If 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
  Specified by:
  
  getDesiredCapacity in interface CommonAutoScalingGroupProps
  
  See Also:
  
  https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity
- getGroupMetrics
  
  public final List<GroupMetrics> getGroupMetrics()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
  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
  
  Specified by:
  
  getGroupMetrics in interface CommonAutoScalingGroupProps
- getHealthCheck
  
  public final HealthCheck getHealthCheck()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Configuration for health checks.
  Default: - HealthCheck.ec2 with no grace period
  
  Specified by:
  
  getHealthCheck in interface CommonAutoScalingGroupProps
- getIgnoreUnmodifiedSizeProperties
  
  public final Boolean getIgnoreUnmodifiedSizeProperties()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  If the ASG has scheduled actions, don't reset unchanged group sizes.
  Only 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
  
  Specified by:
  
  getIgnoreUnmodifiedSizeProperties in interface CommonAutoScalingGroupProps
- getInstanceMonitoring
  
  public final Monitoring getInstanceMonitoring()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Controls whether instances in this group are launched with detailed or basic monitoring.
  When 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
  Specified by:
  
  getInstanceMonitoring in interface CommonAutoScalingGroupProps
  
  See Also:
  
  https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics
- getKeyName
  
  public final String getKeyName()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Name of SSH keypair to grant access to instances.
  Default: - No SSH access will be possible.
  
  Specified by:
  
  getKeyName in interface CommonAutoScalingGroupProps
- getMaxCapacity
  
  public final Number getMaxCapacity()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Maximum number of instances in the fleet.
  Default: desiredCapacity
  
  Specified by:
  
  getMaxCapacity in interface CommonAutoScalingGroupProps
- getMaxInstanceLifetime
  
  public final Duration getMaxInstanceLifetime()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  The maximum amount of time that an instance can be in service.
  The 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
  Specified by:
  
  getMaxInstanceLifetime in interface CommonAutoScalingGroupProps
  
  See Also:
  
  https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html
- getMinCapacity
  
  public final Number getMinCapacity()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Minimum number of instances in the fleet.
  Default: 1
  
  Specified by:
  
  getMinCapacity in interface CommonAutoScalingGroupProps
- getNewInstancesProtectedFromScaleIn
  
  public final Boolean getNewInstancesProtectedFromScaleIn()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
  By 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
  
  Specified by:
  
  getNewInstancesProtectedFromScaleIn in interface CommonAutoScalingGroupProps
- getNotifications
  
  public final List<NotificationConfiguration> getNotifications()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
  Default: - No fleet change notifications will be sent.
  Specified by:
  
  getNotifications in interface CommonAutoScalingGroupProps
  
  See Also:
  
  https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations
- getNotificationsTopic
  
  public final ITopic getNotificationsTopic()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  (deprecated) SNS topic to send notifications about fleet changes.
  Default: - No fleet change notifications will be sent.
  
  Specified by:
  
  getNotificationsTopic in interface CommonAutoScalingGroupProps
- getReplacingUpdateMinSuccessfulInstancesPercent
  
  public final Number getReplacingUpdateMinSuccessfulInstancesPercent()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  (deprecated) Configuration for replacing updates.
  Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instances must signal success for the update to succeed.
  Default: minSuccessfulInstancesPercent
  
  Specified by:
  
  getReplacingUpdateMinSuccessfulInstancesPercent in interface CommonAutoScalingGroupProps
- getResourceSignalCount
  
  public final Number getResourceSignalCount()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  (deprecated) How many ResourceSignal calls CloudFormation expects before the resource is considered created.
  Default: 1 if resourceSignalTimeout is set, 0 otherwise
  
  Specified by:
  
  getResourceSignalCount in interface CommonAutoScalingGroupProps
- getResourceSignalTimeout
  
  public final Duration getResourceSignalTimeout()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  (deprecated) The length of time to wait for the resourceSignalCount.
  The maximum value is 43200 (12 hours).
  Default: Duration.minutes(5) if resourceSignalCount is set, N/A otherwise
  
  Specified by:
  
  getResourceSignalTimeout in interface CommonAutoScalingGroupProps
- getRollingUpdateConfiguration
  
  public final RollingUpdateConfiguration getRollingUpdateConfiguration()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  (deprecated) Configuration for rolling updates.
  Only used if updateType == UpdateType.RollingUpdate.
  Default: - RollingUpdateConfiguration with defaults.
  
  Specified by:
  
  getRollingUpdateConfiguration in interface CommonAutoScalingGroupProps
- getSignals
  
  public final Signals getSignals()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Configure waiting for signals during deployment.
  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
  
  Specified by:
  
  getSignals in interface CommonAutoScalingGroupProps
- getSpotPrice
  
  public final String getSpotPrice()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
  Spot Instances are launched when the price you specify exceeds the current Spot market price.
  Default: none
  
  Specified by:
  
  getSpotPrice in interface CommonAutoScalingGroupProps
- getTerminationPolicies
  
  public final List<TerminationPolicy> getTerminationPolicies()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  A policy or a list of policies that are used to select the instances to terminate.
  The policies are executed in the order that you list them.
  Default: - `TerminationPolicy.DEFAULT`
  Specified by:
  
  getTerminationPolicies in interface CommonAutoScalingGroupProps
  
  See Also:
  
  https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
- getUpdatePolicy
  
  public final UpdatePolicy getUpdatePolicy()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  What to do when an AutoScalingGroup's instance configuration is changed.
  This 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
  
  Specified by:
  
  getUpdatePolicy in interface CommonAutoScalingGroupProps
- getUpdateType
  
  public final UpdateType getUpdateType()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  (deprecated) What to do when an AutoScalingGroup's instance configuration is changed.
  This 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: UpdateType.None
  
  Specified by:
  
  getUpdateType in interface CommonAutoScalingGroupProps
- getVpcSubnets
  
  public final SubnetSelection getVpcSubnets()
  
  Description copied from interface: CommonAutoScalingGroupProps
  
  Where to place instances within the VPC.
  Default: - All Private subnets.
  
  Specified by:
  
  getVpcSubnets in interface CommonAutoScalingGroupProps
- $jsii$toJson
  
  @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
  
  Specified by:
  
  $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
- equals
  
  public final boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public final int hashCode()
  
  Overrides:
  
  hashCode in class Object

Class AutoScalingGroupCapacityOptions.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getInstanceType

getBootstrapEnabled

getBootstrapOptions

getMachineImageType

getMapRole

getSpotInterruptHandler

getAllowAllOutbound

getAssociatePublicIpAddress

getAutoScalingGroupName

getBlockDevices

getCooldown

getDesiredCapacity

getGroupMetrics

getHealthCheck

getIgnoreUnmodifiedSizeProperties

getInstanceMonitoring

getKeyName

getMaxCapacity

getMaxInstanceLifetime

getMinCapacity

getNewInstancesProtectedFromScaleIn

getNotifications

getNotificationsTopic

getReplacingUpdateMinSuccessfulInstancesPercent

getResourceSignalCount

getResourceSignalTimeout

getRollingUpdateConfiguration

getSignals

getSpotPrice

getTerminationPolicies

getUpdatePolicy

getUpdateType

getVpcSubnets

$jsii$toJson

equals

hashCode