AddCapacityOptions.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.ecs.AddCapacityOptions.Jsii$Proxy

All Implemented Interfaces:

CommonAutoScalingGroupProps, AddAutoScalingGroupCapacityOptions, AddCapacityOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

AddCapacityOptions
```
@Stability(value=Stable)
 @Internal
public static final class AddCapacityOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements AddCapacityOptions
```
An implementation for AddCapacityOptions

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.ecs.AddCapacityOptions
  AddCapacityOptions.Builder, AddCapacityOptions.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(AddCapacityOptions.Builder builder)` Constructor that initializes the object based on literal property values passed by the `AddCapacityOptions.Builder`.
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`Boolean`	`getAllowAllOutbound()` Whether the instances can initiate connections to anywhere by default.
`Boolean`	`getAssociatePublicIpAddress()` Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
`String`	`getAutoScalingGroupName()` The name of the Auto Scaling group.
`List<BlockDevice>`	`getBlockDevices()` Specifies how block devices are exposed to the instance.
`Boolean`	`getCanContainersAccessInstanceRole()` Specifies whether the containers can access the container instance role.
`Duration`	`getCooldown()` Default scaling cooldown for this AutoScalingGroup.
`Number`	`getDesiredCapacity()` Initial amount of instances in the fleet.
`List<GroupMetrics>`	`getGroupMetrics()` Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
`HealthCheck`	`getHealthCheck()` Configuration for health checks.
`Boolean`	`getIgnoreUnmodifiedSizeProperties()` If the ASG has scheduled actions, don't reset unchanged group sizes.
`Monitoring`	`getInstanceMonitoring()` Controls whether instances in this group are launched with detailed or basic monitoring.
`InstanceType`	`getInstanceType()` The EC2 instance type to use when launching instances into the AutoScalingGroup.
`String`	`getKeyName()` Name of SSH keypair to grant access to instances.
`IMachineImage`	`getMachineImage()` The ECS-optimized AMI variant to use.
`MachineImageType`	`getMachineImageType()` What type of machine image this is.
`Number`	`getMaxCapacity()` Maximum number of instances in the fleet.
`Duration`	`getMaxInstanceLifetime()` The maximum amount of time that an instance can be in service.
`Number`	`getMinCapacity()` Minimum number of instances in the fleet.
`Boolean`	`getNewInstancesProtectedFromScaleIn()` Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
`List<NotificationConfiguration>`	`getNotifications()` Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
`Signals`	`getSignals()` Configure waiting for signals during deployment.
`Boolean`	`getSpotInstanceDraining()` Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.
`String`	`getSpotPrice()` The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
`List<TerminationPolicy>`	`getTerminationPolicies()` A policy or a list of policies that are used to select the instances to terminate.
`IKey`	`getTopicEncryptionKey()` If `AddAutoScalingGroupCapacityOptions.taskDrainTime` is non-zero, then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut down.
`UpdatePolicy`	`getUpdatePolicy()` What to do when an AutoScalingGroup's instance configuration is changed.
`SubnetSelection`	`getVpcSubnets()` Where to place instances within the VPC.
`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

Methods inherited from interface software.amazon.awscdk.services.ecs.AddCapacityOptions
builder

