update-domain-association¶
Description¶
Creates a new domain association for an Amplify app.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-domain-association
--app-id <value>
--domain-name <value>
[--enable-auto-sub-domain | --no-enable-auto-sub-domain]
[--sub-domain-settings <value>]
[--auto-sub-domain-creation-patterns <value>]
[--auto-sub-domain-iam-role <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--app-id (string)
The unique ID for an Amplify app.
--domain-name (string)
The name of the domain.
--enable-auto-sub-domain | --no-enable-auto-sub-domain (boolean)
Enables the automated creation of subdomains for branches.
--sub-domain-settings (list)
Describes the settings for the subdomain.
(structure)
Describes the settings for the subdomain.
prefix -> (string)
The prefix setting for the subdomain.
branchName -> (string)
The branch name setting for the subdomain.
Shorthand Syntax:
prefix=string,branchName=string ...
JSON Syntax:
[
{
"prefix": "string",
"branchName": "string"
}
...
]
--auto-sub-domain-creation-patterns (list)
Sets the branch patterns for automatic subdomain creation.
(string)
Syntax:
"string" "string" ...
--auto-sub-domain-iam-role (string)
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
--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.
Output¶
domainAssociation -> (structure)
Describes a domain association, which 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.