Package software.amazon.awscdk.services.servicediscovery

Class CfnService.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnService.Builder create(Construct scope, String id)
      Parameters:
      scope - - scope in which this resource is defined. This parameter is required.
      id - - scoped id of the resource. This parameter is required.
      Returns:
      a new instance of CfnService.Builder.

    • description

      @Stability(Stable) public CfnService.Builder description(String description)
      The description of the service.

      Parameters:
      description - The description of the service. This parameter is required.
      Returns:
      this

    • dnsConfig

      @Stability(Stable) public CfnService.Builder dnsConfig(IResolvable dnsConfig)
      A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

      The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig .

      Parameters:
      dnsConfig - A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance. This parameter is required.
      Returns:
      this

    • dnsConfig

      @Stability(Stable) public CfnService.Builder dnsConfig(CfnService.DnsConfigProperty dnsConfig)
      A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

      The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig .

      Parameters:
      dnsConfig - A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance. This parameter is required.
      Returns:
      this

    • healthCheckConfig

      @Stability(Stable) public CfnService.Builder healthCheckConfig(IResolvable healthCheckConfig)
      *Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in `DnsConfig` .

      For information about the charges for health checks, see Amazon Route 53 Pricing .

      Parameters:
      healthCheckConfig - *Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in `DnsConfig` . This parameter is required.
      Returns:
      this

    • healthCheckConfig

      @Stability(Stable) public CfnService.Builder healthCheckConfig(CfnService.HealthCheckConfigProperty healthCheckConfig)
      *Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in `DnsConfig` .

      For information about the charges for health checks, see Amazon Route 53 Pricing .

      Parameters:
      healthCheckConfig - *Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in `DnsConfig` . This parameter is required.
      Returns:
      this

    • healthCheckCustomConfig

      @Stability(Stable) public CfnService.Builder healthCheckCustomConfig(IResolvable 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.

      Parameters:
      healthCheckCustomConfig - A complex type that contains information about an optional custom health check. This parameter is required.
      Returns:
      this

    • healthCheckCustomConfig

      @Stability(Stable) public CfnService.Builder healthCheckCustomConfig(CfnService.HealthCheckCustomConfigProperty 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.

      Parameters:
      healthCheckCustomConfig - A complex type that contains information about an optional custom health check. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnService.Builder name(String name)
      The name of the service.

      Parameters:
      name - The name of the service. This parameter is required.
      Returns:
      this

    • namespaceId

      @Stability(Stable) public CfnService.Builder namespaceId(String namespaceId)
      The ID of the namespace that was used to create the service.

      You must specify a value for NamespaceId either for the service properties or for DnsConfig . Don't specify a value in both places.

      Parameters:
      namespaceId - The ID of the namespace that was used to create the service. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnService.Builder tags(List<? extends CfnTag> tags)
      The tags for the service.

      Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      Parameters:
      tags - The tags for the service. This parameter is required.
      Returns:
      this

    • type

      @Stability(Stable) public CfnService.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. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnService build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnService>