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).
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ClusterIdentifier
-
The cluster identifier that the custom domain is associated with.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
- CustomDomainCertificateArn
-
The certificate Amazon Resource Name (ARN) for the custom domain name association.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*Required: Yes
- CustomDomainName
-
The custom domain name for a custom domain association.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 253.
Pattern:
^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$Required: Yes
Response Elements
The following elements are returned by the service.
- ClusterIdentifier
-
The identifier of the cluster that the custom domain is associated with.
Type: String
Length Constraints: Maximum length of 2147483647.
- CustomDomainCertExpiryTime
-
The expiration time for the certificate for the custom domain.
Type: String
Length Constraints: Maximum length of 2147483647.
- CustomDomainCertificateArn
-
The Amazon Resource Name (ARN) for the certificate associated with the custom domain name.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)* - CustomDomainName
-
The custom domain name for the association result.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 253.
Pattern:
^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClusterNotFound
-
The
ClusterIdentifierparameter does not refer to an existing cluster.HTTP Status Code: 404
- CustomCnameAssociationFault
-
An error occurred when an attempt was made to change the custom domain association.
HTTP Status Code: 400
- UnsupportedOperation
-
The requested operation isn't supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
