AttachCertificateToDistribution
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.
Use the CreateCertificate action to create a certificate that you can attach
to your distribution.
Important
Only certificates created in the us-east-1
AWS Region can be attached to Lightsail distributions. Lightsail
distributions are global resources that can reference an origin in any AWS
Region, and distribute its content globally. However, all distributions are located in the
us-east-1 Region.
Request Syntax
{
"certificateName": "string",
"distributionName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- certificateName
-
The name of the certificate to attach to a distribution.
Only certificates with a status of
ISSUEDcan be attached to a distribution.Use the
GetCertificatesaction to get a list of certificate names that you can specify.Note
This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be
WordPress-Blog-Certificateand the domain name of the certificate might beexample.com.Type: String
Pattern:
\w[\w\-]*\wRequired: Yes
- distributionName
-
The name of the distribution that the certificate will be attached to.
Use the
GetDistributionsaction to get a list of distribution names that you can specify.Type: String
Pattern:
\w[\w\-]*\wRequired: Yes
Response Syntax
{
"operation": {
"createdAt": number,
"errorCode": "string",
"errorDetails": "string",
"id": "string",
"isTerminal": boolean,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"operationDetails": "string",
"operationType": "string",
"resourceName": "string",
"resourceType": "string",
"status": "string",
"statusChangedAt": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
HTTP Status Code: 400
- InvalidInputException
-
Lightsail throws this exception when user input does not conform to the validation rules of an input field.
Note
Domain and distribution APIs are only available in the N. Virginia (
us-east-1) AWS Region. Please set your AWS Region configuration tous-east-1to create, view, or edit these resources.HTTP Status Code: 400
- NotFoundException
-
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
- OperationFailureException
-
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
- ServiceException
-
A general service exception.
HTTP Status Code: 500
- UnauthenticatedException
-
Lightsail throws this exception when the user has not been authenticated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