- Constructor Detail
  - 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(AddCapacityOptions.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the AddCapacityOptions.Builder.
- Method Detail
  - getInstanceType
```
public final InstanceType getInstanceType()
```
    Description copied from interface: AddCapacityOptions
    
    The EC2 instance type to use when launching instances into the AutoScalingGroup.
    
    Specified by:
    
    getInstanceType in interface AddCapacityOptions
  - getMachineImage
```
public final IMachineImage getMachineImage()
```
    Description copied from interface: AddCapacityOptions
    The ECS-optimized AMI variant to use.
    The default is to use an ECS-optimized AMI of Amazon Linux 2 which is automatically updated to the latest version on every deployment. This will replace the instances in the AutoScalingGroup. Make sure you have not disabled task draining, to avoid downtime when the AMI updates.
    To use an image that does not update on every deployment, pass:
    EcsOptimizedImage machineImage = EcsOptimizedImage.amazonLinux2(AmiHardwareType.STANDARD, EcsOptimizedImageOptions.builder() .cachedInContext(true) .build());
    For more information, see Amazon ECS-optimized AMIs.
    You must define either machineImage or machineImageType, not both.
    Default: - Automatically updated, ECS-optimized Amazon Linux 2
    Specified by:
    
    getMachineImage in interface AddCapacityOptions
  - getCanContainersAccessInstanceRole
```
public final Boolean getCanContainersAccessInstanceRole()
```
    Description copied from interface: AddAutoScalingGroupCapacityOptions
    
    Specifies whether the containers can access the container instance role.
    Default: false
    
    Specified by:
    
    getCanContainersAccessInstanceRole in interface AddAutoScalingGroupCapacityOptions
  - getMachineImageType
```
public final MachineImageType getMachineImageType()
```
    Description copied from interface: AddAutoScalingGroupCapacityOptions
    
    What type of machine image this is.
    Depending on the setting, different UserData will automatically be added to the AutoScalingGroup to configure it properly for use with ECS.
    If you create an AutoScalingGroup yourself and are adding it via addAutoScalingGroup(), you must specify this value. If you are adding an autoScalingGroup via addCapacity, this value will be determined from the machineImage you pass.
    Default: - Automatically determined from `machineImage`, if available, otherwise `MachineImageType.AMAZON_LINUX_2`.
    
    Specified by:
    
    getMachineImageType in interface AddAutoScalingGroupCapacityOptions
  - getSpotInstanceDraining
```
public final Boolean getSpotInstanceDraining()
```
    Description copied from interface: AddAutoScalingGroupCapacityOptions
    
    Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.
    For more information, see Using Spot Instances.
    Default: false
    
    Specified by:
    
    getSpotInstanceDraining in interface AddAutoScalingGroupCapacityOptions
  - getTopicEncryptionKey
```
public final IKey getTopicEncryptionKey()
```
    Description copied from interface: AddAutoScalingGroupCapacityOptions
    
    If AddAutoScalingGroupCapacityOptions.taskDrainTime is non-zero, then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut down. If this property is provided, then this key will be used to encrypt the contents of that SNS Topic. See [SNS Data Encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html) for more information.
    Default: The SNS Topic will not be encrypted.
    
    Specified by:
    
    getTopicEncryptionKey in interface AddAutoScalingGroupCapacityOptions
  - 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.
    launchTemplate and mixedInstancesPolicy must not be specified when this property is specified
    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.
    launchTemplate and mixedInstancesPolicy must not be specified when this property is specified
    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.
    launchTemplate and mixedInstancesPolicy must not be specified when this property is specified
    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.
    launchTemplate and mixedInstancesPolicy must not be specified when this property is specified
    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
  - 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.
    launchTemplate and mixedInstancesPolicy must not be specified when this property is specified
    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
  - 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 AddCapacityOptions.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.ecs.AddCapacityOptions

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.ecs.AddCapacityOptions

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getInstanceType

getMachineImage

getCanContainersAccessInstanceRole

getMachineImageType

getSpotInstanceDraining

getTopicEncryptionKey

getAllowAllOutbound

getAssociatePublicIpAddress

getAutoScalingGroupName

getBlockDevices

getCooldown

getDesiredCapacity

getGroupMetrics

getHealthCheck

getIgnoreUnmodifiedSizeProperties

getInstanceMonitoring

getKeyName

getMaxCapacity

getMaxInstanceLifetime

getMinCapacity

getNewInstancesProtectedFromScaleIn

getNotifications

getSignals

getSpotPrice

getTerminationPolicies

getUpdatePolicy

getVpcSubnets

$jsii$toJson

equals

hashCode