aws-cdk-lib.aws_servicediscovery.IpInstanceProps

interface IpInstanceProps

LanguageType name
.NETAmazon.CDK.AWS.ServiceDiscovery.IpInstanceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsservicediscovery#IpInstanceProps
Javasoftware.amazon.awscdk.services.servicediscovery.IpInstanceProps
Pythonaws_cdk.aws_servicediscovery.IpInstanceProps
TypeScript (source)aws-cdk-lib » aws_servicediscovery » IpInstanceProps

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_servicediscovery as servicediscovery } from 'aws-cdk-lib';

declare const service: servicediscovery.Service;
const ipInstanceProps: servicediscovery.IpInstanceProps = {
  service: service,

  // the properties below are optional
  customAttributes: {
    customAttributesKey: 'customAttributes',
  },
  instanceId: 'instanceId',
  ipv4: 'ipv4',
  ipv6: 'ipv6',
  port: 123,
};

Properties

NameTypeDescription
serviceIServiceThe Cloudmap service this resource is registered to.
customAttributes?{ [string]: string }Custom attributes of the instance.
instanceId?stringThe id of the instance resource.
ipv4?stringIf 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.
ipv6?stringIf 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.
port?numberThe port on the endpoint that you want AWS Cloud Map to perform health checks on.

service

Type: IService

The Cloudmap service this resource is registered to.


customAttributes?

Type: { [string]: string } (optional, default: none)

Custom attributes of the instance.


instanceId?

Type: string (optional, default: Automatically generated name)

The id of the instance resource.


ipv4?

Type: string (optional, default: none)

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.


ipv6?

Type: string (optional, default: none)

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.


port?

Type: number (optional, default: 80)

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.