com.amazonaws.services.ecs.model.PortMapping Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecs Show documentation
/*
* Copyright 2014-2019 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.ecs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port
* mappings are specified as part of the container definition.
*
*
* If you are using containers in a task with the awsvpc or host network mode, exposed ports
* should be specified using containerPort. The hostPort can be left blank or it must be the
* same value as the containerPort.
*
*
* After a task reaches the RUNNING status, manual and automatic host and container port assignments are
* visible in the networkBindings section of DescribeTasks API responses.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PortMapping implements Serializable, Cloneable, StructuredPojo {
/**
*
* The port number on the container that is bound to the user-specified or automatically assigned host port.
*
*
* If you are using containers in a task with the awsvpc or host network mode, exposed
* ports should be specified using containerPort.
*
*
* If you are using containers in a task with the bridge network mode and you specify a container port
* and not a host port, your container automatically receives a host port in the ephemeral port range. For more
* information, see hostPort. Port mappings that are automatically assigned in this way do not count
* toward the 100 reserved ports limit of a container instance.
*
*
*
* You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted.
*
*
*/
private Integer containerPort;
/**
*
* The port number on the container instance to reserve for your container.
*
*
* If you are using containers in a task with the awsvpc or host network mode, the
* hostPort can either be left blank or set to the same value as the containerPort.
*
*
* If you are using containers in a task with the bridge network mode, you can specify a non-reserved
* host port for your container port mapping, or you can omit the hostPort (or set it to 0
* ) while specifying a containerPort and your container automatically receives a port in the ephemeral
* port range for your container instance operating system and Docker version.
*
*
* The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under
* /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default
* ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral
* port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the
* ephemeral port range.
*
*
*
* The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
*
*
*
* The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent
* ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task
* is running (after a task stops, the host port is released). The current reserved ports are displayed in the
* remainingResources of DescribeContainerInstances output. A container instance can have up to
* 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count
* toward the 100 reserved ports limit.
*
*/
private Integer hostPort;
/**
*
* The protocol used for the port mapping. Valid values are tcp and udp. The default is
* tcp.
*
*/
private String protocol;
/**
*
* The port number on the container that is bound to the user-specified or automatically assigned host port.
*
*
* If you are using containers in a task with the awsvpc or host network mode, exposed
* ports should be specified using containerPort.
*
*
* If you are using containers in a task with the bridge network mode and you specify a container port
* and not a host port, your container automatically receives a host port in the ephemeral port range. For more
* information, see hostPort. Port mappings that are automatically assigned in this way do not count
* toward the 100 reserved ports limit of a container instance.
*
*
*
* You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted.
*
*
*
* @param containerPort
* The port number on the container that is bound to the user-specified or automatically assigned host
* port.
*
* If you are using containers in a task with the awsvpc or host network mode,
* exposed ports should be specified using containerPort.
*
*
* If you are using containers in a task with the bridge network mode and you specify a
* container port and not a host port, your container automatically receives a host port in the ephemeral
* port range. For more information, see hostPort. Port mappings that are automatically assigned
* in this way do not count toward the 100 reserved ports limit of a container instance.
*
*
*
* You cannot expose the same container port for multiple protocols. An error will be returned if this is
* attempted.
*
*/
public void setContainerPort(Integer containerPort) {
this.containerPort = containerPort;
}
/**
*
* The port number on the container that is bound to the user-specified or automatically assigned host port.
*
*
* If you are using containers in a task with the awsvpc or host network mode, exposed
* ports should be specified using containerPort.
*
*
* If you are using containers in a task with the bridge network mode and you specify a container port
* and not a host port, your container automatically receives a host port in the ephemeral port range. For more
* information, see hostPort. Port mappings that are automatically assigned in this way do not count
* toward the 100 reserved ports limit of a container instance.
*
*
*
* You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted.
*
*
*
* @return The port number on the container that is bound to the user-specified or automatically assigned host
* port.
*
* If you are using containers in a task with the awsvpc or host network mode,
* exposed ports should be specified using containerPort.
*
*
* If you are using containers in a task with the bridge network mode and you specify a
* container port and not a host port, your container automatically receives a host port in the ephemeral
* port range. For more information, see hostPort. Port mappings that are automatically
* assigned in this way do not count toward the 100 reserved ports limit of a container instance.
*
*
*
* You cannot expose the same container port for multiple protocols. An error will be returned if this is
* attempted.
*
*/
public Integer getContainerPort() {
return this.containerPort;
}
/**
*
* The port number on the container that is bound to the user-specified or automatically assigned host port.
*
*
* If you are using containers in a task with the awsvpc or host network mode, exposed
* ports should be specified using containerPort.
*
*
* If you are using containers in a task with the bridge network mode and you specify a container port
* and not a host port, your container automatically receives a host port in the ephemeral port range. For more
* information, see hostPort. Port mappings that are automatically assigned in this way do not count
* toward the 100 reserved ports limit of a container instance.
*
*
*
* You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted.
*
*
*
* @param containerPort
* The port number on the container that is bound to the user-specified or automatically assigned host
* port.
*
* If you are using containers in a task with the awsvpc or host network mode,
* exposed ports should be specified using containerPort.
*
*
* If you are using containers in a task with the bridge network mode and you specify a
* container port and not a host port, your container automatically receives a host port in the ephemeral
* port range. For more information, see hostPort. Port mappings that are automatically assigned
* in this way do not count toward the 100 reserved ports limit of a container instance.
*
*
*
* You cannot expose the same container port for multiple protocols. An error will be returned if this is
* attempted.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PortMapping withContainerPort(Integer containerPort) {
setContainerPort(containerPort);
return this;
}
/**
*
* The port number on the container instance to reserve for your container.
*
*
* If you are using containers in a task with the awsvpc or host network mode, the
* hostPort can either be left blank or set to the same value as the containerPort.
*
*
* If you are using containers in a task with the bridge network mode, you can specify a non-reserved
* host port for your container port mapping, or you can omit the hostPort (or set it to 0
* ) while specifying a containerPort and your container automatically receives a port in the ephemeral
* port range for your container instance operating system and Docker version.
*
*
* The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under
* /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default
* ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral
* port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the
* ephemeral port range.
*
*
*
* The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
*
*
*
* The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent
* ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task
* is running (after a task stops, the host port is released). The current reserved ports are displayed in the
* remainingResources of DescribeContainerInstances output. A container instance can have up to
* 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count
* toward the 100 reserved ports limit.
*
*
* @param hostPort
* The port number on the container instance to reserve for your container.
*
* If you are using containers in a task with the awsvpc or host network mode, the
* hostPort can either be left blank or set to the same value as the containerPort.
*
*
* If you are using containers in a task with the bridge network mode, you can specify a
* non-reserved host port for your container port mapping, or you can omit the hostPort (or set
* it to 0) while specifying a containerPort and your container automatically
* receives a port in the ephemeral port range for your container instance operating system and Docker
* version.
*
*
* The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under
* /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default
* ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the
* ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are
* outside of the ephemeral port range.
*
*
*
* The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
*
*
*
* The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container
* agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved
* while the task is running (after a task stops, the host port is released). The current reserved ports are
* displayed in the remainingResources of DescribeContainerInstances output. A container
* instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically
* assigned ports don't count toward the 100 reserved ports limit.
*/
public void setHostPort(Integer hostPort) {
this.hostPort = hostPort;
}
/**
*
* The port number on the container instance to reserve for your container.
*
*
* If you are using containers in a task with the awsvpc or host network mode, the
* hostPort can either be left blank or set to the same value as the containerPort.
*
*
* If you are using containers in a task with the bridge network mode, you can specify a non-reserved
* host port for your container port mapping, or you can omit the hostPort (or set it to 0
* ) while specifying a containerPort and your container automatically receives a port in the ephemeral
* port range for your container instance operating system and Docker version.
*
*
* The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under
* /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default
* ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral
* port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the
* ephemeral port range.
*
*
*
* The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
*
*
*
* The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent
* ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task
* is running (after a task stops, the host port is released). The current reserved ports are displayed in the
* remainingResources of DescribeContainerInstances output. A container instance can have up to
* 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count
* toward the 100 reserved ports limit.
*
*
* @return The port number on the container instance to reserve for your container.
*
* If you are using containers in a task with the awsvpc or host network mode, the
* hostPort can either be left blank or set to the same value as the containerPort
* .
*
*
* If you are using containers in a task with the bridge network mode, you can specify a
* non-reserved host port for your container port mapping, or you can omit the hostPort (or set
* it to 0) while specifying a containerPort and your container automatically
* receives a port in the ephemeral port range for your container instance operating system and Docker
* version.
*
*
* The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under
* /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default
* ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the
* ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are
* outside of the ephemeral port range.
*
*
*
* The default ephemeral port range from 49153 through 65535 is always used for Docker versions before
* 1.6.0.
*
*
*
* The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container
* agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved
* while the task is running (after a task stops, the host port is released). The current reserved ports are
* displayed in the remainingResources of DescribeContainerInstances output. A container
* instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically
* assigned ports don't count toward the 100 reserved ports limit.
*/
public Integer getHostPort() {
return this.hostPort;
}
/**
*
* The port number on the container instance to reserve for your container.
*
*
* If you are using containers in a task with the awsvpc or host network mode, the
* hostPort can either be left blank or set to the same value as the containerPort.
*
*
* If you are using containers in a task with the bridge network mode, you can specify a non-reserved
* host port for your container port mapping, or you can omit the hostPort (or set it to 0
* ) while specifying a containerPort and your container automatically receives a port in the ephemeral
* port range for your container instance operating system and Docker version.
*
*
* The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under
* /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default
* ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral
* port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the
* ephemeral port range.
*
*
*
* The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
*
*
*
* The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent
* ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task
* is running (after a task stops, the host port is released). The current reserved ports are displayed in the
* remainingResources of DescribeContainerInstances output. A container instance can have up to
* 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count
* toward the 100 reserved ports limit.
*
*
* @param hostPort
* The port number on the container instance to reserve for your container.
*
* If you are using containers in a task with the awsvpc or host network mode, the
* hostPort can either be left blank or set to the same value as the containerPort.
*
*
* If you are using containers in a task with the bridge network mode, you can specify a
* non-reserved host port for your container port mapping, or you can omit the hostPort (or set
* it to 0) while specifying a containerPort and your container automatically
* receives a port in the ephemeral port range for your container instance operating system and Docker
* version.
*
*
* The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under
* /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default
* ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the
* ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are
* outside of the ephemeral port range.
*
*
*
* The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
*
*
*
* The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container
* agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved
* while the task is running (after a task stops, the host port is released). The current reserved ports are
* displayed in the remainingResources of DescribeContainerInstances output. A container
* instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically
* assigned ports don't count toward the 100 reserved ports limit.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PortMapping withHostPort(Integer hostPort) {
setHostPort(hostPort);
return this;
}
/**
*
* The protocol used for the port mapping. Valid values are tcp and udp. The default is
* tcp.
*
*
* @param protocol
* The protocol used for the port mapping. Valid values are tcp and udp. The
* default is tcp.
* @see TransportProtocol
*/
public void setProtocol(String protocol) {
this.protocol = protocol;
}
/**
*
* The protocol used for the port mapping. Valid values are tcp and udp. The default is
* tcp.
*
*
* @return The protocol used for the port mapping. Valid values are tcp and udp. The
* default is tcp.
* @see TransportProtocol
*/
public String getProtocol() {
return this.protocol;
}
/**
*
* The protocol used for the port mapping. Valid values are tcp and udp. The default is
* tcp.
*
*
* @param protocol
* The protocol used for the port mapping. Valid values are tcp and udp. The
* default is tcp.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransportProtocol
*/
public PortMapping withProtocol(String protocol) {
setProtocol(protocol);
return this;
}
/**
*
* The protocol used for the port mapping. Valid values are tcp and udp. The default is
* tcp.
*
*
* @param protocol
* The protocol used for the port mapping. Valid values are tcp and udp. The
* default is tcp.
* @see TransportProtocol
*/
public void setProtocol(TransportProtocol protocol) {
withProtocol(protocol);
}
/**
*
* The protocol used for the port mapping. Valid values are tcp and udp. The default is
* tcp.
*
*
* @param protocol
* The protocol used for the port mapping. Valid values are tcp and udp. The
* default is tcp.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransportProtocol
*/
public PortMapping withProtocol(TransportProtocol 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 (getContainerPort() != null)
sb.append("ContainerPort: ").append(getContainerPort()).append(",");
if (getHostPort() != null)
sb.append("HostPort: ").append(getHostPort()).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 PortMapping == false)
return false;
PortMapping other = (PortMapping) obj;
if (other.getContainerPort() == null ^ this.getContainerPort() == null)
return false;
if (other.getContainerPort() != null && other.getContainerPort().equals(this.getContainerPort()) == false)
return false;
if (other.getHostPort() == null ^ this.getHostPort() == null)
return false;
if (other.getHostPort() != null && other.getHostPort().equals(this.getHostPort()) == 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 + ((getContainerPort() == null) ? 0 : getContainerPort().hashCode());
hashCode = prime * hashCode + ((getHostPort() == null) ? 0 : getHostPort().hashCode());
hashCode = prime * hashCode + ((getProtocol() == null) ? 0 : getProtocol().hashCode());
return hashCode;
}
@Override
public PortMapping clone() {
try {
return (PortMapping) 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.ecs.model.transform.PortMappingMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}