Package software.amazon.awscdk.services.ecs

Class CfnService.ServiceConnectServiceProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.CfnService.ServiceConnectServiceProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnService.ServiceConnectServiceProperty>

Enclosing interface:

CfnService.ServiceConnectServiceProperty

@Stability(Stable)
public static final class CfnService.ServiceConnectServiceProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnService.ServiceConnectServiceProperty>

A builder for CfnService.ServiceConnectServiceProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnService.ServiceConnectServiceProperty	build()	Builds the configured instance.
CfnService.ServiceConnectServiceProperty.Builder	clientAliases(List<? extends Object> clientAliases)	Sets the value of CfnService.ServiceConnectServiceProperty.getClientAliases()
CfnService.ServiceConnectServiceProperty.Builder	clientAliases(IResolvable clientAliases)	Sets the value of CfnService.ServiceConnectServiceProperty.getClientAliases()
CfnService.ServiceConnectServiceProperty.Builder	discoveryName(String discoveryName)	Sets the value of CfnService.ServiceConnectServiceProperty.getDiscoveryName()
CfnService.ServiceConnectServiceProperty.Builder	ingressPortOverride(Number ingressPortOverride)	Sets the value of CfnService.ServiceConnectServiceProperty.getIngressPortOverride()
CfnService.ServiceConnectServiceProperty.Builder	portName(String portName)	Sets the value of CfnService.ServiceConnectServiceProperty.getPortName()
CfnService.ServiceConnectServiceProperty.Builder	timeout(IResolvable timeout)	Sets the value of CfnService.ServiceConnectServiceProperty.getTimeout()
CfnService.ServiceConnectServiceProperty.Builder	timeout(CfnService.TimeoutConfigurationProperty timeout)	Sets the value of CfnService.ServiceConnectServiceProperty.getTimeout()
CfnService.ServiceConnectServiceProperty.Builder	tls(IResolvable tls)	Sets the value of CfnService.ServiceConnectServiceProperty.getTls()
CfnService.ServiceConnectServiceProperty.Builder	tls(CfnService.ServiceConnectTlsConfigurationProperty tls)	Sets the value of CfnService.ServiceConnectServiceProperty.getTls()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

portName

@Stability(Stable)
public CfnService.ServiceConnectServiceProperty.Builder portName(String portName)

Sets the value of CfnService.ServiceConnectServiceProperty.getPortName()

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. This parameter is required.

Returns:

this

clientAliases

@Stability(Stable)
public CfnService.ServiceConnectServiceProperty.Builder clientAliases(IResolvable clientAliases)

Sets the value of CfnService.ServiceConnectServiceProperty.getClientAliases()

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:

this

clientAliases

@Stability(Stable)
public CfnService.ServiceConnectServiceProperty.Builder clientAliases(List<? extends Object> clientAliases)

Sets the value of CfnService.ServiceConnectServiceProperty.getClientAliases()

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:

this

discoveryName

@Stability(Stable)
public CfnService.ServiceConnectServiceProperty.Builder discoveryName(String discoveryName)

Sets the value of CfnService.ServiceConnectServiceProperty.getDiscoveryName()

Parameters:

discoveryName - The discoveryName is the name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the AWS 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 the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace .

Returns:

this

ingressPortOverride

@Stability(Stable)
public CfnService.ServiceConnectServiceProperty.Builder ingressPortOverride(Number ingressPortOverride)

Sets the value of CfnService.ServiceConnectServiceProperty.getIngressPortOverride()

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:

this

timeout

@Stability(Stable)
public CfnService.ServiceConnectServiceProperty.Builder timeout(IResolvable timeout)

Sets the value of CfnService.ServiceConnectServiceProperty.getTimeout()

Parameters:

timeout - A reference to an object that represents the configured timeouts for Service Connect.

Returns:

this

timeout

@Stability(Stable)
public CfnService.ServiceConnectServiceProperty.Builder timeout(CfnService.TimeoutConfigurationProperty timeout)

Sets the value of CfnService.ServiceConnectServiceProperty.getTimeout()

Parameters:

timeout - A reference to an object that represents the configured timeouts for Service Connect.

Returns:

this

tls

@Stability(Stable)
public CfnService.ServiceConnectServiceProperty.Builder tls(IResolvable tls)

Sets the value of CfnService.ServiceConnectServiceProperty.getTls()

Parameters:

tls - A reference to an object that represents a Transport Layer Security (TLS) configuration.

Returns:

this

tls

@Stability(Stable)
public CfnService.ServiceConnectServiceProperty.Builder tls(CfnService.ServiceConnectTlsConfigurationProperty tls)

Sets the value of CfnService.ServiceConnectServiceProperty.getTls()

Parameters:

tls - A reference to an object that represents a Transport Layer Security (TLS) configuration.

Returns:

this

build

@Stability(Stable)
public CfnService.ServiceConnectServiceProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnService.ServiceConnectServiceProperty>

Returns:

a new instance of CfnService.ServiceConnectServiceProperty

Throws:

NullPointerException - if any required attribute was not provided