software.amazon.awssdk.services.ecs.model

Class ServiceConnectConfiguration

java.lang.Object

software.amazon.awssdk.services.ecs.model.ServiceConnectConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ServiceConnectConfiguration.Builder,ServiceConnectConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class ServiceConnectConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ServiceConnectConfiguration.Builder,ServiceConnectConfiguration>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServiceConnectConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ServiceConnectConfiguration.Builder	builder()
Boolean	enabled() Specifies whether to use Service Connect with this service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasServices() For responses, this returns true if the service returned a value for the Services property.
LogConfiguration	logConfiguration() Returns the value of the LogConfiguration property for this object.
String	namespace() The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect.
List<SdkField<?>>	sdkFields()
static Class<? extends ServiceConnectConfiguration.Builder>	serializableBuilderClass()
List<ServiceConnectService>	services() The list of Service Connect service objects.
ServiceConnectConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

enabled

public final Boolean enabled()

Specifies whether to use Service Connect with this service.

Returns:

Specifies whether to use Service Connect with this service.

namespace

public final 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.

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.

hasServices

public final boolean hasServices()

For responses, this returns true if the service returned a value for the Services property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

services

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasServices() method.

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.

logConfiguration

public final LogConfiguration logConfiguration()

Returns the value of the LogConfiguration property for this object.

Returns:

The value of the LogConfiguration property for this object.

toBuilder

public ServiceConnectConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceConnectConfiguration.Builder,ServiceConnectConfiguration>

builder

public static ServiceConnectConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ServiceConnectConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo