HttpNamespace L2 construct
Define an HTTP Namespace.
Example
ts
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();
python
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()
java
import software.amazon.awscdk.*;
import software.amazon.awscdk.*;
App app = new App();
Stack stack = new Stack(app, "aws-servicediscovery-integ");
HttpNamespace namespace = HttpNamespace.Builder.create(stack, "MyNamespace")
.name("MyHTTPNamespace")
.build();
Service service1 = namespace.createService("NonIpService", BaseServiceProps.builder()
.description("service registering non-ip instances")
.build());
service1.registerNonIpInstance("NonIpInstance", NonIpInstanceBaseProps.builder()
.customAttributes(Map.of("arn", "arn:aws:s3:::amzn-s3-demo-bucket"))
.build());
Service service2 = namespace.createService("IpService", BaseServiceProps.builder()
.description("service registering ip instances")
.healthCheck(HealthCheckConfig.builder()
.type(HealthCheckType.HTTP)
.resourcePath("/check")
.build())
.build());
service2.registerIpInstance("IpInstance", IpInstanceBaseProps.builder()
.ipv4("54.239.25.192")
.build());
app.synth();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK;
using Amazon.CDK;
var app = new App();
var stack = new Stack(app, "aws-servicediscovery-integ");
var namespace = new HttpNamespace(stack, "MyNamespace", new HttpNamespaceProps {
Name = "MyHTTPNamespace"
});
var service1 = namespace.CreateService("NonIpService", new BaseServiceProps {
Description = "service registering non-ip instances"
});
service1.RegisterNonIpInstance("NonIpInstance", new NonIpInstanceBaseProps {
CustomAttributes = new Dictionary<string, string> { { "arn", "arn:aws:s3:::amzn-s3-demo-bucket" } }
});
var service2 = namespace.CreateService("IpService", new BaseServiceProps {
Description = "service registering ip instances",
HealthCheck = new HealthCheckConfig {
Type = HealthCheckType.HTTP,
ResourcePath = "/check"
}
});
service2.RegisterIpInstance("IpInstance", new IpInstanceBaseProps {
Ipv4 = "54.239.25.192"
});
app.Synth();
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
app := cdk.NewApp()
stack := cdk.NewStack(app, jsii.String("aws-servicediscovery-integ"))
namespace := servicediscovery.NewHttpNamespace(stack, jsii.String("MyNamespace"), &HttpNamespaceProps{
Name: jsii.String("MyHTTPNamespace"),
})
service1 := namespace.CreateService(jsii.String("NonIpService"), &BaseServiceProps{
Description: jsii.String("service registering non-ip instances"),
})
service1.RegisterNonIpInstance(jsii.String("NonIpInstance"), &NonIpInstanceBaseProps{
CustomAttributes: map[string]*string{
"arn": jsii.String("arn:aws:s3:::amzn-s3-demo-bucket"),
},
})
service2 := namespace.CreateService(jsii.String("IpService"), &BaseServiceProps{
Description: jsii.String("service registering ip instances"),
HealthCheck: &HealthCheckConfig{
Type: servicediscovery.HealthCheckType_HTTP,
ResourcePath: jsii.String("/check"),
},
})
service2.RegisterIpInstance(jsii.String("IpInstance"), &IpInstanceBaseProps{
Ipv4: jsii.String("54.239.25.192"),
})
app.Synth()
Initializer
ts
new HttpNamespace(scope: Construct, id: string, props: HttpNamespaceProps)
python
HttpNamespace(scope: Construct, id: str, props: HttpNamespaceProps)
java
new HttpNamespace(Construct scope, String id, HttpNamespaceProps props)
csharp
new HttpNamespace(Construct scope, string id, HttpNamespaceProps props)
go
NewHttpNamespace(Scope Construct, Id *string, Props HttpNamespaceProps)
Construct Props
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
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.
httpNamespaceArnstringhttp_namespace_arnstrhttpNamespaceArnStringHttpNamespaceArnstringHttpNamespaceArn*stringrequired#httpNamespaceIdstringhttp_namespace_idstrhttpNamespaceIdStringHttpNamespaceIdstringHttpNamespaceId*stringrequired#httpNamespaceNamestringhttp_namespace_namestrhttpNamespaceNameStringHttpNamespaceNamestringHttpNamespaceName*stringrequired#httpNamespaceRefHttpNamespaceReferencehttp_namespace_refHttpNamespaceReferencehttpNamespaceRefHttpNamespaceReferenceHttpNamespaceRefHttpNamespaceReferenceHttpNamespaceRefHttpNamespaceReferencerequired#A reference to a HttpNamespace resource.
Namespace Arn for the namespace.
Namespace Id for the namespace.
namespaceNamestringnamespace_namestrnamespaceNameStringNamespaceNamestringNamespaceName*stringrequired#A name for the namespace.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
The stack in which this resource is defined.
Type of the namespace.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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: string, props?: BaseServiceProps): Servicedef create_service(self, id: str, props: typing.Optional[BaseServiceProps] = None) -> Servicepublic Service createService(String id, BaseServiceProps props)public Service CreateService(string id, BaseServiceProps? props = null)func CreateService(Id *string, Props BaseServiceProps) Service#Creates a service within the namespace.
fromHttpNamespaceAttributes(scope: Construct, id: string, attrs: HttpNamespaceAttributes): IHttpNamespace@staticmethod def from_http_namespace_attributes(scope: Construct, id: str, attrs: HttpNamespaceAttributes) -> IHttpNamespacepublic static IHttpNamespace fromHttpNamespaceAttributes(Construct scope, String id, HttpNamespaceAttributes attrs)public static IHttpNamespace FromHttpNamespaceAttributes(Construct scope, string id, HttpNamespaceAttributes attrs)func FromHttpNamespaceAttributes(Scope Construct, Id *string, Attrs HttpNamespaceAttributes) IHttpNamespacestatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
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
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.