PublicDnsNamespace¶
-
class
aws_cdk.aws_servicediscovery.
PublicDnsNamespace
(scope, id, *, name, description=None)¶ Bases:
aws_cdk.core.Resource
Define a Public DNS Namespace.
- ExampleMetadata
lit=test/integ.service-with-public-dns-namespace.lit.ts infused
Example:
import aws_cdk.core as cdk import aws_cdk.aws_servicediscovery as servicediscovery app = cdk.App() stack = cdk.Stack(app, "aws-servicediscovery-integ") namespace = servicediscovery.PublicDnsNamespace(stack, "Namespace", name="foobar.com" ) service = namespace.create_service("Service", name="foo", dns_record_type=servicediscovery.DnsRecordType.A, dns_ttl=cdk.Duration.seconds(30), health_check=servicediscovery.HealthCheckConfig( type=servicediscovery.HealthCheckType.HTTPS, resource_path="/healthcheck", failure_threshold=2 ) ) service.register_ip_instance("IpInstance", ipv4="54.239.25.192", port=443 ) 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, *, dns_record_type=None, dns_ttl=None, load_balancer=None, routing_policy=None, custom_health_check=None, description=None, health_check=None, name=None)¶ Creates a service within the namespace.
- Parameters
id (
str
) –dns_record_type (
Optional
[DnsRecordType
]) – The DNS type of the record that you want AWS Cloud Map to create. Supported record types include A, AAAA, A and AAAA (A_AAAA), CNAME, and SRV. Default: Adns_ttl (
Optional
[Duration
]) – The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record. Default: Duration.minutes(1)load_balancer (
Optional
[bool
]) – Whether or not this service will have an Elastic LoadBalancer registered to it as an AliasTargetInstance. Setting this totrue
correctly configures theroutingPolicy
and performs some additional validation. Default: falserouting_policy (
Optional
[RoutingPolicy
]) – The routing policy that you want to apply to all DNS records that AWS Cloud Map creates when you register an instance and specify this service. Default: WEIGHTED for CNAME records and when loadBalancer is true, MULTIVALUE otherwisecustom_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: nonedescription (
Optional
[str
]) – A description of the service. Default: nonehealth_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: nonename (
Optional
[str
]) – A name for the Service. Default: CloudFormation-generated name
- Return type
-
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
-
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
-
public_dns_namespace_arn
¶ true
- Type
attribute
- Return type
str
-
public_dns_namespace_id
¶ true
- Type
attribute
- Return type
str
-
public_dns_namespace_name
¶ true
- Type
attribute
- Return type
str
-
type
¶ Type of the namespace.
- Return type
Static Methods
-
classmethod
from_public_dns_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
-
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