ServiceConnectService (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.ServiceConnectService

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ServiceConnectService
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ServiceConnectService()

Constructors
Constructor and Description
`ServiceConnectService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceConnectService`	`clone()`
`boolean`	`equals(Object obj)`
`List<ServiceConnectClientAlias>`	`getClientAliases()` The list of client aliases for this Service Connect service.
`String`	`getDiscoveryName()` The `discoveryName` is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service.
`Integer`	`getIngressPortOverride()` The port number for the Service Connect proxy to listen on.
`String`	`getPortName()` The `portName` must match the name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setClientAliases(Collection<ServiceConnectClientAlias> clientAliases)` The list of client aliases for this Service Connect service.
`void`	`setDiscoveryName(String discoveryName)` The `discoveryName` is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service.
`void`	`setIngressPortOverride(Integer ingressPortOverride)` The port number for the Service Connect proxy to listen on.
`void`	`setPortName(String portName)` The `portName` must match the name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service.
`String`	`toString()` Returns a string representation of this object.
`ServiceConnectService`	`withClientAliases(Collection<ServiceConnectClientAlias> clientAliases)` The list of client aliases for this Service Connect service.
`ServiceConnectService`	`withClientAliases(ServiceConnectClientAlias... clientAliases)` The list of client aliases for this Service Connect service.
`ServiceConnectService`	`withDiscoveryName(String discoveryName)` The `discoveryName` is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service.
`ServiceConnectService`	`withIngressPortOverride(Integer ingressPortOverride)` The port number for the Service Connect proxy to listen on.
`ServiceConnectService`	`withPortName(String portName)` The `portName` must match the name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service.

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

- Constructor Detail
  - ServiceConnectService
```
public ServiceConnectService()
```
- Method Detail
  - setPortName
```
public void setPortName(String portName)
```
    The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
    
    Parameters:
    
    portName - The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
  - getPortName
```
public String getPortName()
```
    The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
    
    Returns:
    
    The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
  - withPortName
```
public ServiceConnectService withPortName(String portName)
```
    The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
    
    Parameters:
    
    portName - The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDiscoveryName
```
public void setDiscoveryName(String discoveryName)
```
    The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
    
    If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
    
    Parameters:
    
    discoveryName - The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
    
    If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
  - getDiscoveryName
```
public String getDiscoveryName()
```
    The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
    
    If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
    
    Returns:
    
    The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
    
    If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
  - withDiscoveryName
```
public ServiceConnectService withDiscoveryName(String discoveryName)
```
    The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
    
    If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
    
    Parameters:
    
    discoveryName - The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
    
    If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getClientAliases
```
public List<ServiceConnectClientAlias> getClientAliases()
```
    The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
    
    Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
    
    Each name and port mapping must be unique within the namespace.
    
    For each ServiceConnectService, you must provide at least one clientAlias with one port.
    
    Returns:
    
    The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
    
    Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
    
    Each name and port mapping must be unique within the namespace.
    
    For each ServiceConnectService, you must provide at least one clientAlias with one port.
  - setClientAliases
```
public void setClientAliases(Collection<ServiceConnectClientAlias> clientAliases)
```
    The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
    
    Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
    
    Each name and port mapping must be unique within the namespace.
    
    For each ServiceConnectService, you must provide at least one clientAlias with one port.
    
    Parameters:
    
    clientAliases - The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
    
    Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
    
    Each name and port mapping must be unique within the namespace.
    
    For each ServiceConnectService, you must provide at least one clientAlias with one port.
  - withClientAliases
```
public ServiceConnectService withClientAliases(ServiceConnectClientAlias... clientAliases)
```
    The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
    
    Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
    
    Each name and port mapping must be unique within the namespace.
    
    For each ServiceConnectService, you must provide at least one clientAlias with one port.
    
    NOTE: This method appends the values to the existing list (if any). Use setClientAliases(java.util.Collection) or withClientAliases(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    clientAliases - The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
    
    Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
    
    Each name and port mapping must be unique within the namespace.
    
    For each ServiceConnectService, you must provide at least one clientAlias with one port.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withClientAliases
```
public ServiceConnectService withClientAliases(Collection<ServiceConnectClientAlias> clientAliases)
```
    The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
    
    Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
    
    Each name and port mapping must be unique within the namespace.
    
    For each ServiceConnectService, you must provide at least one clientAlias with one port.
    
    Parameters:
    
    clientAliases - The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
    
    Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
    
    Each name and port mapping must be unique within the namespace.
    
    For each ServiceConnectService, you must provide at least one clientAlias with one port.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIngressPortOverride
```
public void setIngressPortOverride(Integer ingressPortOverride)
```
    The port number for the Service Connect proxy to listen on.
    
    Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.
    
    In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.
    
    Parameters:
    
    ingressPortOverride - The port number for the Service Connect proxy to listen on.
    
    Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.
    
    In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.
  - getIngressPortOverride
```
public Integer getIngressPortOverride()
```
    The port number for the Service Connect proxy to listen on.
    
    Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.
    
    In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.
    
    Returns:
    
    The port number for the Service Connect proxy to listen on.
    
    Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.
    
    In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.
  - withIngressPortOverride
```
public ServiceConnectService withIngressPortOverride(Integer ingressPortOverride)
```
    The port number for the Service Connect proxy to listen on.
    
    Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.
    
    In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.
    
    Parameters:
    
    ingressPortOverride - The port number for the Service Connect proxy to listen on.
    
    Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.
    
    In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 ServiceConnectService 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 ServiceConnectService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceConnectService

Method Detail

setPortName

getPortName

withPortName

setDiscoveryName

getDiscoveryName

withDiscoveryName

getClientAliases

setClientAliases

withClientAliases

withClientAliases

setIngressPortOverride

getIngressPortOverride

withIngressPortOverride

toString

equals

hashCode

clone

marshall