Package software.amazon.awscdk.services.ecs

Interface CfnService.ServiceConnectConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnService.ServiceConnectConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnService
@Stability(Stable) public static interface CfnService.ServiceConnectConfigurationProperty extends software.amazon.jsii.JsiiSerializable
The Service Connect configuration of your Amazon ECS service.

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 ServiceConnectConfigurationProperty serviceConnectConfigurationProperty = ServiceConnectConfigurationProperty.builder()
         .enabled(false)
         // the properties below are optional
         .logConfiguration(LogConfigurationProperty.builder()
                 .logDriver("logDriver")
                 .options(Map.of(
                         "optionsKey", "options"))
                 .secretOptions(List.of(SecretProperty.builder()
                         .name("name")
                         .valueFrom("valueFrom")
                         .build()))
                 .build())
         .namespace("namespace")
         .services(List.of(ServiceConnectServiceProperty.builder()
                 .portName("portName")
                 // the properties below are optional
                 .clientAliases(List.of(ServiceConnectClientAliasProperty.builder()
                         .port(123)
                         // the properties below are optional
                         .dnsName("dnsName")
                         .build()))
                 .discoveryName("discoveryName")
                 .ingressPortOverride(123)
                 .build()))
         .build();

  • Method Details

    • getEnabled

      @Stability(Stable) @NotNull Object getEnabled()
      Specifies whether to use Service Connect with this service.

    • getLogConfiguration

      @Stability(Stable) @Nullable default Object getLogConfiguration()
      The log configuration for the container.

      This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .

      By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

      Understand the following when specifying a log configuration for your containers.

      • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.
      • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
      • For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide .
      • For tasks that are on AWS Fargate , because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

    • getNamespace

      @Stability(Stable) @Nullable default String getNamespace()
      The namespace name or full Amazon Resource Name (ARN) of the AWS Cloud Map namespace for use with Service Connect.

      The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about AWS Cloud Map , see Working with Services in the AWS Cloud Map Developer Guide .

    • getServices

      @Stability(Stable) @Nullable default Object getServices()
      The list of Service Connect service objects.

      These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

      This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

      An object selects a port from the task definition, assigns a name for the AWS Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

    • builder

      @Stability(Stable) static CfnService.ServiceConnectConfigurationProperty.Builder builder()
      Returns:
      a CfnService.ServiceConnectConfigurationProperty.Builder of CfnService.ServiceConnectConfigurationProperty