CreateCustomDomainAssociationCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RedshiftClient, CreateCustomDomainAssociationCommand } from "@aws-sdk/client-redshift"; // ES Modules import
// const { RedshiftClient, CreateCustomDomainAssociationCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
const client = new RedshiftClient(config);
const input = { // CreateCustomDomainAssociationMessage
  CustomDomainName: "STRING_VALUE", // required
  CustomDomainCertificateArn: "STRING_VALUE", // required
  ClusterIdentifier: "STRING_VALUE", // required
};
const command = new CreateCustomDomainAssociationCommand(input);
const response = await client.send(command);
// { // CreateCustomDomainAssociationResult
//   CustomDomainName: "STRING_VALUE",
//   CustomDomainCertificateArn: "STRING_VALUE",
//   ClusterIdentifier: "STRING_VALUE",
//   CustomDomainCertExpiryTime: "STRING_VALUE",
// };

CreateCustomDomainAssociationCommand Input

See CreateCustomDomainAssociationCommandInput for more details

Parameter
Type
Description
ClusterIdentifier
Required
string | undefined

The cluster identifier that the custom domain is associated with.

CustomDomainCertificateArn
Required
string | undefined

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

CustomDomainName
Required
string | undefined

The custom domain name for a custom domain association.

CreateCustomDomainAssociationCommand Output

See CreateCustomDomainAssociationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ClusterIdentifier
string | undefined

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

CustomDomainCertExpiryTime
string | undefined

The expiration time for the certificate for the custom domain.

CustomDomainCertificateArn
string | undefined

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

CustomDomainName
string | undefined

The custom domain name for the association result.

Throws

Name
Fault
Details
ClusterNotFoundFault
client

The ClusterIdentifier parameter does not refer to an existing cluster.

CustomCnameAssociationFault
client

An error occurred when an attempt was made to change the custom domain association.

UnsupportedOperationFault
client

The requested operation isn't supported.

RedshiftServiceException
Base exception class for all service exceptions from Redshift service.