[ aws . apprunner ]

disassociate-custom-domain

Description

Disassociate a custom domain name from an App Runner service.

Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM) . These certificates aren’t deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  disassociate-custom-domain
--service-arn <value>
--domain-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--service-arn (string)

The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.

--domain-name (string)

The domain name that you want to disassociate from the App Runner service.

--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.

See ‘aws help’ for descriptions of global parameters.

Examples

To disassociate a domain name from a service

The following disassociate-custom-domain example disassociates the domain example.com from an App Runner service. The call also disassociates the subdomain www.example.com that was associated together with the root domain.

aws apprunner disassociate-custom-domain \
    --cli-input-json file://input.json

Contents of input.json:

{
    "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa",
    "DomainName": "example.com"
}

Output:

{
    "CustomDomain": {
        "CertificateValidationRecords": [
            {
                "Name": "_70d3f50a94f7c72dc28784cf55db2f6b.example.com",
                "Status": "PENDING_VALIDATION",
                "Type": "CNAME",
                "Value": "_1270c137383c6307b6832db02504c4b0.bsgbmzkfwj.acm-validations.aws."
            },
            {
                "Name": "_287870d3f50a94f7c72dc4cf55db2f6b.www.example.com",
                "Status": "PENDING_VALIDATION",
                "Type": "CNAME",
                "Value": "_832db01270c137383c6307b62504c4b0.mzkbsgbfwj.acm-validations.aws."
            }
        ],
        "DomainName": "example.com",
        "EnableWWWSubdomain": true,
        "Status": "DELETING"
    },
    "DNSTarget": "psbqam834h.us-east-1.awsapprunner.com",
    "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa"
}

Output

DNSTarget -> (string)

The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.

ServiceArn -> (string)

The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.

CustomDomain -> (structure)

A description of the domain name that’s being disassociated.

DomainName -> (string)

An associated custom domain endpoint. It can be a root domain (for example, example.com ), a subdomain (for example, login.example.com or admin.login.example.com ), or a wildcard (for example, *.example.com ).

EnableWWWSubdomain -> (boolean)

When true , the subdomain ``www.*DomainName* `` is associated with the App Runner service in addition to the base domain.

CertificateValidationRecords -> (list)

A list of certificate CNAME records that’s used for this domain name.

(structure)

Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain .

Name -> (string)

The certificate CNAME record name.

Type -> (string)

The record type, always CNAME .

Value -> (string)

The certificate CNAME record value.

Status -> (string)

The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.

Status -> (string)

The current state of the domain name association.