Package software.amazon.awssdk.services.servicediscovery.model

Interface CreateServiceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>, SdkBuilder<CreateServiceRequest.Builder,CreateServiceRequest>, SdkPojo, SdkRequest.Builder, ServiceDiscoveryRequest.Builder
Enclosing class:
CreateServiceRequest
public static interface CreateServiceRequest.Builder extends ServiceDiscoveryRequest.Builder, SdkPojo, CopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

  • Method Details

    • name

      CreateServiceRequest.Builder name(String name)

      The name that you want to assign to the service.

      Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.

      If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

      • Start the name with an underscore (_), such as _exampleservice.

      • End the name with ._protocol, such as ._tcp.

      When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

      _exampleservice._tcp.example.com).

      For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.

      Parameters:
      name - The name that you want to assign to the service.

      Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.

      If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

      • Start the name with an underscore (_), such as _exampleservice.

      • End the name with ._protocol, such as ._tcp.

      When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

      _exampleservice._tcp.example.com).

      For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • namespaceId

      CreateServiceRequest.Builder namespaceId(String namespaceId)

      The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the DnsConfig object.

      Parameters:
      namespaceId - The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the DnsConfig object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creatorRequestId

      CreateServiceRequest.Builder creatorRequestId(String creatorRequestId)

      A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

      Parameters:
      creatorRequestId - A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateServiceRequest.Builder description(String description)

      A description for the service.

      Parameters:
      description - A description for the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dnsConfig

      CreateServiceRequest.Builder dnsConfig(DnsConfig dnsConfig)

      A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.

      Parameters:
      dnsConfig - A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dnsConfig

      default CreateServiceRequest.Builder dnsConfig(Consumer<DnsConfig.Builder> dnsConfig)

      A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.

      This is a convenience method that creates an instance of the DnsConfig.Builder avoiding the need to create one manually via DnsConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dnsConfig(DnsConfig).

      Parameters:
      dnsConfig - a consumer that will call methods on DnsConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • healthCheckConfig

      CreateServiceRequest.Builder healthCheckConfig(HealthCheckConfig healthCheckConfig)

      Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig.

      If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

      For information about the charges for health checks, see Cloud Map Pricing.

      Parameters:
      healthCheckConfig - Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig.

      If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

      For information about the charges for health checks, see Cloud Map Pricing.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthCheckConfig

      default CreateServiceRequest.Builder healthCheckConfig(Consumer<HealthCheckConfig.Builder> healthCheckConfig)

      Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig.

      If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

      For information about the charges for health checks, see Cloud Map Pricing.

      This is a convenience method that creates an instance of the HealthCheckConfig.Builder avoiding the need to create one manually via HealthCheckConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to healthCheckConfig(HealthCheckConfig).

      Parameters:
      healthCheckConfig - a consumer that will call methods on HealthCheckConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • healthCheckCustomConfig

      CreateServiceRequest.Builder healthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig)

      A complex type that contains information about an optional custom health check.

      If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

      You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

      Parameters:
      healthCheckCustomConfig - A complex type that contains information about an optional custom health check.

      If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

      You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthCheckCustomConfig

      default CreateServiceRequest.Builder healthCheckCustomConfig(Consumer<HealthCheckCustomConfig.Builder> healthCheckCustomConfig)

      A complex type that contains information about an optional custom health check.

      If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

      You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

      This is a convenience method that creates an instance of the HealthCheckCustomConfig.Builder avoiding the need to create one manually via HealthCheckCustomConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to healthCheckCustomConfig(HealthCheckCustomConfig).

      Parameters:
      healthCheckCustomConfig - a consumer that will call methods on HealthCheckCustomConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateServiceRequest.Builder tags(Collection<Tag> tags)

      The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

      Parameters:
      tags - The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateServiceRequest.Builder tags(Tag... tags)

      The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

      Parameters:
      tags - The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateServiceRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreateServiceRequest.Builder type(String type)

      If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

      Parameters:
      type - If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreateServiceRequest.Builder type(ServiceTypeOption type)

      If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

      Parameters:
      type - If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateServiceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateServiceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.