Amplify / Client / update_domain_association

update_domain_association#

Amplify.Client.update_domain_association(**kwargs)#

Creates a new domain association for an Amplify app.

Request Syntax

response = client.update_domain_association(
    appId='string',
    domainName='string',
    enableAutoSubDomain=True|False,
    subDomainSettings=[
        {
            'prefix': 'string',
            'branchName': 'string'
        },
    ],
    autoSubDomainCreationPatterns=[
        'string',
    ],
    autoSubDomainIAMRole='string',
    certificateSettings={
        'type': 'AMPLIFY_MANAGED'|'CUSTOM',
        'customCertificateArn': 'string'
    }
)

Parameters:

appId (string) –
[REQUIRED]

The unique ID for an Amplify app.
domainName (string) –
[REQUIRED]

The name of the domain.
enableAutoSubDomain (boolean) – Enables the automated creation of subdomains for branches.
subDomainSettings (list) –
Describes the settings for the subdomain.
- (dict) –
  
  Describes the settings for the subdomain.
  - prefix (string) – [REQUIRED]
    
    The prefix setting for the subdomain.
  - branchName (string) – [REQUIRED]
    
    The branch name setting for the subdomain.
autoSubDomainCreationPatterns (list) –
Sets the 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.
certificateSettings (dict) –
The type of SSL/TLS certificate to use for your custom domain.
- type (string) – [REQUIRED]
  
  The certificate type.
  
  Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.
  
  Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide.
- customCertificateArn (string) –
  
  The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.
  
  This field is required only when the certificate type is CUSTOM.

Return type:

dict

Returns:

Response Syntax

{
    'domainAssociation': {
        'domainAssociationArn': 'string',
        'domainName': 'string',
        'enableAutoSubDomain': True|False,
        'autoSubDomainCreationPatterns': [
            'string',
        ],
        'autoSubDomainIAMRole': 'string',
        'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'IMPORTING_CUSTOM_CERTIFICATE'|'PENDING_DEPLOYMENT'|'AWAITING_APP_CNAME'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
        'updateStatus': 'REQUESTING_CERTIFICATE'|'PENDING_VERIFICATION'|'IMPORTING_CUSTOM_CERTIFICATE'|'PENDING_DEPLOYMENT'|'AWAITING_APP_CNAME'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
        'statusReason': 'string',
        'certificateVerificationDNSRecord': 'string',
        'subDomains': [
            {
                'subDomainSetting': {
                    'prefix': 'string',
                    'branchName': 'string'
                },
                'verified': True|False,
                'dnsRecord': 'string'
            },
        ],
        'certificate': {
            'type': 'AMPLIFY_MANAGED'|'CUSTOM',
            'customCertificateArn': 'string',
            'certificateVerificationDNSRecord': 'string'
        }
    }
}

Response Structure

(dict) –

The result structure for the update domain association request.
- domainAssociation (dict) –
  
  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.
  - updateStatus (string) –
    
    The status of the domain update operation that is currently in progress. The following list describes the valid update states.
    
    REQUESTING_CERTIFICATE
    
    The certificate is in the process of being updated.
    
    PENDING_VERIFICATION
    
    Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
    
    IMPORTING_CUSTOM_CERTIFICATE
    
    Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
    
    PENDING_DEPLOYMENT
    
    Indicates that the subdomain or certificate changes are being propagated.
    
    AWAITING_APP_CNAME
    
    Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.
    
    UPDATE_COMPLETE
    
    The certificate has been associated with a domain.
    
    UPDATE_FAILED
    
    The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
  - statusReason (string) –
    
    Additional information that describes why the domain association is in the current state.
  - certificateVerificationDNSRecord (string) –
    
    The DNS record for certificate verification.
  - subDomains (list) –
    
    The subdomains for the domain association.
    - (dict) –
      
      The subdomain for the domain association.
      - subDomainSetting (dict) –
        
        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.
  - certificate (dict) –
    
    Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.
    
    If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.
    - type (string) –
      
      The type of SSL/TLS certificate that you want to use.
      
      Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.
      
      Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide .
    - customCertificateArn (string) –
      
      The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.
      
      This field is required only when the certificate type is CUSTOM.
    - certificateVerificationDNSRecord (string) –
      
      The DNS record for certificate verification.

Exceptions

Amplify.Client.exceptions.BadRequestException
Amplify.Client.exceptions.UnauthorizedException
Amplify.Client.exceptions.NotFoundException
Amplify.Client.exceptions.InternalFailureException
Amplify.Client.exceptions.DependentServiceFailureException