software.amazon.awssdk.services.gamelift.model

Class IpPermission

java.lang.Object

software.amazon.awssdk.services.gamelift.model.IpPermission

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IpPermission.Builder,IpPermission>

@Generated(value="software.amazon.awssdk:codegen")
public final class IpPermission
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IpPermission.Builder,IpPermission>

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP for use by the Realtime servers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IpPermission.Builder

Method Summary

Modifier and Type	Method and Description
static IpPermission.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Integer	fromPort() A starting value for a range of allowed port numbers.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	ipRange() A range of allowed IP addresses.
IpProtocol	protocol() The network communication protocol used by the fleet.
String	protocolAsString() The network communication protocol used by the fleet.
List<SdkField<?>>	sdkFields()
static Class<? extends IpPermission.Builder>	serializableBuilderClass()
IpPermission.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
Integer	toPort() An ending value for a range of allowed port numbers.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fromPort

public final Integer fromPort()

A starting value for a range of allowed port numbers.

Returns:

A starting value for a range of allowed port numbers.

toPort

public final Integer toPort()

An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

Returns:

An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

ipRange

public final String ipRange()

A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: " 000.000.000.000/[subnet mask]" or optionally the shortened version " 0.0.0.0/[subnet mask]".

Returns:

A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: " 000.000.000.000/[subnet mask]" or optionally the shortened version " 0.0.0.0/[subnet mask]".

protocol

public final IpProtocol protocol()

The network communication protocol used by the fleet.

If the service returns an enum value that is not available in the current SDK version, protocol will return IpProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

The network communication protocol used by the fleet.

See Also:

IpProtocol

protocolAsString

public final String protocolAsString()

The network communication protocol used by the fleet.

If the service returns an enum value that is not available in the current SDK version, protocol will return IpProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

The network communication protocol used by the fleet.

See Also:

IpProtocol

toBuilder

public IpPermission.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<IpPermission.Builder,IpPermission>

Returns:

a builder for type T

builder

public static IpPermission.Builder builder()

serializableBuilderClass

public static Class<? extends IpPermission.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.