software.amazon.awscdk.services.servicediscovery

Class PublicDnsNamespace

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.servicediscovery.PublicDnsNamespace

All Implemented Interfaces:

IResource, INamespace, IPublicDnsNamespace, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.158Z")
 @Stability(value=Stable)
public class PublicDnsNamespace
extends Resource
implements IPublicDnsNamespace

Define a Public DNS Namespace.

Example:

 import software.amazon.awscdk.*;
 import software.amazon.awscdk.*;
 App app = new App();
 Stack stack = new Stack(app, "aws-servicediscovery-integ");
 PublicDnsNamespace namespace = PublicDnsNamespace.Builder.create(stack, "Namespace")
         .name("foobar.com")
         .build();
 Service service = namespace.createService("Service", DnsServiceProps.builder()
         .name("foo")
         .dnsRecordType(DnsRecordType.A)
         .dnsTtl(Duration.seconds(30))
         .healthCheck(HealthCheckConfig.builder()
                 .type(HealthCheckType.HTTPS)
                 .resourcePath("/healthcheck")
                 .failureThreshold(2)
                 .build())
         .build());
 service.registerIpInstance("IpInstance", IpInstanceBaseProps.builder()
         .ipv4("54.239.25.192")
         .port(443)
         .build());
 app.synth();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublicDnsNamespace.Builder A fluent builder for PublicDnsNamespace.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.servicediscovery.IPublicDnsNamespace

IPublicDnsNamespace.Jsii$Default, IPublicDnsNamespace.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	PublicDnsNamespace(software.constructs.Construct scope, String id, PublicDnsNamespaceProps props)
protected	PublicDnsNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PublicDnsNamespace(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Service	createService(String id) Creates a service within the namespace.
Service	createService(String id, DnsServiceProps props) Creates a service within the namespace.
static IPublicDnsNamespace	fromPublicDnsNamespaceAttributes(software.constructs.Construct scope, String id, PublicDnsNamespaceAttributes attrs)
String	getNamespaceArn() Namespace Arn for the namespace.
String	getNamespaceHostedZoneId() ID of hosted zone created by namespace.
String	getNamespaceId() Namespace Id for the namespace.
String	getNamespaceName() A name for the namespace.
String	getPublicDnsNamespaceArn()
String	getPublicDnsNamespaceId()
String	getPublicDnsNamespaceName()
NamespaceType	getType() Type of the namespace.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

PublicDnsNamespace

protected PublicDnsNamespace(software.amazon.jsii.JsiiObjectRef objRef)

PublicDnsNamespace

protected PublicDnsNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

PublicDnsNamespace

@Stability(value=Stable)
public PublicDnsNamespace(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   PublicDnsNamespaceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromPublicDnsNamespaceAttributes

@Stability(value=Stable)
 @NotNull
public static IPublicDnsNamespace fromPublicDnsNamespaceAttributes(@NotNull
                                                                                                      software.constructs.Construct scope,
                                                                                                      @NotNull
                                                                                                      String id,
                                                                                                      @NotNull
                                                                                                      PublicDnsNamespaceAttributes attrs)

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

createService

@Stability(value=Stable)
 @NotNull
public Service createService(@NotNull
                                                                String id,
                                                                @Nullable
                                                                DnsServiceProps props)

Creates a service within the namespace.

Parameters:

id - This parameter is required.

props -

createService

@Stability(value=Stable)
 @NotNull
public Service createService(@NotNull
                                                                String id)

Creates a service within the namespace.

Parameters:

id - This parameter is required.

getNamespaceArn

@Stability(value=Stable)
 @NotNull
public String getNamespaceArn()

Namespace Arn for the namespace.

Specified by:

getNamespaceArn in interface INamespace

getNamespaceHostedZoneId

@Stability(value=Stable)
 @NotNull
public String getNamespaceHostedZoneId()

ID of hosted zone created by namespace.

getNamespaceId

@Stability(value=Stable)
 @NotNull
public String getNamespaceId()

Namespace Id for the namespace.

Specified by:

getNamespaceId in interface INamespace

getNamespaceName

@Stability(value=Stable)
 @NotNull
public String getNamespaceName()

A name for the namespace.

Specified by:

getNamespaceName in interface INamespace

getPublicDnsNamespaceArn

@Stability(value=Stable)
 @NotNull
public String getPublicDnsNamespaceArn()

getPublicDnsNamespaceId

@Stability(value=Stable)
 @NotNull
public String getPublicDnsNamespaceId()

getPublicDnsNamespaceName

@Stability(value=Stable)
 @NotNull
public String getPublicDnsNamespaceName()

getType

@Stability(value=Stable)
 @NotNull
public NamespaceType getType()

Type of the namespace.

Specified by:

getType in interface INamespace