class HttpNamespace (construct)

Language	Type name
.NET	Amazon.CDK.AWS.ServiceDiscovery.HttpNamespace
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsservicediscovery#HttpNamespace
Java	software.amazon.awscdk.services.servicediscovery.HttpNamespace
Python	aws_cdk.aws_servicediscovery.HttpNamespace
TypeScript (source)	aws-cdk-lib » aws_servicediscovery » HttpNamespace

Implements IConstruct, IDependable, IResource, IHttpNamespace, INamespace

Define an HTTP Namespace.

Example

import * as cdk from '../../core';
import * as servicediscovery from '../lib';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'aws-servicediscovery-integ');

const namespace = new servicediscovery.HttpNamespace(stack, 'MyNamespace', {
  name: 'MyHTTPNamespace',
});

const service1 = namespace.createService('NonIpService', {
  description: 'service registering non-ip instances',
});

service1.registerNonIpInstance('NonIpInstance', {
  customAttributes: { arn: 'arn:aws:s3:::amzn-s3-demo-bucket' },
});

const service2 = namespace.createService('IpService', {
  description: 'service registering ip instances',
  healthCheck: {
    type: servicediscovery.HealthCheckType.HTTP,
    resourcePath: '/check',
  },
});

service2.registerIpInstance('IpInstance', {
  ipv4: '54.239.25.192',
});

app.synth();

Initializer

new HttpNamespace(scope: Construct, id: string, props: HttpNamespaceProps)

Parameters

• scope Construct
• id string
• props HttpNamespaceProps

Construct Props

Name	Type	Description
name	string	A name for the Namespace.
description?	string	A description of the Namespace.

---

name

Type: string

A name for the Namespace.

---

description?

Type: string (optional, default: none)

A description of the Namespace.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
httpNamespaceArn	string
httpNamespaceId	string
httpNamespaceName	string
namespaceArn	string	Namespace Arn for the namespace.
namespaceId	string	Namespace Id for the namespace.
namespaceName	string	A name for the namespace.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
type	NamespaceType	Type of the namespace.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

httpNamespaceArn

Type: string

---

httpNamespaceId

Type: string

---

httpNamespaceName

Type: string

---

namespaceArn

Type: string

Namespace Arn for the namespace.

---

namespaceId

Type: string

Namespace Id for the namespace.

---

namespaceName

Type: string

A name for the namespace.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

type

Type: NamespaceType

Type of the namespace.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
createService(id, props?)	Creates a service within the namespace.
toString()	Returns a string representation of this construct.
static fromHttpNamespaceAttributes(scope, id, attrs)

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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

---

createService(id, props?)

public createService(id: string, props?: BaseServiceProps): Service

Parameters

• id string
• props BaseServiceProps

Returns

• Service

Creates a service within the namespace.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromHttpNamespaceAttributes(scope, id, attrs)

public static fromHttpNamespaceAttributes(scope: Construct, id: string, attrs: HttpNamespaceAttributes): IHttpNamespace

Parameters

• scope Construct
• id string
• attrs HttpNamespaceAttributes

Returns

• IHttpNamespace