create-domain-entry¶

Description¶

Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name . For more information, see the Lightsail Dev Guide .

Synopsis¶

  create-domain-entry
--domain-name <value>
--domain-entry <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--domain-name (string)

The domain name (e.g., example.com ) for which you want to create the domain entry.

--domain-entry (structure)

An array of key-value pairs containing information about the domain entry request.

id -> (string)

The ID of the domain recordset entry.

name -> (string)

The name of the domain.

target -> (string)

The target AWS name server (e.g., ns-111.awsdns-22.com. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.

isAlias -> (boolean)

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer

type -> (string)

The type of domain entry, such as address (A), 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

CNAME

MX

NS

SOA

SRV

TXT

options -> (map)

(Deprecated) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

key -> (string)

value -> (string)

Shorthand Syntax:

id=string,name=string,target=string,isAlias=boolean,type=string,options={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "id": "string",
  "name": "string",
  "target": "string",
  "isAlias": true|false,
  "type": "string",
  "options": {"string": "string"
    ...}
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To create a domain entry (DNS record)

The following create-domain-entry example creates a DNS record (A) for the apex of the specified domain that points to an instance’s IP address.

Note: Lightsail’s domain-related API operations are available in only the us-east-1 Region. If your CLI profile is configured to use a different Region, you must include the --region us-east-1 parameter or the command fails.

aws lightsail create-domain-entry \
    --region us-east-1 \
    --domain-name example.com \
    --domain-entry name=example.com,type=A,target=192.0.2.0

Output:

{
    "operation": {
        "id": "5be4494d-56f4-41fc-8730-693dcd0ef9e2",
        "resourceName": "example.com",
        "resourceType": "Domain",
        "createdAt": 1569865296.519,
        "location": {
            "availabilityZone": "all",
            "regionName": "global"
        },
        "isTerminal": true,
        "operationType": "CreateDomainEntry",
        "status": "Succeeded",
        "statusChangedAt": 1569865296.519
    }
}

For more information, see DNS in Amazon Lightsail and Creating a DNS zone to manage your domain’s DNS records in Amazon Lightsail in the Lightsail Developer Guide.

Output¶

operation -> (structure)

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

id -> (string)

The ID of the operation.

resourceName -> (string)

The resource name.

resourceType -> (string)

The resource type.

createdAt -> (timestamp)

The timestamp when the operation was initialized (e.g., 1479816991.349 ).

location -> (structure)

The AWS Region and Availability Zone.

availabilityZone -> (string)

The Availability Zone. Follows the format us-east-2a (case-sensitive).

regionName -> (string)

The AWS Region name.

isTerminal -> (boolean)

A Boolean value indicating whether the operation is terminal.

operationDetails -> (string)

Details about the operation (e.g., Debian-1GB-Ohio-1 ).

operationType -> (string)

The type of operation.

status -> (string)

The status of the operation.

statusChangedAt -> (timestamp)

The timestamp when the status was changed (e.g., 1479816991.349 ).

errorCode -> (string)

The error code.

errorDetails -> (string)

The error details.

Table of Contents

Feedback

User Guide