Redshift / Client / create_custom_domain_association

create_custom_domain_association#

Redshift.Client.create_custom_domain_association(**kwargs)#

Used to create a custom domain name for a cluster. Properties include the custom domain name, the cluster the custom domain is associated with, and the certificate Amazon Resource Name (ARN).

See also: AWS API Documentation

Request Syntax

response = client.create_custom_domain_association(
    CustomDomainName='string',
    CustomDomainCertificateArn='string',
    ClusterIdentifier='string'
)
Parameters:

  • CustomDomainName (string) –

    [REQUIRED]

    The custom domain name for a custom domain association.

  • CustomDomainCertificateArn (string) –

    [REQUIRED]

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

  • ClusterIdentifier (string) –

    [REQUIRED]

    The cluster identifier that the custom domain is associated with.

Return type:

dict

Returns:

Response Syntax

{
    'CustomDomainName': 'string',
    'CustomDomainCertificateArn': 'string',
    'ClusterIdentifier': 'string',
    'CustomDomainCertExpiryTime': 'string'
}

Response Structure

  • (dict) –

    • CustomDomainName (string) –

      The custom domain name for the association result.

    • CustomDomainCertificateArn (string) –

      The Amazon Resource Name (ARN) for the certificate associated with the custom domain name.

    • ClusterIdentifier (string) –

      The identifier of the cluster that the custom domain is associated with.

    • CustomDomainCertExpiryTime (string) –

      The expiration time for the certificate for the custom domain.

Exceptions

  • Redshift.Client.exceptions.UnsupportedOperationFault

  • Redshift.Client.exceptions.ClusterNotFoundFault

  • Redshift.Client.exceptions.CustomCnameAssociationFault