Struct ServiceConnectService

#[non_exhaustive]
pub struct ServiceConnectService {
    pub port_name: String,
    pub discovery_name: Option<String>,
    pub client_aliases: Option<Vec<ServiceConnectClientAlias>>,
    pub ingress_port_override: Option<i32>,
    pub timeout: Option<TimeoutConfiguration>,
    pub tls: Option<ServiceConnectTlsConfiguration>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

discovery_name: Option<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.

client_aliases: Option<Vec<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.

ingress_port_override: Option<i32>

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.

timeout: Option<TimeoutConfiguration>

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

tls: Option<ServiceConnectTlsConfiguration>

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

Implementations

impl ServiceConnectService

pub fn port_name(&self) -> &str

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

pub fn discovery_name(&self) -> Option<&str>

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.

pub fn client_aliases(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .client_aliases.is_none().

pub fn ingress_port_override(&self) -> Option<i32>

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.

pub fn timeout(&self) -> Option<&TimeoutConfiguration>

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

pub fn tls(&self) -> Option<&ServiceConnectTlsConfiguration>

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

impl ServiceConnectService

pub fn builder() -> ServiceConnectServiceBuilder

Creates a new builder-style object to manufacture ServiceConnectService.

Trait Implementations

impl Clone for ServiceConnectService

fn clone(&self) -> ServiceConnectService

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServiceConnectService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ServiceConnectService

fn eq(&self, other: &ServiceConnectService) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ServiceConnectService