IpPermission (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.model.IpPermission

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IpPermission
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IpPermission()

Constructors
Constructor and Description
`IpPermission()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IpPermission`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getFromPort()` A starting value for a range of allowed port numbers.
`String`	`getIpRange()` A range of allowed IP addresses.
`String`	`getProtocol()` The network communication protocol used by the fleet.
`Integer`	`getToPort()` An ending value for a range of allowed port numbers.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFromPort(Integer fromPort)` A starting value for a range of allowed port numbers.
`void`	`setIpRange(String ipRange)` A range of allowed IP addresses.
`void`	`setProtocol(IpProtocol protocol)` The network communication protocol used by the fleet.
`void`	`setProtocol(String protocol)` The network communication protocol used by the fleet.
`void`	`setToPort(Integer toPort)` An ending value for a range of allowed port numbers.
`String`	`toString()` Returns a string representation of this object.
`IpPermission`	`withFromPort(Integer fromPort)` A starting value for a range of allowed port numbers.
`IpPermission`	`withIpRange(String ipRange)` A range of allowed IP addresses.
`IpPermission`	`withProtocol(IpProtocol protocol)` The network communication protocol used by the fleet.
`IpPermission`	`withProtocol(String protocol)` The network communication protocol used by the fleet.
`IpPermission`	`withToPort(Integer toPort)` An ending value for a range of allowed port numbers.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IpPermission
```
public IpPermission()
```
- Method Detail
  - setFromPort
```
public void setFromPort(Integer fromPort)
```
    A starting value for a range of allowed port numbers.
    
    Parameters:
    
    fromPort - A starting value for a range of allowed port numbers.
  - getFromPort
```
public Integer getFromPort()
```
    A starting value for a range of allowed port numbers.
    
    Returns:
    
    A starting value for a range of allowed port numbers.
  - withFromPort
```
public IpPermission withFromPort(Integer fromPort)
```
    A starting value for a range of allowed port numbers.
    
    Parameters:
    
    fromPort - A starting value for a range of allowed port numbers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setToPort
```
public void setToPort(Integer toPort)
```
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    
    Parameters:
    
    toPort - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
  - getToPort
```
public Integer getToPort()
```
    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.
  - withToPort
```
public IpPermission withToPort(Integer toPort)
```
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    
    Parameters:
    
    toPort - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpRange
```
public void setIpRange(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]".
    
    Parameters:
    
    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]".
  - getIpRange
```
public String getIpRange()
```
    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]".
  - withIpRange
```
public IpPermission withIpRange(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]".
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocol
```
public void setProtocol(String protocol)
```
    The network communication protocol used by the fleet.
    
    Parameters:
    
    protocol - The network communication protocol used by the fleet.
    
    See Also:
    
    IpProtocol
  - getProtocol
```
public String getProtocol()
```
    The network communication protocol used by the fleet.
    
    Returns:
    
    The network communication protocol used by the fleet.
    
    See Also:
    
    IpProtocol
  - withProtocol
```
public IpPermission withProtocol(String protocol)
```
    The network communication protocol used by the fleet.
    
    Parameters:
    
    protocol - The network communication protocol used by the fleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IpProtocol
  - setProtocol
```
public void setProtocol(IpProtocol protocol)
```
    The network communication protocol used by the fleet.
    
    Parameters:
    
    protocol - The network communication protocol used by the fleet.
    
    See Also:
    
    IpProtocol
  - withProtocol
```
public IpPermission withProtocol(IpProtocol protocol)
```
    The network communication protocol used by the fleet.
    
    Parameters:
    
    protocol - The network communication protocol used by the fleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IpProtocol
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public IpPermission clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class IpPermission

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IpPermission

Method Detail

setFromPort

getFromPort

withFromPort

setToPort

getToPort

withToPort

setIpRange

getIpRange

withIpRange

setProtocol

getProtocol

withProtocol

setProtocol

withProtocol

toString

equals

hashCode

clone

marshall