IpInstanceBaseProps
- class aws_cdk.aws_servicediscovery.IpInstanceBaseProps(*, custom_attributes=None, instance_id=None, ipv4=None, ipv6=None, port=None)
Bases:
BaseInstanceProps
- Parameters:
custom_attributes (
Optional
[Mapping
[str
,str
]]) – Custom attributes of the instance. Default: noneinstance_id (
Optional
[str
]) – The id of the instance resource. Default: Automatically generated nameipv4 (
Optional
[str
]) – 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: noneipv6 (
Optional
[str
]) – 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: noneport (
Union
[int
,float
,None
]) – 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
- ExampleMetadata:
lit=aws-servicediscovery/test/integ.service-with-http-namespace.lit.ts infused
Example:
import aws_cdk as cdk import aws_cdk as servicediscovery app = cdk.App() stack = cdk.Stack(app, "aws-servicediscovery-integ") namespace = servicediscovery.HttpNamespace(stack, "MyNamespace", name="MyHTTPNamespace" ) service1 = namespace.create_service("NonIpService", description="service registering non-ip instances" ) service1.register_non_ip_instance("NonIpInstance", custom_attributes={"arn": "arn:aws:s3:::mybucket"} ) service2 = namespace.create_service("IpService", description="service registering ip instances", health_check=cdk.aws_servicediscovery.HealthCheckConfig( type=servicediscovery.HealthCheckType.HTTP, resource_path="/check" ) ) service2.register_ip_instance("IpInstance", ipv4="54.239.25.192" ) app.synth()
Attributes
- custom_attributes
Custom attributes of the instance.
- Default:
none
- instance_id
The id of the instance resource.
- Default:
Automatically generated name
- ipv4
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
- ipv6
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
- port
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