ServiceConnectConfiguration (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ServiceConnectConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. 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

ServiceConnectConfiguration()

Constructors
Constructor and Description
`ServiceConnectConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceConnectConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getEnabled()` Specifies whether to use Service Connect with this service.
`LogConfiguration`	`getLogConfiguration()`
`String`	`getNamespace()` The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect.
`List<ServiceConnectService>`	`getServices()` The list of Service Connect service objects.
`int`	`hashCode()`
`Boolean`	`isEnabled()` Specifies whether to use Service Connect with this service.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEnabled(Boolean enabled)` Specifies whether to use Service Connect with this service.
`void`	`setLogConfiguration(LogConfiguration logConfiguration)`
`void`	`setNamespace(String namespace)` The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect.
`void`	`setServices(Collection<ServiceConnectService> services)` The list of Service Connect service objects.
`String`	`toString()` Returns a string representation of this object.
`ServiceConnectConfiguration`	`withEnabled(Boolean enabled)` Specifies whether to use Service Connect with this service.
`ServiceConnectConfiguration`	`withLogConfiguration(LogConfiguration logConfiguration)`
`ServiceConnectConfiguration`	`withNamespace(String namespace)` The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect.
`ServiceConnectConfiguration`	`withServices(Collection<ServiceConnectService> services)` The list of Service Connect service objects.
`ServiceConnectConfiguration`	`withServices(ServiceConnectService... services)` The list of Service Connect service objects.

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

- Constructor Detail
  - ServiceConnectConfiguration
```
public ServiceConnectConfiguration()
```
- Method Detail
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Specifies whether to use Service Connect with this service.
    
    Parameters:
    
    enabled - Specifies whether to use Service Connect with this service.
  - getEnabled
```
public Boolean getEnabled()
```
    Specifies whether to use Service Connect with this service.
    
    Returns:
    
    Specifies whether to use Service Connect with this service.
  - withEnabled
```
public ServiceConnectConfiguration withEnabled(Boolean enabled)
```
    Specifies whether to use Service Connect with this service.
    
    Parameters:
    
    enabled - Specifies whether to use Service Connect with this service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    Specifies whether to use Service Connect with this service.
    
    Returns:
    
    Specifies whether to use Service Connect with this service.
  - setNamespace
```
public void setNamespace(String namespace)
```
    The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
    
    Parameters:
    
    namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
  - getNamespace
```
public String getNamespace()
```
    The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
    
    Returns:
    
    The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
  - withNamespace
```
public ServiceConnectConfiguration withNamespace(String namespace)
```
    The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
    
    Parameters:
    
    namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getServices
```
public List<ServiceConnectService> getServices()
```
    The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
    
    This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
    
    An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
    
    Returns:
    
    The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
    
    This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
    
    An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
  - setServices
```
public void setServices(Collection<ServiceConnectService> services)
```
    The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
    
    This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
    
    An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
    
    Parameters:
    
    services - The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
    
    This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
    
    An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
  - withServices
```
public ServiceConnectConfiguration withServices(ServiceConnectService... services)
```
    The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
    
    This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
    
    An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
    
    NOTE: This method appends the values to the existing list (if any). Use setServices(java.util.Collection) or withServices(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    services - The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
    
    This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
    
    An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withServices
```
public ServiceConnectConfiguration withServices(Collection<ServiceConnectService> services)
```
    The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
    
    This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
    
    An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
    
    Parameters:
    
    services - The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
    
    This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
    
    An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogConfiguration
```
public void setLogConfiguration(LogConfiguration logConfiguration)
```
    Parameters:
    
    logConfiguration -
  - getLogConfiguration
```
public LogConfiguration getLogConfiguration()
```
    Returns:
  - withLogConfiguration
```
public ServiceConnectConfiguration withLogConfiguration(LogConfiguration logConfiguration)
```
    Parameters:
    
    logConfiguration -
    
    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 ServiceConnectConfiguration 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 ServiceConnectConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceConnectConfiguration

Method Detail

setEnabled

getEnabled

withEnabled

isEnabled

setNamespace

getNamespace

withNamespace

getServices

setServices

withServices

withServices

setLogConfiguration

getLogConfiguration

withLogConfiguration

toString

equals

hashCode

clone

marshall