Package software.amazon.awscdk.services.servicediscovery

Interface IpInstanceBaseProps

All Superinterfaces:

BaseInstanceProps, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IpInstanceProps

All Known Implementing Classes:

IpInstanceBaseProps.Jsii$Proxy, IpInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:30.369Z")
@Stability(Stable)
public interface IpInstanceBaseProps
extends software.amazon.jsii.JsiiSerializable, BaseInstanceProps

Example:

 import software.amazon.awscdk.*;
 import software.amazon.awscdk.*;
 App app = new App();
 Stack stack = new Stack(app, "aws-servicediscovery-integ");
 HttpNamespace namespace = HttpNamespace.Builder.create(stack, "MyNamespace")
         .name("MyHTTPNamespace")
         .build();
 Service service1 = namespace.createService("NonIpService", BaseServiceProps.builder()
         .description("service registering non-ip instances")
         .build());
 service1.registerNonIpInstance("NonIpInstance", NonIpInstanceBaseProps.builder()
         .customAttributes(Map.of("arn", "arn:aws:s3:::amzn-s3-demo-bucket"))
         .build());
 Service service2 = namespace.createService("IpService", BaseServiceProps.builder()
         .description("service registering ip instances")
         .healthCheck(HealthCheckConfig.builder()
                 .type(HealthCheckType.HTTP)
                 .resourcePath("/check")
                 .build())
         .build());
 service2.registerIpInstance("IpInstance", IpInstanceBaseProps.builder()
         .ipv4("54.239.25.192")
         .build());
 app.synth();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IpInstanceBaseProps.Builder	A builder for IpInstanceBaseProps
static final class	IpInstanceBaseProps.Jsii$Proxy	An implementation for IpInstanceBaseProps

Method Summary

Modifier and Type	Method	Description
static IpInstanceBaseProps.Builder	builder()
default String	getIpv4()	If the service that you specify contains a template for an A record, the IPv4 address that you want AWS Cloud Map to use for the value of the A record.
default String	getIpv6()	If the service that you specify contains a template for an AAAA record, the IPv6 address that you want AWS Cloud Map to use for the value of the AAAA record.
default Number	getPort()	The port on the endpoint that you want AWS Cloud Map to perform health checks on.

Methods inherited from interface software.amazon.awscdk.services.servicediscovery.BaseInstanceProps

getCustomAttributes, getInstanceId

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIpv4

@Stability(Stable)
@Nullable
default String getIpv4()

If the service that you specify contains a template for an A record, the IPv4 address that you want AWS Cloud Map to use for the value of the A record.

Default: none

getIpv6

@Stability(Stable)
@Nullable
default String getIpv6()

If the service that you specify contains a template for an AAAA record, the IPv6 address that you want AWS Cloud Map to use for the value of the AAAA record.

Default: none

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The port on the endpoint that you want AWS Cloud Map to perform health checks on.

This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. You can also specify a default port that is applied to all instances in the Service configuration.

Default: 80

builder

@Stability(Stable)
static IpInstanceBaseProps.Builder builder()

Returns:

a IpInstanceBaseProps.Builder of IpInstanceBaseProps