software.amazon.awssdk.services.ecs.model

Interface ServiceConnectService.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ServiceConnectService.Builder,ServiceConnectService>, SdkBuilder<ServiceConnectService.Builder,ServiceConnectService>, SdkPojo

Enclosing class:

ServiceConnectService

public static interface ServiceConnectService.Builder
extends SdkPojo, CopyableBuilder<ServiceConnectService.Builder,ServiceConnectService>

Method Summary

Modifier and Type	Method and Description
ServiceConnectService.Builder	clientAliases(Collection<ServiceConnectClientAlias> clientAliases) The list of client aliases for this Service Connect service.
ServiceConnectService.Builder	clientAliases(Consumer<ServiceConnectClientAlias.Builder>... clientAliases) The list of client aliases for this Service Connect service.
ServiceConnectService.Builder	clientAliases(ServiceConnectClientAlias... clientAliases) The list of client aliases for this Service Connect service.
ServiceConnectService.Builder	discoveryName(String discoveryName) The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service.
ServiceConnectService.Builder	ingressPortOverride(Integer ingressPortOverride) The port number for the Service Connect proxy to listen on.
ServiceConnectService.Builder	portName(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 interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

portName

ServiceConnectService.Builder portName(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.

discoveryName

ServiceConnectService.Builder discoveryName(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.

clientAliases

ServiceConnectService.Builder clientAliases(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.

clientAliases

ServiceConnectService.Builder clientAliases(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.

clientAliases

ServiceConnectService.Builder clientAliases(Consumer<ServiceConnectClientAlias.Builder>... 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.

This is a convenience method that creates an instance of the ServiceConnectClientAlias.Builder avoiding the need to create one manually via ServiceConnectClientAlias.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #clientAliases(List).

Parameters:

clientAliases - a consumer that will call methods on ServiceConnectClientAlias.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#clientAliases(java.util.Collection)

ingressPortOverride

ServiceConnectService.Builder ingressPortOverride(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.