interface DomainEntryProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Lightsail.CfnDomain.DomainEntryProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awslightsail#CfnDomain_DomainEntryProperty |
![]() | software.amazon.awscdk.services.lightsail.CfnDomain.DomainEntryProperty |
![]() | aws_cdk.aws_lightsail.CfnDomain.DomainEntryProperty |
![]() | aws-cdk-lib » aws_lightsail » CfnDomain » DomainEntryProperty |
Describes a domain recordset entry.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lightsail as lightsail } from 'aws-cdk-lib';
const domainEntryProperty: lightsail.CfnDomain.DomainEntryProperty = {
name: 'name',
target: 'target',
type: 'type',
// the properties below are optional
id: 'id',
isAlias: false,
};
Properties
Name | Type | Description |
---|---|---|
name | string | The name of the domain. |
target | string | The target IP address ( 192.0.2.0 ), or AWS name server ( ns-111.awsdns-22.com. ). |
type | string | The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). |
id? | string | The ID of the domain recordset entry. |
is | boolean | IResolvable | When true , specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another AWS resource. |
name
Type:
string
The name of the domain.
target
Type:
string
The target IP address ( 192.0.2.0
), or AWS name server ( ns-111.awsdns-22.com.
).
For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com
. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net
. For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com
. Be sure to also set isAlias
to true
when setting up an A record for a Lightsail load balancer, distribution, or container service.
type
Type:
string
The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The following domain entry types can be used:
A
AAAA
CNAME
MX
NS
SOA
SRV
TXT
id?
Type:
string
(optional)
The ID of the domain recordset entry.
isAlias?
Type:
boolean |
IResolvable
(optional)
When true
, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another AWS resource.
You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other AWS resource and routes traffic to that resource.