software.amazon.awscdk.services.gamelift.alpha.Location Maven / Gradle / Ivy
Show all versions of gamelift-alpha Show documentation
package software.amazon.awscdk.services.gamelift.alpha;
/**
* (experimental) A remote location where a multi-location fleet can deploy EC2 instances for game hosting.
*
* Example:
*
*
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.gamelift.alpha.*;
* Location location = Location.builder()
* .region("region")
* // the properties below are optional
* .capacity(LocationCapacity.builder()
* .desiredCapacity(123)
* .maxSize(123)
* .minSize(123)
* .build())
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-12-27T17:02:12.130Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.gamelift.alpha.$Module.class, fqn = "@aws-cdk/aws-gamelift-alpha.Location")
@software.amazon.jsii.Jsii.Proxy(Location.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface Location extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) An AWS Region code.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getRegion();
/**
* (experimental) Current resource capacity settings in a specified fleet or location.
*
* The location value might refer to a fleet's remote location or its home Region.
*
* Default: no capacity settings on the specified location
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.gamelift.alpha.LocationCapacity getCapacity() {
return null;
}
/**
* @return a {@link Builder} of {@link Location}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link Location}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String region;
software.amazon.awscdk.services.gamelift.alpha.LocationCapacity capacity;
/**
* Sets the value of {@link Location#getRegion}
* @param region An AWS Region code. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder region(java.lang.String region) {
this.region = region;
return this;
}
/**
* Sets the value of {@link Location#getCapacity}
* @param capacity Current resource capacity settings in a specified fleet or location.
* The location value might refer to a fleet's remote location or its home Region.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder capacity(software.amazon.awscdk.services.gamelift.alpha.LocationCapacity capacity) {
this.capacity = capacity;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link Location}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public Location build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link Location}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements Location {
private final java.lang.String region;
private final software.amazon.awscdk.services.gamelift.alpha.LocationCapacity capacity;
/**
* 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.region = software.amazon.jsii.Kernel.get(this, "region", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.capacity = software.amazon.jsii.Kernel.get(this, "capacity", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.gamelift.alpha.LocationCapacity.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.region = java.util.Objects.requireNonNull(builder.region, "region is required");
this.capacity = builder.capacity;
}
@Override
public final java.lang.String getRegion() {
return this.region;
}
@Override
public final software.amazon.awscdk.services.gamelift.alpha.LocationCapacity getCapacity() {
return this.capacity;
}
@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("region", om.valueToTree(this.getRegion()));
if (this.getCapacity() != null) {
data.set("capacity", om.valueToTree(this.getCapacity()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-gamelift-alpha.Location"));
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;
Location.Jsii$Proxy that = (Location.Jsii$Proxy) o;
if (!region.equals(that.region)) return false;
return this.capacity != null ? this.capacity.equals(that.capacity) : that.capacity == null;
}
@Override
public final int hashCode() {
int result = this.region.hashCode();
result = 31 * result + (this.capacity != null ? this.capacity.hashCode() : 0);
return result;
}
}
}