HttpNamespace

class aws_cdk.aws_servicediscovery.HttpNamespace(scope, id, *, name, description=None)

Bases: Resource

Define an HTTP Namespace.

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:::amzn-s3-demo-bucket"}
)

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()

Parameters:

scope (Construct)
id (str)
name (str) – A name for the Namespace.
description (Optional[str]) – A description of the Namespace. Default: none

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

create_service(id, *, custom_health_check=None, description=None, health_check=None, name=None)

Creates a service within the namespace.

Parameters:

id (str)
custom_health_check (Union[HealthCheckCustomConfig, Dict[str, Any], None]) – Structure containing failure threshold for a custom health checker. Only one of healthCheckConfig or healthCheckCustomConfig can be specified. See: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html Default: none
description (Optional[str]) – A description of the service. Default: none
health_check (Union[HealthCheckConfig, Dict[str, Any], None]) – Settings for an optional health check. If you specify health check settings, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. Only one of healthCheckConfig or healthCheckCustomConfig can be specified. Not valid for PrivateDnsNamespaces. If you use healthCheck, you can only register IP instances to this service. Default: none
name (Optional[str]) – A name for the Service. Default: CloudFormation-generated name

Return type:

Service

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-servicediscovery.HttpNamespace'

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

http_namespace_arn

true

Type:: attribute

http_namespace_id

true

Type:: attribute

http_namespace_name

true

Type:: attribute

namespace_arn: Namespace Arn for the namespace.

namespace_id: Namespace Id for the namespace.

namespace_name: A name for the namespace.

node: The tree node.

stack: The stack in which this resource is defined.

type: Type of the namespace.

Static Methods

classmethod from_http_namespace_attributes(scope, id, *, namespace_arn, namespace_id, namespace_name)

Parameters:

scope (Construct)
id (str)
namespace_arn (str) – Namespace ARN for the Namespace.
namespace_id (str) – Namespace Id for the Namespace.
namespace_name (str) – A name for the Namespace.

Return type:

IHttpNamespace

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool