software.amazon.awssdk.services.ecs.model

Class ServiceConnectService

java.lang.Object

software.amazon.awssdk.services.ecs.model.ServiceConnectService

All Implemented Interfaces:

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

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

The Service Connect service object configuration. 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	ServiceConnectService.Builder

Method Summary

Modifier and Type	Method and Description
static ServiceConnectService.Builder	builder()
List<ServiceConnectClientAlias>	clientAliases() The list of client aliases for this Service Connect service.
String	discoveryName() The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClientAliases() For responses, this returns true if the service returned a value for the ClientAliases property.
int	hashCode()
Integer	ingressPortOverride() The port number for the Service Connect proxy to listen on.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends ServiceConnectService.Builder>	serializableBuilderClass()
ServiceConnectService.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

portName

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

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.

discoveryName

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

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.

hasClientAliases

public final boolean hasClientAliases()

For responses, this returns true if the service returned a value for the ClientAliases 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.

clientAliases

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

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 hasClientAliases() method.

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.

ingressPortOverride

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

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.

toBuilder

public ServiceConnectService.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceConnectService.Builder,ServiceConnectService>

builder

public static ServiceConnectService.Builder builder()

serializableBuilderClass

public static Class<? extends ServiceConnectService.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