com.amazonaws.services.gamelift.model.IpPermission Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.gamelift.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in
* a fleet. New game sessions are assigned an IP address/port number combination, which must fall into the fleet's
* allowed ranges. Fleets with custom game builds must have permissions explicitly set. For Realtime Servers fleets,
* GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.
*
*
* Related actions
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IpPermission implements Serializable, Cloneable, StructuredPojo {
/**
*
* A starting value for a range of allowed port numbers.
*
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds, only
* port 443, 1026-60000 are valid.
*
*/
private Integer fromPort;
/**
*
* An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher
* than FromPort.
*
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds, only
* port 443, 1026-60000 are valid.
*
*/
private Integer toPort;
/**
*
* 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]".
*
*/
private String ipRange;
/**
*
* The network communication protocol used by the fleet.
*
*/
private String protocol;
/**
*
* A starting value for a range of allowed port numbers.
*
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds, only
* port 443, 1026-60000 are valid.
*
*
* @param fromPort
* A starting value for a range of allowed port numbers.
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds,
* only port 443, 1026-60000 are valid.
*/
public void setFromPort(Integer fromPort) {
this.fromPort = fromPort;
}
/**
*
* A starting value for a range of allowed port numbers.
*
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds, only
* port 443, 1026-60000 are valid.
*
*
* @return A starting value for a range of allowed port numbers.
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds,
* only port 443, 1026-60000 are valid.
*/
public Integer getFromPort() {
return this.fromPort;
}
/**
*
* A starting value for a range of allowed port numbers.
*
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds, only
* port 443, 1026-60000 are valid.
*
*
* @param fromPort
* A starting value for a range of allowed port numbers.
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds,
* only port 443, 1026-60000 are valid.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withFromPort(Integer fromPort) {
setFromPort(fromPort);
return this;
}
/**
*
* An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher
* than FromPort.
*
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds, only
* port 443, 1026-60000 are valid.
*
*
* @param toPort
* An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be
* higher than FromPort.
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds,
* only port 443, 1026-60000 are valid.
*/
public void setToPort(Integer toPort) {
this.toPort = toPort;
}
/**
*
* An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher
* than FromPort.
*
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds, only
* port 443, 1026-60000 are valid.
*
*
* @return An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be
* higher than FromPort.
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds,
* only port 443, 1026-60000 are valid.
*/
public Integer getToPort() {
return this.toPort;
}
/**
*
* An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher
* than FromPort.
*
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds, only
* port 443, 1026-60000 are valid.
*
*
* @param toPort
* An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be
* higher than FromPort.
*
* For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds,
* only port 443, 1026-60000 are valid.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withToPort(Integer toPort) {
setToPort(toPort);
return this;
}
/**
*
* 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]".
*
*
* @param 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]".
*/
public void setIpRange(String ipRange) {
this.ipRange = 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]".
*
*
* @return 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]".
*/
public String getIpRange() {
return this.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]".
*
*
* @param 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]".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withIpRange(String ipRange) {
setIpRange(ipRange);
return this;
}
/**
*
* The network communication protocol used by the fleet.
*
*
* @param protocol
* The network communication protocol used by the fleet.
* @see IpProtocol
*/
public void setProtocol(String protocol) {
this.protocol = protocol;
}
/**
*
* The network communication protocol used by the fleet.
*
*
* @return The network communication protocol used by the fleet.
* @see IpProtocol
*/
public String getProtocol() {
return this.protocol;
}
/**
*
* The network communication protocol used by the fleet.
*
*
* @param protocol
* The network communication protocol used by the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IpProtocol
*/
public IpPermission withProtocol(String protocol) {
setProtocol(protocol);
return this;
}
/**
*
* The network communication protocol used by the fleet.
*
*
* @param protocol
* The network communication protocol used by the fleet.
* @see IpProtocol
*/
public void setProtocol(IpProtocol protocol) {
withProtocol(protocol);
}
/**
*
* The network communication protocol used by the fleet.
*
*
* @param protocol
* The network communication protocol used by the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IpProtocol
*/
public IpPermission withProtocol(IpProtocol protocol) {
this.protocol = protocol.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFromPort() != null)
sb.append("FromPort: ").append(getFromPort()).append(",");
if (getToPort() != null)
sb.append("ToPort: ").append(getToPort()).append(",");
if (getIpRange() != null)
sb.append("IpRange: ").append(getIpRange()).append(",");
if (getProtocol() != null)
sb.append("Protocol: ").append(getProtocol());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IpPermission == false)
return false;
IpPermission other = (IpPermission) obj;
if (other.getFromPort() == null ^ this.getFromPort() == null)
return false;
if (other.getFromPort() != null && other.getFromPort().equals(this.getFromPort()) == false)
return false;
if (other.getToPort() == null ^ this.getToPort() == null)
return false;
if (other.getToPort() != null && other.getToPort().equals(this.getToPort()) == false)
return false;
if (other.getIpRange() == null ^ this.getIpRange() == null)
return false;
if (other.getIpRange() != null && other.getIpRange().equals(this.getIpRange()) == false)
return false;
if (other.getProtocol() == null ^ this.getProtocol() == null)
return false;
if (other.getProtocol() != null && other.getProtocol().equals(this.getProtocol()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFromPort() == null) ? 0 : getFromPort().hashCode());
hashCode = prime * hashCode + ((getToPort() == null) ? 0 : getToPort().hashCode());
hashCode = prime * hashCode + ((getIpRange() == null) ? 0 : getIpRange().hashCode());
hashCode = prime * hashCode + ((getProtocol() == null) ? 0 : getProtocol().hashCode());
return hashCode;
}
@Override
public IpPermission clone() {
try {
return (IpPermission) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.gamelift.model.transform.IpPermissionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}