Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . amplify ]

delete-domain-association

Description

Deletes a domain association for an Amplify app.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-domain-association
--app-id <value>
--domain-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The unique id for an Amplify app.

--domain-name (string)

The name of the domain.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

domainAssociation -> (structure)

Describes a domain association that associates a custom domain with an Amplify app.

domainAssociationArn -> (string)

The Amazon Resource Name (ARN) for the domain association.

domainName -> (string)

The name of the domain.

enableAutoSubDomain -> (boolean)

Enables the automated creation of subdomains for branches.

autoSubDomainCreationPatterns -> (list)

Sets branch patterns for automatic subdomain creation.

(string)

autoSubDomainIAMRole -> (string)

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

domainStatus -> (string)

The current status of the domain association.

statusReason -> (string)

The reason for the current status of the domain association.

certificateVerificationDNSRecord -> (string)

The DNS record for certificate verification.

subDomains -> (list)

The subdomains for the domain association.

(structure)

The subdomain for the domain association.

subDomainSetting -> (structure)

Describes the settings for the subdomain.

prefix -> (string)

The prefix setting for the subdomain.

branchName -> (string)

The branch name setting for the subdomain.

verified -> (boolean)

The verified status of the subdomain

dnsRecord -> (string)

The DNS record for the subdomain.