check-dns-availability¶

Description¶

Checks if the specified CNAME is available.

Synopsis¶

  check-dns-availability
--cname-prefix <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--cname-prefix (string)

The prefix used when this CNAME is reserved.

--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 check the availability of a CNAME

The following command checks the availability of the subdomain my-cname.elasticbeanstalk.com:

aws elasticbeanstalk check-dns-availability --cname-prefix my-cname

Output:

{
    "Available": true,
    "FullyQualifiedCNAME": "my-cname.elasticbeanstalk.com"
}

Output¶

Available -> (boolean)

Indicates if the specified CNAME is available:

true : The CNAME is available.

false : The CNAME is not available.

FullyQualifiedCNAME -> (string)

The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.

Table of Contents

Feedback

User Guide