Package software.amazon.awscdk.services.ecs

Class CfnService.ServiceConnectClientAliasProperty.Builder

java.lang.Object
software.amazon.awscdk.services.ecs.CfnService.ServiceConnectClientAliasProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnService.ServiceConnectClientAliasProperty>
Enclosing interface:
CfnService.ServiceConnectClientAliasProperty
@Stability(Stable) public static final class CfnService.ServiceConnectClientAliasProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnService.ServiceConnectClientAliasProperty>
A builder for CfnService.ServiceConnectClientAliasProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • port

      @Stability(Stable) public CfnService.ServiceConnectClientAliasProperty.Builder port(Number port)
      Sets the value of CfnService.ServiceConnectClientAliasProperty.getPort()
      Parameters:
      port - The listening port number for the Service Connect proxy. This parameter is required. This port is available inside of all of the tasks within the same namespace.

      To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .

      Returns:
      this

    • dnsName

      @Stability(Stable) public CfnService.ServiceConnectClientAliasProperty.Builder dnsName(String dnsName)
      Sets the value of CfnService.ServiceConnectClientAliasProperty.getDnsName()
      Parameters:
      dnsName - The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). 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 .

      To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database , db , or the lowercase name of a database, such as mysql or redis . For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .

      Returns:
      this

    • build

      @Stability(Stable) public CfnService.ServiceConnectClientAliasProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnService.ServiceConnectClientAliasProperty>
      Returns:
      a new instance of CfnService.ServiceConnectClientAliasProperty
      Throws:
      NullPointerException - if any required attribute was not provided