Interface ServiceConnectClientAlias.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ServiceConnectClientAlias.Builder,
,ServiceConnectClientAlias> SdkBuilder<ServiceConnectClientAlias.Builder,
,ServiceConnectClientAlias> SdkPojo
- Enclosing class:
ServiceConnectClientAlias
-
Method Summary
Modifier and TypeMethodDescriptionThednsName
is the name that you use in the applications of client tasks to connect to this service.The listening port number for the Service Connect proxy.testTrafficRules
(Consumer<ServiceConnectTestTrafficRules.Builder> testTrafficRules) The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect.testTrafficRules
(ServiceConnectTestTrafficRules testTrafficRules) The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
port
The listening port number for the Service Connect proxy. 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.
- Parameters:
port
- The listening port number for the Service Connect proxy. 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:
- Returns a reference to this object so that method calls can be chained together.
-
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 thediscoveryName
isn't specified, the port mapping name from the task definition is used inportName.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 asmysql
orredis
. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.- Parameters:
dnsName
- ThednsName
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 thediscoveryName
isn't specified, the port mapping name from the task definition is used inportName.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 asmysql
orredis
. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
testTrafficRules
The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect. This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic.
- Parameters:
testTrafficRules
- The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect. This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
testTrafficRules
default ServiceConnectClientAlias.Builder testTrafficRules(Consumer<ServiceConnectTestTrafficRules.Builder> testTrafficRules) The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect. This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic.
This is a convenience method that creates an instance of theServiceConnectTestTrafficRules.Builder
avoiding the need to create one manually viaServiceConnectTestTrafficRules.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totestTrafficRules(ServiceConnectTestTrafficRules)
.- Parameters:
testTrafficRules
- a consumer that will call methods onServiceConnectTestTrafficRules.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-