software.amazon.awscdk.services.applicationautoscaling.ScalingSchedule Maven / Gradle / Ivy
Show all versions of applicationautoscaling Show documentation
package software.amazon.awscdk.services.applicationautoscaling;
/**
* A scheduled scaling action.
*
* Example:
*
*
* Cluster cluster;
* ApplicationLoadBalancedFargateService loadBalancedFargateService = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
* .cluster(cluster)
* .memoryLimitMiB(1024)
* .desiredCount(1)
* .cpu(512)
* .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
* .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
* .build())
* .build();
* ScalableTaskCount scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount(EnableScalingProps.builder()
* .minCapacity(5)
* .maxCapacity(20)
* .build());
* scalableTarget.scaleOnSchedule("DaytimeScaleDown", ScalingSchedule.builder()
* .schedule(Schedule.cron(CronOptions.builder().hour("8").minute("0").build()))
* .minCapacity(1)
* .build());
* scalableTarget.scaleOnSchedule("EveningRushScaleUp", ScalingSchedule.builder()
* .schedule(Schedule.cron(CronOptions.builder().hour("20").minute("0").build()))
* .minCapacity(10)
* .build());
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.72.0 (build 4b8828b)", date = "2022-12-28T21:57:08.301Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.applicationautoscaling.$Module.class, fqn = "@aws-cdk/aws-applicationautoscaling.ScalingSchedule")
@software.amazon.jsii.Jsii.Proxy(ScalingSchedule.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface ScalingSchedule extends software.amazon.jsii.JsiiSerializable {
/**
* When to perform this action.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull software.amazon.awscdk.services.applicationautoscaling.Schedule getSchedule();
/**
* When this scheduled action expires.
*
* Default: The rule never expires.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.time.Instant getEndTime() {
return null;
}
/**
* The new maximum capacity.
*
* During the scheduled time, the current capacity is above the maximum
* capacity, Application Auto Scaling scales in to the maximum capacity.
*
* At least one of maxCapacity and minCapacity must be supplied.
*
* Default: No new maximum capacity
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getMaxCapacity() {
return null;
}
/**
* The new minimum capacity.
*
* During the scheduled time, if the current capacity is below the minimum
* capacity, Application Auto Scaling scales out to the minimum capacity.
*
* At least one of maxCapacity and minCapacity must be supplied.
*
* Default: No new minimum capacity
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getMinCapacity() {
return null;
}
/**
* When this scheduled action becomes active.
*
* Default: The rule is activate immediately
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.time.Instant getStartTime() {
return null;
}
/**
* @return a {@link Builder} of {@link ScalingSchedule}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link ScalingSchedule}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
software.amazon.awscdk.services.applicationautoscaling.Schedule schedule;
java.time.Instant endTime;
java.lang.Number maxCapacity;
java.lang.Number minCapacity;
java.time.Instant startTime;
/**
* Sets the value of {@link ScalingSchedule#getSchedule}
* @param schedule When to perform this action. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder schedule(software.amazon.awscdk.services.applicationautoscaling.Schedule schedule) {
this.schedule = schedule;
return this;
}
/**
* Sets the value of {@link ScalingSchedule#getEndTime}
* @param endTime When this scheduled action expires.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder endTime(java.time.Instant endTime) {
this.endTime = endTime;
return this;
}
/**
* Sets the value of {@link ScalingSchedule#getMaxCapacity}
* @param maxCapacity The new maximum capacity.
* During the scheduled time, the current capacity is above the maximum
* capacity, Application Auto Scaling scales in to the maximum capacity.
*
* At least one of maxCapacity and minCapacity must be supplied.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder maxCapacity(java.lang.Number maxCapacity) {
this.maxCapacity = maxCapacity;
return this;
}
/**
* Sets the value of {@link ScalingSchedule#getMinCapacity}
* @param minCapacity The new minimum capacity.
* During the scheduled time, if the current capacity is below the minimum
* capacity, Application Auto Scaling scales out to the minimum capacity.
*
* At least one of maxCapacity and minCapacity must be supplied.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder minCapacity(java.lang.Number minCapacity) {
this.minCapacity = minCapacity;
return this;
}
/**
* Sets the value of {@link ScalingSchedule#getStartTime}
* @param startTime When this scheduled action becomes active.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder startTime(java.time.Instant startTime) {
this.startTime = startTime;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link ScalingSchedule}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public ScalingSchedule build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link ScalingSchedule}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ScalingSchedule {
private final software.amazon.awscdk.services.applicationautoscaling.Schedule schedule;
private final java.time.Instant endTime;
private final java.lang.Number maxCapacity;
private final java.lang.Number minCapacity;
private final java.time.Instant startTime;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.schedule = software.amazon.jsii.Kernel.get(this, "schedule", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.applicationautoscaling.Schedule.class));
this.endTime = software.amazon.jsii.Kernel.get(this, "endTime", software.amazon.jsii.NativeType.forClass(java.time.Instant.class));
this.maxCapacity = software.amazon.jsii.Kernel.get(this, "maxCapacity", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.minCapacity = software.amazon.jsii.Kernel.get(this, "minCapacity", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.startTime = software.amazon.jsii.Kernel.get(this, "startTime", software.amazon.jsii.NativeType.forClass(java.time.Instant.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.schedule = java.util.Objects.requireNonNull(builder.schedule, "schedule is required");
this.endTime = builder.endTime;
this.maxCapacity = builder.maxCapacity;
this.minCapacity = builder.minCapacity;
this.startTime = builder.startTime;
}
@Override
public final software.amazon.awscdk.services.applicationautoscaling.Schedule getSchedule() {
return this.schedule;
}
@Override
public final java.time.Instant getEndTime() {
return this.endTime;
}
@Override
public final java.lang.Number getMaxCapacity() {
return this.maxCapacity;
}
@Override
public final java.lang.Number getMinCapacity() {
return this.minCapacity;
}
@Override
public final java.time.Instant getStartTime() {
return this.startTime;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("schedule", om.valueToTree(this.getSchedule()));
if (this.getEndTime() != null) {
data.set("endTime", om.valueToTree(this.getEndTime()));
}
if (this.getMaxCapacity() != null) {
data.set("maxCapacity", om.valueToTree(this.getMaxCapacity()));
}
if (this.getMinCapacity() != null) {
data.set("minCapacity", om.valueToTree(this.getMinCapacity()));
}
if (this.getStartTime() != null) {
data.set("startTime", om.valueToTree(this.getStartTime()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-applicationautoscaling.ScalingSchedule"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
ScalingSchedule.Jsii$Proxy that = (ScalingSchedule.Jsii$Proxy) o;
if (!schedule.equals(that.schedule)) return false;
if (this.endTime != null ? !this.endTime.equals(that.endTime) : that.endTime != null) return false;
if (this.maxCapacity != null ? !this.maxCapacity.equals(that.maxCapacity) : that.maxCapacity != null) return false;
if (this.minCapacity != null ? !this.minCapacity.equals(that.minCapacity) : that.minCapacity != null) return false;
return this.startTime != null ? this.startTime.equals(that.startTime) : that.startTime == null;
}
@Override
public final int hashCode() {
int result = this.schedule.hashCode();
result = 31 * result + (this.endTime != null ? this.endTime.hashCode() : 0);
result = 31 * result + (this.maxCapacity != null ? this.maxCapacity.hashCode() : 0);
result = 31 * result + (this.minCapacity != null ? this.minCapacity.hashCode() : 0);
result = 31 * result + (this.startTime != null ? this.startTime.hashCode() : 0);
return result;
}
}
}