Class AutoScalingConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.apprunner.model.AutoScalingConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AutoScalingConfiguration.Builder,AutoScalingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class AutoScalingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AutoScalingConfiguration.Builder,AutoScalingConfiguration>
Describes an App Runner automatic scaling configuration resource.
A higher
MinSizeincreases the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.A lower
MaxSizecontrols your cost. The tradeoff is lower responsiveness during peak demand.Multiple revisions of a configuration might have the same
AutoScalingConfigurationNameand differentAutoScalingConfigurationRevisionvalues.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAutoScalingConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringautoScalingConfigurationArn()The Amazon Resource Name (ARN) of this auto scaling configuration.StringautoScalingConfigurationName()The customer-provided auto scaling configuration name.IntegerautoScalingConfigurationRevision()The revision of this auto scaling configuration.static AutoScalingConfiguration.Builderbuilder()InstantcreatedAt()The time when the auto scaling configuration was created.InstantdeletedAt()The time when the auto scaling configuration was deleted.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)BooleanhasAssociatedService()Indicates if this auto scaling configuration has an App Runner service associated with it.inthashCode()BooleanisDefault()Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation.Booleanlatest()It's set totruefor the configuration with the highestRevisionamong all configurations that share the sameAutoScalingConfigurationName.IntegermaxConcurrency()The maximum number of concurrent requests that an instance processes.IntegermaxSize()The maximum number of instances that a service scales up to.IntegerminSize()The minimum number of instances that App Runner provisions for a service.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends AutoScalingConfiguration.Builder>serializableBuilderClass()AutoScalingConfigurationStatusstatus()The current state of the auto scaling configuration.StringstatusAsString()The current state of the auto scaling configuration.AutoScalingConfiguration.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
autoScalingConfigurationArn
public final String autoScalingConfigurationArn()
The Amazon Resource Name (ARN) of this auto scaling configuration.
- Returns:
- The Amazon Resource Name (ARN) of this auto scaling configuration.
-
autoScalingConfigurationName
public final String autoScalingConfigurationName()
The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
- Returns:
- The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
-
autoScalingConfigurationRevision
public final Integer autoScalingConfigurationRevision()
The revision of this auto scaling configuration. It's unique among all the active configurations (
"Status": "ACTIVE") that share the sameAutoScalingConfigurationName.- Returns:
- The revision of this auto scaling configuration. It's unique among all the active configurations (
"Status": "ACTIVE") that share the sameAutoScalingConfigurationName.
-
latest
public final Boolean latest()
It's set to
truefor the configuration with the highestRevisionamong all configurations that share the sameAutoScalingConfigurationName. It's set tofalseotherwise.- Returns:
- It's set to
truefor the configuration with the highestRevisionamong all configurations that share the sameAutoScalingConfigurationName. It's set tofalseotherwise.
-
status
public final AutoScalingConfigurationStatus status()
The current state of the auto scaling configuration. If the status of a configuration revision is
INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.If the service returns an enum value that is not available in the current SDK version,
statuswill returnAutoScalingConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current state of the auto scaling configuration. If the status of a configuration revision is
INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted. - See Also:
AutoScalingConfigurationStatus
-
statusAsString
public final String statusAsString()
The current state of the auto scaling configuration. If the status of a configuration revision is
INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.If the service returns an enum value that is not available in the current SDK version,
statuswill returnAutoScalingConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current state of the auto scaling configuration. If the status of a configuration revision is
INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted. - See Also:
AutoScalingConfigurationStatus
-
maxConcurrency
public final Integer maxConcurrency()
The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up.
- Returns:
- The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up.
-
minSize
public final Integer minSize()
The minimum number of instances that App Runner provisions for a service. The service always has at least
MinSizeprovisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
- Returns:
- The minimum number of instances that App Runner provisions for a service. The service always has at least
MinSizeprovisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
-
maxSize
public final Integer maxSize()
The maximum number of instances that a service scales up to. At most
MaxSizeinstances actively serve traffic for your service.- Returns:
- The maximum number of instances that a service scales up to. At most
MaxSizeinstances actively serve traffic for your service.
-
createdAt
public final Instant createdAt()
The time when the auto scaling configuration was created. It's in Unix time stamp format.
- Returns:
- The time when the auto scaling configuration was created. It's in Unix time stamp format.
-
deletedAt
public final Instant deletedAt()
The time when the auto scaling configuration was deleted. It's in Unix time stamp format.
- Returns:
- The time when the auto scaling configuration was deleted. It's in Unix time stamp format.
-
hasAssociatedService
public final Boolean hasAssociatedService()
Indicates if this auto scaling configuration has an App Runner service associated with it. A value of
trueindicates one or more services are associated. A value offalseindicates no services are associated.- Returns:
- Indicates if this auto scaling configuration has an App Runner service associated with it. A value of
trueindicates one or more services are associated. A value offalseindicates no services are associated.
-
isDefault
public final Boolean isDefault()
Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default
AutoScalingConfigurationper region. The defaultAutoScalingConfigurationcan be any revision under the sameAutoScalingConfigurationName.- Returns:
- Indicates if this auto scaling configuration should be used as the default for a new App Runner service
that does not have an auto scaling configuration ARN specified during creation. Each account can have
only one default
AutoScalingConfigurationper region. The defaultAutoScalingConfigurationcan be any revision under the sameAutoScalingConfigurationName.
-
toBuilder
public AutoScalingConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AutoScalingConfiguration.Builder,AutoScalingConfiguration>
-
builder
public static AutoScalingConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends AutoScalingConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-