RedshiftServerless / Client / create_custom_domain_association

create_custom_domain_association#

RedshiftServerless.Client.create_custom_domain_association(**kwargs)#

Creates a custom domain association for Amazon Redshift Serverless.

See also: AWS API Documentation

Request Syntax

response = client.create_custom_domain_association(
    customDomainCertificateArn='string',
    customDomainName='string',
    workgroupName='string'
)
Parameters:
  • customDomainCertificateArn (string) –

    [REQUIRED]

    The custom domain name’s certificate Amazon resource name (ARN).

  • customDomainName (string) –

    [REQUIRED]

    The custom domain name to associate with the workgroup.

  • workgroupName (string) –

    [REQUIRED]

    The name of the workgroup associated with the database.

Return type:

dict

Returns:

Response Syntax

{
    'customDomainCertificateArn': 'string',
    'customDomainCertificateExpiryTime': datetime(2015, 1, 1),
    'customDomainName': 'string',
    'workgroupName': 'string'
}

Response Structure

  • (dict) –

    • customDomainCertificateArn (string) –

      The custom domain name’s certificate Amazon resource name (ARN).

    • customDomainCertificateExpiryTime (datetime) –

      The expiration time for the certificate.

    • customDomainName (string) –

      The custom domain name to associate with the workgroup.

    • workgroupName (string) –

      The name of the workgroup associated with the database.

Exceptions

  • RedshiftServerless.Client.exceptions.InternalServerException

  • RedshiftServerless.Client.exceptions.ResourceNotFoundException

  • RedshiftServerless.Client.exceptions.ConflictException

  • RedshiftServerless.Client.exceptions.ValidationException

  • RedshiftServerless.Client.exceptions.AccessDeniedException

  • RedshiftServerless.Client.exceptions.ThrottlingException