Skip to content

Commit 56cc546

Browse files
author
awstools
committed
feat(client-amplify): This release contains API changes that enable users to configure their Amplify domains with their own custom SSL/TLS certificate.
1 parent 4a62fda commit 56cc546

14 files changed

+487
-99
lines changed

clients/client-amplify/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
AWS SDK for JavaScript Amplify Client for Node.js, Browser and React Native.
88

99
<p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
10-
Amplify Hosting provides a continuous delivery and hosting service for web
11-
applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
10+
Amplify Hosting provides a continuous delivery and hosting service for web applications.
11+
For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
1212
Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
1313
for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
1414
</p>

clients/client-amplify/src/Amplify.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -667,8 +667,8 @@ export interface Amplify {
667667
/**
668668
* @public
669669
* <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
670-
* Amplify Hosting provides a continuous delivery and hosting service for web
671-
* applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
670+
* Amplify Hosting provides a continuous delivery and hosting service for web applications.
671+
* For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
672672
* Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
673673
* for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
674674
* </p>

clients/client-amplify/src/AmplifyClient.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -389,8 +389,8 @@ export interface AmplifyClientResolvedConfig extends AmplifyClientResolvedConfig
389389
/**
390390
* @public
391391
* <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
392-
* Amplify Hosting provides a continuous delivery and hosting service for web
393-
* applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
392+
* Amplify Hosting provides a continuous delivery and hosting service for web applications.
393+
* For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
394394
* Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
395395
* for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
396396
* </p>

clients/client-amplify/src/commands/CreateDeploymentCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResult, _
3131
* <p>Creates a deployment for a manually deployed Amplify app. Manually deployed apps are
3232
* not connected to a repository. </p>
3333
* <p>The maximum duration between the <code>CreateDeployment</code> call and the
34-
* <code>StartDeployment</code> call cannot exceed 8 hours. If the duration exceeds 8 hours, the
35-
* <code>StartDeployment</code> call and the associated <code>Job</code> will
34+
* <code>StartDeployment</code> call cannot exceed 8 hours. If the duration exceeds 8
35+
* hours, the <code>StartDeployment</code> call and the associated <code>Job</code> will
3636
* fail.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.

clients/client-amplify/src/commands/CreateDomainAssociationCommand.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateDomainAssociationCommandOutput extends CreateDomainAssoci
2828

2929
/**
3030
* @public
31-
* <p> Creates a new domain association for an Amplify app. This action associates a custom
31+
* <p>Creates a new domain association for an Amplify app. This action associates a custom
3232
* domain with the Amplify app </p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
@@ -50,6 +50,10 @@ export interface CreateDomainAssociationCommandOutput extends CreateDomainAssoci
5050
* "STRING_VALUE",
5151
* ],
5252
* autoSubDomainIAMRole: "STRING_VALUE",
53+
* certificateSettings: { // CertificateSettings
54+
* type: "AMPLIFY_MANAGED" || "CUSTOM", // required
55+
* customCertificateArn: "STRING_VALUE",
56+
* },
5357
* };
5458
* const command = new CreateDomainAssociationCommand(input);
5559
* const response = await client.send(command);
@@ -62,7 +66,8 @@ export interface CreateDomainAssociationCommandOutput extends CreateDomainAssoci
6266
* // "STRING_VALUE",
6367
* // ],
6468
* // autoSubDomainIAMRole: "STRING_VALUE",
65-
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
69+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
70+
* // updateStatus: "REQUESTING_CERTIFICATE" || "PENDING_VERIFICATION" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "UPDATE_COMPLETE" || "UPDATE_FAILED",
6671
* // statusReason: "STRING_VALUE", // required
6772
* // certificateVerificationDNSRecord: "STRING_VALUE",
6873
* // subDomains: [ // SubDomains // required
@@ -75,6 +80,11 @@ export interface CreateDomainAssociationCommandOutput extends CreateDomainAssoci
7580
* // dnsRecord: "STRING_VALUE", // required
7681
* // },
7782
* // ],
83+
* // certificate: { // Certificate
84+
* // type: "AMPLIFY_MANAGED" || "CUSTOM", // required
85+
* // customCertificateArn: "STRING_VALUE",
86+
* // certificateVerificationDNSRecord: "STRING_VALUE",
87+
* // },
7888
* // },
7989
* // };
8090
*

clients/client-amplify/src/commands/DeleteDomainAssociationCommand.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteDomainAssociationCommandOutput extends DeleteDomainAssoci
2828

2929
/**
3030
* @public
31-
* <p> Deletes a domain association for an Amplify app. </p>
31+
* <p>Deletes a domain association for an Amplify app. </p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript
@@ -50,7 +50,8 @@ export interface DeleteDomainAssociationCommandOutput extends DeleteDomainAssoci
5050
* // "STRING_VALUE",
5151
* // ],
5252
* // autoSubDomainIAMRole: "STRING_VALUE",
53-
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
53+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
54+
* // updateStatus: "REQUESTING_CERTIFICATE" || "PENDING_VERIFICATION" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "UPDATE_COMPLETE" || "UPDATE_FAILED",
5455
* // statusReason: "STRING_VALUE", // required
5556
* // certificateVerificationDNSRecord: "STRING_VALUE",
5657
* // subDomains: [ // SubDomains // required
@@ -63,6 +64,11 @@ export interface DeleteDomainAssociationCommandOutput extends DeleteDomainAssoci
6364
* // dnsRecord: "STRING_VALUE", // required
6465
* // },
6566
* // ],
67+
* // certificate: { // Certificate
68+
* // type: "AMPLIFY_MANAGED" || "CUSTOM", // required
69+
* // customCertificateArn: "STRING_VALUE",
70+
* // certificateVerificationDNSRecord: "STRING_VALUE",
71+
* // },
6672
* // },
6773
* // };
6874
*

clients/client-amplify/src/commands/GetDomainAssociationCommand.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface GetDomainAssociationCommandOutput extends GetDomainAssociationR
2828

2929
/**
3030
* @public
31-
* <p> Returns the domain information for an Amplify app. </p>
31+
* <p>Returns the domain information for an Amplify app. </p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript
@@ -50,7 +50,8 @@ export interface GetDomainAssociationCommandOutput extends GetDomainAssociationR
5050
* // "STRING_VALUE",
5151
* // ],
5252
* // autoSubDomainIAMRole: "STRING_VALUE",
53-
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
53+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
54+
* // updateStatus: "REQUESTING_CERTIFICATE" || "PENDING_VERIFICATION" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "UPDATE_COMPLETE" || "UPDATE_FAILED",
5455
* // statusReason: "STRING_VALUE", // required
5556
* // certificateVerificationDNSRecord: "STRING_VALUE",
5657
* // subDomains: [ // SubDomains // required
@@ -63,6 +64,11 @@ export interface GetDomainAssociationCommandOutput extends GetDomainAssociationR
6364
* // dnsRecord: "STRING_VALUE", // required
6465
* // },
6566
* // ],
67+
* // certificate: { // Certificate
68+
* // type: "AMPLIFY_MANAGED" || "CUSTOM", // required
69+
* // customCertificateArn: "STRING_VALUE",
70+
* // certificateVerificationDNSRecord: "STRING_VALUE",
71+
* // },
6672
* // },
6773
* // };
6874
*

clients/client-amplify/src/commands/ListDomainAssociationsCommand.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ListDomainAssociationsCommandOutput extends ListDomainAssociati
2828

2929
/**
3030
* @public
31-
* <p> Returns the domain associations for an Amplify app. </p>
31+
* <p>Returns the domain associations for an Amplify app. </p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript
@@ -52,7 +52,8 @@ export interface ListDomainAssociationsCommandOutput extends ListDomainAssociati
5252
* // "STRING_VALUE",
5353
* // ],
5454
* // autoSubDomainIAMRole: "STRING_VALUE",
55-
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
55+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
56+
* // updateStatus: "REQUESTING_CERTIFICATE" || "PENDING_VERIFICATION" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "UPDATE_COMPLETE" || "UPDATE_FAILED",
5657
* // statusReason: "STRING_VALUE", // required
5758
* // certificateVerificationDNSRecord: "STRING_VALUE",
5859
* // subDomains: [ // SubDomains // required
@@ -65,6 +66,11 @@ export interface ListDomainAssociationsCommandOutput extends ListDomainAssociati
6566
* // dnsRecord: "STRING_VALUE", // required
6667
* // },
6768
* // ],
69+
* // certificate: { // Certificate
70+
* // type: "AMPLIFY_MANAGED" || "CUSTOM", // required
71+
* // customCertificateArn: "STRING_VALUE",
72+
* // certificateVerificationDNSRecord: "STRING_VALUE",
73+
* // },
6874
* // },
6975
* // ],
7076
* // nextToken: "STRING_VALUE",

clients/client-amplify/src/commands/StartDeploymentCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ export interface StartDeploymentCommandOutput extends StartDeploymentResult, __M
3131
* <p>Starts a deployment for a manually deployed app. Manually deployed apps are not
3232
* connected to a repository. </p>
3333
* <p>The maximum duration between the <code>CreateDeployment</code> call and the
34-
* <code>StartDeployment</code> call cannot exceed 8 hours. If the duration exceeds 8 hours, the
35-
* <code>StartDeployment</code> call and the associated <code>Job</code> will
34+
* <code>StartDeployment</code> call cannot exceed 8 hours. If the duration exceeds 8
35+
* hours, the <code>StartDeployment</code> call and the associated <code>Job</code> will
3636
* fail.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.

clients/client-amplify/src/commands/UpdateDomainAssociationCommand.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface UpdateDomainAssociationCommandOutput extends UpdateDomainAssoci
2828

2929
/**
3030
* @public
31-
* <p> Creates a new domain association for an Amplify app.</p>
31+
* <p>Creates a new domain association for an Amplify app.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript
@@ -49,6 +49,10 @@ export interface UpdateDomainAssociationCommandOutput extends UpdateDomainAssoci
4949
* "STRING_VALUE",
5050
* ],
5151
* autoSubDomainIAMRole: "STRING_VALUE",
52+
* certificateSettings: { // CertificateSettings
53+
* type: "AMPLIFY_MANAGED" || "CUSTOM", // required
54+
* customCertificateArn: "STRING_VALUE",
55+
* },
5256
* };
5357
* const command = new UpdateDomainAssociationCommand(input);
5458
* const response = await client.send(command);
@@ -61,7 +65,8 @@ export interface UpdateDomainAssociationCommandOutput extends UpdateDomainAssoci
6165
* // "STRING_VALUE",
6266
* // ],
6367
* // autoSubDomainIAMRole: "STRING_VALUE",
64-
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
68+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
69+
* // updateStatus: "REQUESTING_CERTIFICATE" || "PENDING_VERIFICATION" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "UPDATE_COMPLETE" || "UPDATE_FAILED",
6570
* // statusReason: "STRING_VALUE", // required
6671
* // certificateVerificationDNSRecord: "STRING_VALUE",
6772
* // subDomains: [ // SubDomains // required
@@ -74,6 +79,11 @@ export interface UpdateDomainAssociationCommandOutput extends UpdateDomainAssoci
7479
* // dnsRecord: "STRING_VALUE", // required
7580
* // },
7681
* // ],
82+
* // certificate: { // Certificate
83+
* // type: "AMPLIFY_MANAGED" || "CUSTOM", // required
84+
* // customCertificateArn: "STRING_VALUE",
85+
* // certificateVerificationDNSRecord: "STRING_VALUE",
86+
* // },
7787
* // },
7888
* // };
7989
*

clients/client-amplify/src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
/* eslint-disable */
33
/**
44
* <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
5-
* Amplify Hosting provides a continuous delivery and hosting service for web
6-
* applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
5+
* Amplify Hosting provides a continuous delivery and hosting service for web applications.
6+
* For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
77
* Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
88
* for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
99
* </p>

0 commit comments

Comments
 (0)