AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

IpInstance

Instance that is accessible using an IP address.

Import

import { IpInstance } from 'aws-cdk-lib/aws-servicediscovery';

Or use the module namespace:

import * as servicediscovery from 'aws-cdk-lib/aws-servicediscovery';
// servicediscovery.IpInstance

Properties

Configuration passed to the constructor as IpInstanceProps.

serviceRequired
IService

The Cloudmap service this resource is registered to.

3 properties inherited from IpInstanceBaseProps
ipv4Optionalinherited from IpInstanceBaseProps
string

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

ipv6Optionalinherited from IpInstanceBaseProps
string

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

portOptionalinherited from IpInstanceBaseProps
number

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

2 properties inherited from BaseInstanceProps
customAttributesOptionalinherited from BaseInstanceProps
{ [key: string]: string }

Custom attributes of the instance.

Default: none

instanceIdOptionalinherited from BaseInstanceProps
string

The id of the instance resource.

Default: Automatically generated name

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL2 (Higher-level)
Moduleaws-servicediscovery
Properties6

Related Constructs

Explore This Service

External Links