Package software.amazon.awssdk.services.ecs.model

Class ServiceConnectServiceResource

java.lang.Object
software.amazon.awssdk.services.ecs.model.ServiceConnectServiceResource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ServiceConnectServiceResource.Builder,ServiceConnectServiceResource>
@Generated("software.amazon.awssdk:codegen") public final class ServiceConnectServiceResource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ServiceConnectServiceResource.Builder,ServiceConnectServiceResource>

The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name. The data is stored in Cloud Map as part of the Service Connect configuration for each discovery name of this Amazon ECS service.

A task can resolve the dnsName for each of the clientAliases of a service. However a task can't resolve the discovery names. If you want to connect to a service, refer to the ServiceConnectConfiguration of that service for the list of clientAliases that you can use.

See Also:

  • Method Details

    • discoveryName

      public final String discoveryName()

      The discovery name of this Service Connect resource.

      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.

      Returns:
      The discovery name of this Service Connect resource.

      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.

    • discoveryArn

      public final String discoveryArn()

      The Amazon Resource Name (ARN) for the service in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.

      Returns:
      The Amazon Resource Name (ARN) for the service in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.

    • toBuilder

      public ServiceConnectServiceResource.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ServiceConnectServiceResource.Builder,ServiceConnectServiceResource>

    • builder

      public static ServiceConnectServiceResource.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ServiceConnectServiceResource.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo