Class: Aws::ECS::Types::ServiceConnectService

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::ServiceConnectService

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

The Service Connect service object configuration. For more information, see [Service Connect] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_aliases ⇒ Array<Types::ServiceConnectClientAlias>

  The list of client aliases for this Service Connect service.

• #discovery_name ⇒ String

  The ‘discoveryName` is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service.

• #ingress_port_override ⇒ Integer

  The port number for the Service Connect proxy to listen on.

• #port_name ⇒ String

  The ‘portName` must match the name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service.

Instance Attribute Details

#client_aliases ⇒ Array<Types::ServiceConnectClientAlias>

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:

• (Array<Types::ServiceConnectClientAlias>)

# File 'lib/aws-sdk-ecs/types.rb', line 8886

class ServiceConnectService < Struct.new(
  :port_name,
  :discovery_name,
  :client_aliases,
  :ingress_port_override)
  SENSITIVE = []
  include Aws::Structure
end

#discovery_name ⇒ String

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 the ‘discoveryName` isn’t specified, the port mapping name from the task definition is used in ‘portName.namespace`.

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 8886

class ServiceConnectService < Struct.new(
  :port_name,
  :discovery_name,
  :client_aliases,
  :ingress_port_override)
  SENSITIVE = []
  include Aws::Structure
end

#ingress_port_override ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 8886

class ServiceConnectService < Struct.new(
  :port_name,
  :discovery_name,
  :client_aliases,
  :ingress_port_override)
  SENSITIVE = []
  include Aws::Structure
end

#port_name ⇒ String

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:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 8886

class ServiceConnectService < Struct.new(
  :port_name,
  :discovery_name,
  :client_aliases,
  :ingress_port_override)
  SENSITIVE = []
  include Aws::Structure
end