HttpNamespace

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

Bases: aws_cdk.core.Resource

Define an HTTP Namespace.

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.DELETE), 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 (Optional[HealthCheckCustomConfig]) – 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 (Optional[HealthCheckConfig]) – 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

env

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.

Return type

ResourceEnvironment

http_namespace_arn

true

Type

attribute

Return type

str

http_namespace_id

true

Type

attribute

Return type

str

http_namespace_name

true

Type

attribute

Return type

str

namespace_arn

Namespace Arn for the namespace.

Return type

str

namespace_id

Namespace Id for the namespace.

Return type

str

namespace_name

A name for the namespace.

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

type

Type of the namespace.

Return type

NamespaceType

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)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool