#include <ServiceConnectService.h>
The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
See Also:
Definition at line 37 of file ServiceConnectService.h.
◆ ServiceConnectService() [1/2]
| AWS_ECS_API Aws::ECS::Model::ServiceConnectService::ServiceConnectService | ( | ) |
◆ ServiceConnectService() [2/2]
◆ AddClientAliases() [1/2]
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.
Definition at line 282 of file ServiceConnectService.h.
◆ AddClientAliases() [2/2]
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.
Definition at line 294 of file ServiceConnectService.h.
◆ ClientAliasesHasBeenSet()
| inline |
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.
Definition at line 222 of file ServiceConnectService.h.
◆ DiscoveryNameHasBeenSet()
| inline |
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 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.
Definition at line 125 of file ServiceConnectService.h.
◆ GetClientAliases()
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.
Definition at line 210 of file ServiceConnectService.h.
◆ GetDiscoveryName()
| inline |
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 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.
Definition at line 113 of file ServiceConnectService.h.
◆ GetIngressPortOverride()
| inline |
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.
Definition at line 307 of file ServiceConnectService.h.
◆ GetPortName()
| inline |
The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
Definition at line 51 of file ServiceConnectService.h.
◆ IngressPortOverrideHasBeenSet()
| inline |
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.
Definition at line 319 of file ServiceConnectService.h.
◆ operator=()
◆ PortNameHasBeenSet()
| inline |
The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
Definition at line 58 of file ServiceConnectService.h.
◆ SetClientAliases() [1/2]
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.
Definition at line 246 of file ServiceConnectService.h.
◆ SetClientAliases() [2/2]
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.
Definition at line 234 of file ServiceConnectService.h.
◆ SetDiscoveryName() [1/3]
| inline |
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 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.
Definition at line 149 of file ServiceConnectService.h.
◆ SetDiscoveryName() [2/3]
| inline |
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 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.
Definition at line 137 of file ServiceConnectService.h.
◆ SetDiscoveryName() [3/3]
| inline |
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 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.
Definition at line 161 of file ServiceConnectService.h.
◆ SetIngressPortOverride()
| inline |
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.
Definition at line 331 of file ServiceConnectService.h.
◆ SetPortName() [1/3]
| inline |
The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
Definition at line 72 of file ServiceConnectService.h.
◆ SetPortName() [2/3]
| inline |
The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
Definition at line 65 of file ServiceConnectService.h.
◆ SetPortName() [3/3]
| inline |
The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
Definition at line 79 of file ServiceConnectService.h.
◆ WithClientAliases() [1/2]
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.
Definition at line 270 of file ServiceConnectService.h.
◆ WithClientAliases() [2/2]
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.
Definition at line 258 of file ServiceConnectService.h.
◆ WithDiscoveryName() [1/3]
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 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.
Definition at line 185 of file ServiceConnectService.h.
◆ WithDiscoveryName() [2/3]
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 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.
Definition at line 173 of file ServiceConnectService.h.
◆ WithDiscoveryName() [3/3]
| inline |
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 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.
Definition at line 197 of file ServiceConnectService.h.
◆ WithIngressPortOverride()
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.
Definition at line 343 of file ServiceConnectService.h.
◆ WithPortName() [1/3]
The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
Definition at line 93 of file ServiceConnectService.h.
◆ WithPortName() [2/3]
The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
Definition at line 86 of file ServiceConnectService.h.
◆ WithPortName() [3/3]
The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
Definition at line 100 of file ServiceConnectService.h.
The documentation for this class was generated from the following file:
