@aws-sdk/client-amplify 3.515.0 → 3.517.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist-cjs/index.js +21 -0
- package/dist-es/models/models_0.js +15 -0
- package/dist-es/protocols/Aws_restJson1.js +2 -0
- package/dist-types/Amplify.d.ts +2 -2
- package/dist-types/AmplifyClient.d.ts +2 -2
- package/dist-types/commands/CreateDeploymentCommand.d.ts +2 -2
- package/dist-types/commands/CreateDomainAssociationCommand.d.ts +12 -2
- package/dist-types/commands/DeleteDomainAssociationCommand.d.ts +8 -2
- package/dist-types/commands/GetDomainAssociationCommand.d.ts +8 -2
- package/dist-types/commands/ListDomainAssociationsCommand.d.ts +8 -2
- package/dist-types/commands/StartDeploymentCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDomainAssociationCommand.d.ts +12 -2
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +222 -50
- package/dist-types/ts3.4/models/models_0.d.ts +31 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
AWS SDK for JavaScript Amplify Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
9
|
<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
|
-
|
|
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
|
|
12
12
|
Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
|
|
13
13
|
for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
|
|
14
14
|
</p>
|
package/dist-cjs/index.js
CHANGED
|
@@ -28,6 +28,7 @@ __export(src_exports, {
|
|
|
28
28
|
AutoBranchCreationConfigFilterSensitiveLog: () => AutoBranchCreationConfigFilterSensitiveLog,
|
|
29
29
|
BadRequestException: () => BadRequestException,
|
|
30
30
|
BranchFilterSensitiveLog: () => BranchFilterSensitiveLog,
|
|
31
|
+
CertificateType: () => CertificateType,
|
|
31
32
|
CreateAppCommand: () => CreateAppCommand,
|
|
32
33
|
CreateAppRequestFilterSensitiveLog: () => CreateAppRequestFilterSensitiveLog,
|
|
33
34
|
CreateAppResultFilterSensitiveLog: () => CreateAppResultFilterSensitiveLog,
|
|
@@ -90,6 +91,7 @@ __export(src_exports, {
|
|
|
90
91
|
UpdateBranchRequestFilterSensitiveLog: () => UpdateBranchRequestFilterSensitiveLog,
|
|
91
92
|
UpdateBranchResultFilterSensitiveLog: () => UpdateBranchResultFilterSensitiveLog,
|
|
92
93
|
UpdateDomainAssociationCommand: () => UpdateDomainAssociationCommand,
|
|
94
|
+
UpdateStatus: () => UpdateStatus,
|
|
93
95
|
UpdateWebhookCommand: () => UpdateWebhookCommand,
|
|
94
96
|
__Client: () => import_smithy_client.Client,
|
|
95
97
|
paginateListApps: () => paginateListApps,
|
|
@@ -388,16 +390,31 @@ var _NotFoundException = class _NotFoundException extends AmplifyServiceExceptio
|
|
|
388
390
|
};
|
|
389
391
|
__name(_NotFoundException, "NotFoundException");
|
|
390
392
|
var NotFoundException = _NotFoundException;
|
|
393
|
+
var CertificateType = {
|
|
394
|
+
AMPLIFY_MANAGED: "AMPLIFY_MANAGED",
|
|
395
|
+
CUSTOM: "CUSTOM"
|
|
396
|
+
};
|
|
391
397
|
var DomainStatus = {
|
|
392
398
|
AVAILABLE: "AVAILABLE",
|
|
399
|
+
AWAITING_APP_CNAME: "AWAITING_APP_CNAME",
|
|
393
400
|
CREATING: "CREATING",
|
|
394
401
|
FAILED: "FAILED",
|
|
402
|
+
IMPORTING_CUSTOM_CERTIFICATE: "IMPORTING_CUSTOM_CERTIFICATE",
|
|
395
403
|
IN_PROGRESS: "IN_PROGRESS",
|
|
396
404
|
PENDING_DEPLOYMENT: "PENDING_DEPLOYMENT",
|
|
397
405
|
PENDING_VERIFICATION: "PENDING_VERIFICATION",
|
|
398
406
|
REQUESTING_CERTIFICATE: "REQUESTING_CERTIFICATE",
|
|
399
407
|
UPDATING: "UPDATING"
|
|
400
408
|
};
|
|
409
|
+
var UpdateStatus = {
|
|
410
|
+
AWAITING_APP_CNAME: "AWAITING_APP_CNAME",
|
|
411
|
+
IMPORTING_CUSTOM_CERTIFICATE: "IMPORTING_CUSTOM_CERTIFICATE",
|
|
412
|
+
PENDING_DEPLOYMENT: "PENDING_DEPLOYMENT",
|
|
413
|
+
PENDING_VERIFICATION: "PENDING_VERIFICATION",
|
|
414
|
+
REQUESTING_CERTIFICATE: "REQUESTING_CERTIFICATE",
|
|
415
|
+
UPDATE_COMPLETE: "UPDATE_COMPLETE",
|
|
416
|
+
UPDATE_FAILED: "UPDATE_FAILED"
|
|
417
|
+
};
|
|
401
418
|
var JobType = {
|
|
402
419
|
MANUAL: "MANUAL",
|
|
403
420
|
RELEASE: "RELEASE",
|
|
@@ -636,6 +653,7 @@ var se_CreateDomainAssociationCommand = /* @__PURE__ */ __name(async (input, con
|
|
|
636
653
|
(0, import_smithy_client.take)(input, {
|
|
637
654
|
autoSubDomainCreationPatterns: (_) => (0, import_smithy_client._json)(_),
|
|
638
655
|
autoSubDomainIAMRole: [],
|
|
656
|
+
certificateSettings: (_) => (0, import_smithy_client._json)(_),
|
|
639
657
|
domainName: [],
|
|
640
658
|
enableAutoSubDomain: [],
|
|
641
659
|
subDomainSettings: (_) => (0, import_smithy_client._json)(_)
|
|
@@ -1069,6 +1087,7 @@ var se_UpdateDomainAssociationCommand = /* @__PURE__ */ __name(async (input, con
|
|
|
1069
1087
|
(0, import_smithy_client.take)(input, {
|
|
1070
1088
|
autoSubDomainCreationPatterns: (_) => (0, import_smithy_client._json)(_),
|
|
1071
1089
|
autoSubDomainIAMRole: [],
|
|
1090
|
+
certificateSettings: (_) => (0, import_smithy_client._json)(_),
|
|
1072
1091
|
enableAutoSubDomain: [],
|
|
1073
1092
|
subDomainSettings: (_) => (0, import_smithy_client._json)(_)
|
|
1074
1093
|
})
|
|
@@ -2701,7 +2720,9 @@ var import_util_endpoints = require("@aws-sdk/util-endpoints");
|
|
|
2701
2720
|
LimitExceededException,
|
|
2702
2721
|
UnauthorizedException,
|
|
2703
2722
|
NotFoundException,
|
|
2723
|
+
CertificateType,
|
|
2704
2724
|
DomainStatus,
|
|
2725
|
+
UpdateStatus,
|
|
2705
2726
|
JobType,
|
|
2706
2727
|
JobStatus,
|
|
2707
2728
|
ResourceNotFoundException,
|
|
@@ -89,16 +89,31 @@ export class NotFoundException extends __BaseException {
|
|
|
89
89
|
Object.setPrototypeOf(this, NotFoundException.prototype);
|
|
90
90
|
}
|
|
91
91
|
}
|
|
92
|
+
export const CertificateType = {
|
|
93
|
+
AMPLIFY_MANAGED: "AMPLIFY_MANAGED",
|
|
94
|
+
CUSTOM: "CUSTOM",
|
|
95
|
+
};
|
|
92
96
|
export const DomainStatus = {
|
|
93
97
|
AVAILABLE: "AVAILABLE",
|
|
98
|
+
AWAITING_APP_CNAME: "AWAITING_APP_CNAME",
|
|
94
99
|
CREATING: "CREATING",
|
|
95
100
|
FAILED: "FAILED",
|
|
101
|
+
IMPORTING_CUSTOM_CERTIFICATE: "IMPORTING_CUSTOM_CERTIFICATE",
|
|
96
102
|
IN_PROGRESS: "IN_PROGRESS",
|
|
97
103
|
PENDING_DEPLOYMENT: "PENDING_DEPLOYMENT",
|
|
98
104
|
PENDING_VERIFICATION: "PENDING_VERIFICATION",
|
|
99
105
|
REQUESTING_CERTIFICATE: "REQUESTING_CERTIFICATE",
|
|
100
106
|
UPDATING: "UPDATING",
|
|
101
107
|
};
|
|
108
|
+
export const UpdateStatus = {
|
|
109
|
+
AWAITING_APP_CNAME: "AWAITING_APP_CNAME",
|
|
110
|
+
IMPORTING_CUSTOM_CERTIFICATE: "IMPORTING_CUSTOM_CERTIFICATE",
|
|
111
|
+
PENDING_DEPLOYMENT: "PENDING_DEPLOYMENT",
|
|
112
|
+
PENDING_VERIFICATION: "PENDING_VERIFICATION",
|
|
113
|
+
REQUESTING_CERTIFICATE: "REQUESTING_CERTIFICATE",
|
|
114
|
+
UPDATE_COMPLETE: "UPDATE_COMPLETE",
|
|
115
|
+
UPDATE_FAILED: "UPDATE_FAILED",
|
|
116
|
+
};
|
|
102
117
|
export const JobType = {
|
|
103
118
|
MANUAL: "MANUAL",
|
|
104
119
|
RELEASE: "RELEASE",
|
|
@@ -106,6 +106,7 @@ export const se_CreateDomainAssociationCommand = async (input, context) => {
|
|
|
106
106
|
body = JSON.stringify(take(input, {
|
|
107
107
|
autoSubDomainCreationPatterns: (_) => _json(_),
|
|
108
108
|
autoSubDomainIAMRole: [],
|
|
109
|
+
certificateSettings: (_) => _json(_),
|
|
109
110
|
domainName: [],
|
|
110
111
|
enableAutoSubDomain: [],
|
|
111
112
|
subDomainSettings: (_) => _json(_),
|
|
@@ -523,6 +524,7 @@ export const se_UpdateDomainAssociationCommand = async (input, context) => {
|
|
|
523
524
|
body = JSON.stringify(take(input, {
|
|
524
525
|
autoSubDomainCreationPatterns: (_) => _json(_),
|
|
525
526
|
autoSubDomainIAMRole: [],
|
|
527
|
+
certificateSettings: (_) => _json(_),
|
|
526
528
|
enableAutoSubDomain: [],
|
|
527
529
|
subDomainSettings: (_) => _json(_),
|
|
528
530
|
}));
|
package/dist-types/Amplify.d.ts
CHANGED
|
@@ -264,8 +264,8 @@ export interface Amplify {
|
|
|
264
264
|
/**
|
|
265
265
|
* @public
|
|
266
266
|
* <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
|
|
267
|
-
* Amplify Hosting provides a continuous delivery and hosting service for web
|
|
268
|
-
*
|
|
267
|
+
* Amplify Hosting provides a continuous delivery and hosting service for web applications.
|
|
268
|
+
* For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
|
|
269
269
|
* Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
|
|
270
270
|
* for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
|
|
271
271
|
* </p>
|
|
@@ -190,8 +190,8 @@ export interface AmplifyClientResolvedConfig extends AmplifyClientResolvedConfig
|
|
|
190
190
|
/**
|
|
191
191
|
* @public
|
|
192
192
|
* <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
|
|
193
|
-
* Amplify Hosting provides a continuous delivery and hosting service for web
|
|
194
|
-
*
|
|
193
|
+
* Amplify Hosting provides a continuous delivery and hosting service for web applications.
|
|
194
|
+
* For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
|
|
195
195
|
* Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
|
|
196
196
|
* for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
|
|
197
197
|
* </p>
|
|
@@ -29,8 +29,8 @@ declare const CreateDeploymentCommand_base: {
|
|
|
29
29
|
* <p>Creates a deployment for a manually deployed Amplify app. Manually deployed apps are
|
|
30
30
|
* not connected to a repository. </p>
|
|
31
31
|
* <p>The maximum duration between the <code>CreateDeployment</code> call and the
|
|
32
|
-
*
|
|
33
|
-
* <code>StartDeployment</code> call and the associated <code>Job</code> will
|
|
32
|
+
* <code>StartDeployment</code> call cannot exceed 8 hours. If the duration exceeds 8
|
|
33
|
+
* hours, the <code>StartDeployment</code> call and the associated <code>Job</code> will
|
|
34
34
|
* fail.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -26,7 +26,7 @@ declare const CreateDomainAssociationCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
* <p>
|
|
29
|
+
* <p>Creates a new domain association for an Amplify app. This action associates a custom
|
|
30
30
|
* domain with the Amplify app </p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -48,6 +48,10 @@ declare const CreateDomainAssociationCommand_base: {
|
|
|
48
48
|
* "STRING_VALUE",
|
|
49
49
|
* ],
|
|
50
50
|
* autoSubDomainIAMRole: "STRING_VALUE",
|
|
51
|
+
* certificateSettings: { // CertificateSettings
|
|
52
|
+
* type: "AMPLIFY_MANAGED" || "CUSTOM", // required
|
|
53
|
+
* customCertificateArn: "STRING_VALUE",
|
|
54
|
+
* },
|
|
51
55
|
* };
|
|
52
56
|
* const command = new CreateDomainAssociationCommand(input);
|
|
53
57
|
* const response = await client.send(command);
|
|
@@ -60,7 +64,8 @@ declare const CreateDomainAssociationCommand_base: {
|
|
|
60
64
|
* // "STRING_VALUE",
|
|
61
65
|
* // ],
|
|
62
66
|
* // autoSubDomainIAMRole: "STRING_VALUE",
|
|
63
|
-
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
|
|
67
|
+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
|
|
68
|
+
* // updateStatus: "REQUESTING_CERTIFICATE" || "PENDING_VERIFICATION" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "UPDATE_COMPLETE" || "UPDATE_FAILED",
|
|
64
69
|
* // statusReason: "STRING_VALUE", // required
|
|
65
70
|
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
66
71
|
* // subDomains: [ // SubDomains // required
|
|
@@ -73,6 +78,11 @@ declare const CreateDomainAssociationCommand_base: {
|
|
|
73
78
|
* // dnsRecord: "STRING_VALUE", // required
|
|
74
79
|
* // },
|
|
75
80
|
* // ],
|
|
81
|
+
* // certificate: { // Certificate
|
|
82
|
+
* // type: "AMPLIFY_MANAGED" || "CUSTOM", // required
|
|
83
|
+
* // customCertificateArn: "STRING_VALUE",
|
|
84
|
+
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
85
|
+
* // },
|
|
76
86
|
* // },
|
|
77
87
|
* // };
|
|
78
88
|
*
|
|
@@ -26,7 +26,7 @@ declare const DeleteDomainAssociationCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
* <p>
|
|
29
|
+
* <p>Deletes a domain association for an Amplify app. </p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -48,7 +48,8 @@ declare const DeleteDomainAssociationCommand_base: {
|
|
|
48
48
|
* // "STRING_VALUE",
|
|
49
49
|
* // ],
|
|
50
50
|
* // autoSubDomainIAMRole: "STRING_VALUE",
|
|
51
|
-
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
|
|
51
|
+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
|
|
52
|
+
* // updateStatus: "REQUESTING_CERTIFICATE" || "PENDING_VERIFICATION" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "UPDATE_COMPLETE" || "UPDATE_FAILED",
|
|
52
53
|
* // statusReason: "STRING_VALUE", // required
|
|
53
54
|
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
54
55
|
* // subDomains: [ // SubDomains // required
|
|
@@ -61,6 +62,11 @@ declare const DeleteDomainAssociationCommand_base: {
|
|
|
61
62
|
* // dnsRecord: "STRING_VALUE", // required
|
|
62
63
|
* // },
|
|
63
64
|
* // ],
|
|
65
|
+
* // certificate: { // Certificate
|
|
66
|
+
* // type: "AMPLIFY_MANAGED" || "CUSTOM", // required
|
|
67
|
+
* // customCertificateArn: "STRING_VALUE",
|
|
68
|
+
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
64
70
|
* // },
|
|
65
71
|
* // };
|
|
66
72
|
*
|
|
@@ -26,7 +26,7 @@ declare const GetDomainAssociationCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
* <p>
|
|
29
|
+
* <p>Returns the domain information for an Amplify app. </p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -48,7 +48,8 @@ declare const GetDomainAssociationCommand_base: {
|
|
|
48
48
|
* // "STRING_VALUE",
|
|
49
49
|
* // ],
|
|
50
50
|
* // autoSubDomainIAMRole: "STRING_VALUE",
|
|
51
|
-
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
|
|
51
|
+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
|
|
52
|
+
* // updateStatus: "REQUESTING_CERTIFICATE" || "PENDING_VERIFICATION" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "UPDATE_COMPLETE" || "UPDATE_FAILED",
|
|
52
53
|
* // statusReason: "STRING_VALUE", // required
|
|
53
54
|
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
54
55
|
* // subDomains: [ // SubDomains // required
|
|
@@ -61,6 +62,11 @@ declare const GetDomainAssociationCommand_base: {
|
|
|
61
62
|
* // dnsRecord: "STRING_VALUE", // required
|
|
62
63
|
* // },
|
|
63
64
|
* // ],
|
|
65
|
+
* // certificate: { // Certificate
|
|
66
|
+
* // type: "AMPLIFY_MANAGED" || "CUSTOM", // required
|
|
67
|
+
* // customCertificateArn: "STRING_VALUE",
|
|
68
|
+
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
64
70
|
* // },
|
|
65
71
|
* // };
|
|
66
72
|
*
|
|
@@ -26,7 +26,7 @@ declare const ListDomainAssociationsCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
* <p>
|
|
29
|
+
* <p>Returns the domain associations for an Amplify app. </p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -50,7 +50,8 @@ declare const ListDomainAssociationsCommand_base: {
|
|
|
50
50
|
* // "STRING_VALUE",
|
|
51
51
|
* // ],
|
|
52
52
|
* // 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",
|
|
54
55
|
* // statusReason: "STRING_VALUE", // required
|
|
55
56
|
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
56
57
|
* // subDomains: [ // SubDomains // required
|
|
@@ -63,6 +64,11 @@ declare const ListDomainAssociationsCommand_base: {
|
|
|
63
64
|
* // dnsRecord: "STRING_VALUE", // required
|
|
64
65
|
* // },
|
|
65
66
|
* // ],
|
|
67
|
+
* // certificate: { // Certificate
|
|
68
|
+
* // type: "AMPLIFY_MANAGED" || "CUSTOM", // required
|
|
69
|
+
* // customCertificateArn: "STRING_VALUE",
|
|
70
|
+
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
66
72
|
* // },
|
|
67
73
|
* // ],
|
|
68
74
|
* // nextToken: "STRING_VALUE",
|
|
@@ -29,8 +29,8 @@ declare const StartDeploymentCommand_base: {
|
|
|
29
29
|
* <p>Starts a deployment for a manually deployed app. Manually deployed apps are not
|
|
30
30
|
* connected to a repository. </p>
|
|
31
31
|
* <p>The maximum duration between the <code>CreateDeployment</code> call and the
|
|
32
|
-
*
|
|
33
|
-
* <code>StartDeployment</code> call and the associated <code>Job</code> will
|
|
32
|
+
* <code>StartDeployment</code> call cannot exceed 8 hours. If the duration exceeds 8
|
|
33
|
+
* hours, the <code>StartDeployment</code> call and the associated <code>Job</code> will
|
|
34
34
|
* fail.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -26,7 +26,7 @@ declare const UpdateDomainAssociationCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
* <p>
|
|
29
|
+
* <p>Creates a new domain association for an Amplify app.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -47,6 +47,10 @@ declare const UpdateDomainAssociationCommand_base: {
|
|
|
47
47
|
* "STRING_VALUE",
|
|
48
48
|
* ],
|
|
49
49
|
* autoSubDomainIAMRole: "STRING_VALUE",
|
|
50
|
+
* certificateSettings: { // CertificateSettings
|
|
51
|
+
* type: "AMPLIFY_MANAGED" || "CUSTOM", // required
|
|
52
|
+
* customCertificateArn: "STRING_VALUE",
|
|
53
|
+
* },
|
|
50
54
|
* };
|
|
51
55
|
* const command = new UpdateDomainAssociationCommand(input);
|
|
52
56
|
* const response = await client.send(command);
|
|
@@ -59,7 +63,8 @@ declare const UpdateDomainAssociationCommand_base: {
|
|
|
59
63
|
* // "STRING_VALUE",
|
|
60
64
|
* // ],
|
|
61
65
|
* // autoSubDomainIAMRole: "STRING_VALUE",
|
|
62
|
-
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
|
|
66
|
+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
|
|
67
|
+
* // updateStatus: "REQUESTING_CERTIFICATE" || "PENDING_VERIFICATION" || "IMPORTING_CUSTOM_CERTIFICATE" || "PENDING_DEPLOYMENT" || "AWAITING_APP_CNAME" || "UPDATE_COMPLETE" || "UPDATE_FAILED",
|
|
63
68
|
* // statusReason: "STRING_VALUE", // required
|
|
64
69
|
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
65
70
|
* // subDomains: [ // SubDomains // required
|
|
@@ -72,6 +77,11 @@ declare const UpdateDomainAssociationCommand_base: {
|
|
|
72
77
|
* // dnsRecord: "STRING_VALUE", // required
|
|
73
78
|
* // },
|
|
74
79
|
* // ],
|
|
80
|
+
* // certificate: { // Certificate
|
|
81
|
+
* // type: "AMPLIFY_MANAGED" || "CUSTOM", // required
|
|
82
|
+
* // customCertificateArn: "STRING_VALUE",
|
|
83
|
+
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
84
|
+
* // },
|
|
75
85
|
* // },
|
|
76
86
|
* // };
|
|
77
87
|
*
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
|
|
3
|
-
* Amplify Hosting provides a continuous delivery and hosting service for web
|
|
4
|
-
*
|
|
3
|
+
* Amplify Hosting provides a continuous delivery and hosting service for web applications.
|
|
4
|
+
* For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
|
|
5
5
|
* Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
|
|
6
6
|
* for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
|
|
7
7
|
* </p>
|
|
@@ -54,9 +54,9 @@ export interface AutoBranchCreationConfig {
|
|
|
54
54
|
environmentVariables?: Record<string, string>;
|
|
55
55
|
/**
|
|
56
56
|
* @public
|
|
57
|
-
* <p>The basic authorization credentials for the autocreated branch. You must
|
|
58
|
-
*
|
|
59
|
-
*
|
|
57
|
+
* <p>The basic authorization credentials for the autocreated branch. You must base64-encode
|
|
58
|
+
* the authorization credentials and provide them in the format
|
|
59
|
+
* <code>user:password</code>.</p>
|
|
60
60
|
*/
|
|
61
61
|
basicAuthCredentials?: string;
|
|
62
62
|
/**
|
|
@@ -113,7 +113,7 @@ export interface CustomRule {
|
|
|
113
113
|
* </dd>
|
|
114
114
|
* <dt>301</dt>
|
|
115
115
|
* <dd>
|
|
116
|
-
* <p>Represents a 301 (moved
|
|
116
|
+
* <p>Represents a 301 (moved permanently) redirect rule. This and all future
|
|
117
117
|
* requests should be directed to the target URL. </p>
|
|
118
118
|
* </dd>
|
|
119
119
|
* <dt>302</dt>
|
|
@@ -172,10 +172,10 @@ export interface CreateAppRequest {
|
|
|
172
172
|
repository?: string;
|
|
173
173
|
/**
|
|
174
174
|
* @public
|
|
175
|
-
* <p>The platform for the Amplify app. For a static app, set the platform type to
|
|
176
|
-
*
|
|
177
|
-
* <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
|
|
178
|
-
* <code>WEB_DYNAMIC</code>.</p>
|
|
175
|
+
* <p>The platform for the Amplify app. For a static app, set the platform type to
|
|
176
|
+
* <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
|
|
177
|
+
* type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
|
|
178
|
+
* support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
|
|
179
179
|
*/
|
|
180
180
|
platform?: Platform;
|
|
181
181
|
/**
|
|
@@ -217,7 +217,10 @@ export interface CreateAppRequest {
|
|
|
217
217
|
/**
|
|
218
218
|
* @public
|
|
219
219
|
* <p>The environment variables map for an Amplify app. </p>
|
|
220
|
-
* <p>For a list of the environment variables that are accessible to Amplify by default, see
|
|
220
|
+
* <p>For a list of the environment variables that are accessible to Amplify by default, see
|
|
221
|
+
* <a href="https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html">Amplify
|
|
222
|
+
* Environment variables</a> in the <i>Amplify Hosting User
|
|
223
|
+
* Guide</i>.</p>
|
|
221
224
|
*/
|
|
222
225
|
environmentVariables?: Record<string, string>;
|
|
223
226
|
/**
|
|
@@ -239,8 +242,8 @@ export interface CreateAppRequest {
|
|
|
239
242
|
enableBasicAuth?: boolean;
|
|
240
243
|
/**
|
|
241
244
|
* @public
|
|
242
|
-
* <p>The credentials for basic authorization for an Amplify app. You must base64-encode
|
|
243
|
-
*
|
|
245
|
+
* <p>The credentials for basic authorization for an Amplify app. You must base64-encode the
|
|
246
|
+
* authorization credentials and provide them in the format
|
|
244
247
|
* <code>user:password</code>.</p>
|
|
245
248
|
*/
|
|
246
249
|
basicAuthCredentials?: string;
|
|
@@ -321,8 +324,8 @@ export declare const RepositoryCloneMethod: {
|
|
|
321
324
|
export type RepositoryCloneMethod = (typeof RepositoryCloneMethod)[keyof typeof RepositoryCloneMethod];
|
|
322
325
|
/**
|
|
323
326
|
* @public
|
|
324
|
-
* <p>Represents the different branches of a repository for building, deploying, and
|
|
325
|
-
*
|
|
327
|
+
* <p>Represents the different branches of a repository for building, deploying, and hosting
|
|
328
|
+
* an Amplify app. </p>
|
|
326
329
|
*/
|
|
327
330
|
export interface App {
|
|
328
331
|
/**
|
|
@@ -357,10 +360,10 @@ export interface App {
|
|
|
357
360
|
repository: string | undefined;
|
|
358
361
|
/**
|
|
359
362
|
* @public
|
|
360
|
-
* <p>The platform for the Amplify app. For a static app, set the platform type to
|
|
361
|
-
*
|
|
362
|
-
* <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
|
|
363
|
-
* <code>WEB_DYNAMIC</code>.</p>
|
|
363
|
+
* <p>The platform for the Amplify app. For a static app, set the platform type to
|
|
364
|
+
* <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
|
|
365
|
+
* type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
|
|
366
|
+
* support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
|
|
364
367
|
*/
|
|
365
368
|
platform: Platform | undefined;
|
|
366
369
|
/**
|
|
@@ -375,14 +378,17 @@ export interface App {
|
|
|
375
378
|
updateTime: Date | undefined;
|
|
376
379
|
/**
|
|
377
380
|
* @public
|
|
378
|
-
* <p>The AWS Identity and Access Management (IAM) service role for the Amazon Resource
|
|
379
|
-
*
|
|
381
|
+
* <p>The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name
|
|
382
|
+
* (ARN) of the Amplify app. </p>
|
|
380
383
|
*/
|
|
381
384
|
iamServiceRoleArn?: string;
|
|
382
385
|
/**
|
|
383
386
|
* @public
|
|
384
387
|
* <p>The environment variables for the Amplify app. </p>
|
|
385
|
-
* <p>For a list of the environment variables that are accessible to Amplify by default, see
|
|
388
|
+
* <p>For a list of the environment variables that are accessible to Amplify by default, see
|
|
389
|
+
* <a href="https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html">Amplify
|
|
390
|
+
* Environment variables</a> in the <i>Amplify Hosting User
|
|
391
|
+
* Guide</i>.</p>
|
|
386
392
|
*/
|
|
387
393
|
environmentVariables: Record<string, string> | undefined;
|
|
388
394
|
/**
|
|
@@ -397,8 +403,8 @@ export interface App {
|
|
|
397
403
|
enableBranchAutoBuild: boolean | undefined;
|
|
398
404
|
/**
|
|
399
405
|
* @public
|
|
400
|
-
* <p>Automatically disconnect a branch in the Amplify console when you delete a branch
|
|
401
|
-
*
|
|
406
|
+
* <p>Automatically disconnect a branch in the Amplify console when you delete a branch from
|
|
407
|
+
* your Git repository.</p>
|
|
402
408
|
*/
|
|
403
409
|
enableBranchAutoDeletion?: boolean;
|
|
404
410
|
/**
|
|
@@ -454,10 +460,10 @@ export interface App {
|
|
|
454
460
|
* <note>
|
|
455
461
|
* <p>This is for internal use.</p>
|
|
456
462
|
* </note>
|
|
457
|
-
* <p>The Amplify service uses this parameter to specify the authentication protocol to use
|
|
458
|
-
* the Git repository for an Amplify app. Amplify specifies <code>TOKEN</code>
|
|
459
|
-
* repository, <code>SIGV4</code> for an Amazon Web Services CodeCommit
|
|
460
|
-
*
|
|
463
|
+
* <p>The Amplify service uses this parameter to specify the authentication protocol to use
|
|
464
|
+
* to access the Git repository for an Amplify app. Amplify specifies <code>TOKEN</code>
|
|
465
|
+
* for a GitHub repository, <code>SIGV4</code> for an Amazon Web Services CodeCommit
|
|
466
|
+
* repository, and <code>SSH</code> for GitLab and Bitbucket repositories.</p>
|
|
461
467
|
*/
|
|
462
468
|
repositoryCloneMethod?: RepositoryCloneMethod;
|
|
463
469
|
}
|
|
@@ -467,8 +473,8 @@ export interface App {
|
|
|
467
473
|
export interface CreateAppResult {
|
|
468
474
|
/**
|
|
469
475
|
* @public
|
|
470
|
-
* <p>Represents the different branches of a repository for building, deploying, and
|
|
471
|
-
*
|
|
476
|
+
* <p>Represents the different branches of a repository for building, deploying, and hosting
|
|
477
|
+
* an Amplify app. </p>
|
|
472
478
|
*/
|
|
473
479
|
app: App | undefined;
|
|
474
480
|
}
|
|
@@ -610,7 +616,8 @@ export declare class NotFoundException extends __BaseException {
|
|
|
610
616
|
}
|
|
611
617
|
/**
|
|
612
618
|
* @public
|
|
613
|
-
* <p>Describes the backend properties associated with an Amplify
|
|
619
|
+
* <p>Describes the backend properties associated with an Amplify
|
|
620
|
+
* <code>Branch</code>.</p>
|
|
614
621
|
*/
|
|
615
622
|
export interface Backend {
|
|
616
623
|
/**
|
|
@@ -722,7 +729,8 @@ export interface CreateBranchRequest {
|
|
|
722
729
|
backendEnvironmentArn?: string;
|
|
723
730
|
/**
|
|
724
731
|
* @public
|
|
725
|
-
* <p>The backend for a <code>Branch</code> of an Amplify app. Use for a
|
|
732
|
+
* <p>The backend for a <code>Branch</code> of an Amplify app. Use for a
|
|
733
|
+
* backend created from an CloudFormation stack.</p>
|
|
726
734
|
*/
|
|
727
735
|
backend?: Backend;
|
|
728
736
|
}
|
|
@@ -875,7 +883,8 @@ export interface Branch {
|
|
|
875
883
|
backendEnvironmentArn?: string;
|
|
876
884
|
/**
|
|
877
885
|
* @public
|
|
878
|
-
* <p>Describes the backend properties associated with an Amplify
|
|
886
|
+
* <p>Describes the backend properties associated with an Amplify
|
|
887
|
+
* <code>Branch</code>.</p>
|
|
879
888
|
*/
|
|
880
889
|
backend?: Backend;
|
|
881
890
|
}
|
|
@@ -938,6 +947,46 @@ export interface CreateDeploymentResult {
|
|
|
938
947
|
*/
|
|
939
948
|
zipUploadUrl: string | undefined;
|
|
940
949
|
}
|
|
950
|
+
/**
|
|
951
|
+
* @public
|
|
952
|
+
* @enum
|
|
953
|
+
*/
|
|
954
|
+
export declare const CertificateType: {
|
|
955
|
+
readonly AMPLIFY_MANAGED: "AMPLIFY_MANAGED";
|
|
956
|
+
readonly CUSTOM: "CUSTOM";
|
|
957
|
+
};
|
|
958
|
+
/**
|
|
959
|
+
* @public
|
|
960
|
+
*/
|
|
961
|
+
export type CertificateType = (typeof CertificateType)[keyof typeof CertificateType];
|
|
962
|
+
/**
|
|
963
|
+
* @public
|
|
964
|
+
* <p>The type of SSL/TLS certificate to use for your custom domain. If a certificate type
|
|
965
|
+
* isn't specified, Amplify uses the default <code>AMPLIFY_MANAGED</code>
|
|
966
|
+
* certificate.</p>
|
|
967
|
+
*/
|
|
968
|
+
export interface CertificateSettings {
|
|
969
|
+
/**
|
|
970
|
+
* @public
|
|
971
|
+
* <p>The certificate type.</p>
|
|
972
|
+
* <p>Specify <code>AMPLIFY_MANAGED</code> to use the default certificate that Amplify
|
|
973
|
+
* provisions for you.</p>
|
|
974
|
+
* <p>Specify <code>CUSTOM</code> to use your own certificate that you have already added to
|
|
975
|
+
* Certificate Manager in your Amazon Web Services account. Make sure you request (or
|
|
976
|
+
* import) the certificate in the US East (N. Virginia) Region (us-east-1). For more
|
|
977
|
+
* information about using ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into
|
|
978
|
+
* Certificate Manager</a> in the <i>ACM User
|
|
979
|
+
* guide</i>.</p>
|
|
980
|
+
*/
|
|
981
|
+
type: CertificateType | undefined;
|
|
982
|
+
/**
|
|
983
|
+
* @public
|
|
984
|
+
* <p>The Amazon resource name (ARN) for the custom certificate that you have already added
|
|
985
|
+
* to Certificate Manager in your Amazon Web Services account.</p>
|
|
986
|
+
* <p>This field is required only when the certificate type is <code>CUSTOM</code>.</p>
|
|
987
|
+
*/
|
|
988
|
+
customCertificateArn?: string;
|
|
989
|
+
}
|
|
941
990
|
/**
|
|
942
991
|
* @public
|
|
943
992
|
* <p> Describes the settings for the subdomain. </p>
|
|
@@ -990,6 +1039,46 @@ export interface CreateDomainAssociationRequest {
|
|
|
990
1039
|
* Resource Name (ARN) for automatically creating subdomains. </p>
|
|
991
1040
|
*/
|
|
992
1041
|
autoSubDomainIAMRole?: string;
|
|
1042
|
+
/**
|
|
1043
|
+
* @public
|
|
1044
|
+
* <p>The type of SSL/TLS certificate to use for your custom domain. If you don't specify a
|
|
1045
|
+
* certificate type, Amplify uses the default certificate that it provisions and manages
|
|
1046
|
+
* for you.</p>
|
|
1047
|
+
*/
|
|
1048
|
+
certificateSettings?: CertificateSettings;
|
|
1049
|
+
}
|
|
1050
|
+
/**
|
|
1051
|
+
* @public
|
|
1052
|
+
* <p>Describes the current SSL/TLS certificate that is in use for the domain. If you are
|
|
1053
|
+
* using <code>CreateDomainAssociation</code> to create a new domain association,
|
|
1054
|
+
* <code>Certificate</code> describes the new certificate that you are creating.</p>
|
|
1055
|
+
*/
|
|
1056
|
+
export interface Certificate {
|
|
1057
|
+
/**
|
|
1058
|
+
* @public
|
|
1059
|
+
* <p>The type of SSL/TLS certificate that you want to use.</p>
|
|
1060
|
+
* <p>Specify <code>AMPLIFY_MANAGED</code> to use the default certificate that Amplify
|
|
1061
|
+
* provisions for you.</p>
|
|
1062
|
+
* <p>Specify <code>CUSTOM</code> to use your own certificate that you have already added to
|
|
1063
|
+
* Certificate Manager in your Amazon Web Services account. Make sure you request (or
|
|
1064
|
+
* import) the certificate in the US East (N. Virginia) Region (us-east-1). For more
|
|
1065
|
+
* information about using ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into
|
|
1066
|
+
* Certificate Manager</a> in the <i>ACM User
|
|
1067
|
+
* guide</i> .</p>
|
|
1068
|
+
*/
|
|
1069
|
+
type: CertificateType | undefined;
|
|
1070
|
+
/**
|
|
1071
|
+
* @public
|
|
1072
|
+
* <p>The Amazon resource name (ARN) for a custom certificate that you have already added to
|
|
1073
|
+
* Certificate Manager in your Amazon Web Services account. </p>
|
|
1074
|
+
* <p>This field is required only when the certificate type is <code>CUSTOM</code>.</p>
|
|
1075
|
+
*/
|
|
1076
|
+
customCertificateArn?: string;
|
|
1077
|
+
/**
|
|
1078
|
+
* @public
|
|
1079
|
+
* <p>The DNS record for certificate verification.</p>
|
|
1080
|
+
*/
|
|
1081
|
+
certificateVerificationDNSRecord?: string;
|
|
993
1082
|
}
|
|
994
1083
|
/**
|
|
995
1084
|
* @public
|
|
@@ -997,8 +1086,10 @@ export interface CreateDomainAssociationRequest {
|
|
|
997
1086
|
*/
|
|
998
1087
|
export declare const DomainStatus: {
|
|
999
1088
|
readonly AVAILABLE: "AVAILABLE";
|
|
1089
|
+
readonly AWAITING_APP_CNAME: "AWAITING_APP_CNAME";
|
|
1000
1090
|
readonly CREATING: "CREATING";
|
|
1001
1091
|
readonly FAILED: "FAILED";
|
|
1092
|
+
readonly IMPORTING_CUSTOM_CERTIFICATE: "IMPORTING_CUSTOM_CERTIFICATE";
|
|
1002
1093
|
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
1003
1094
|
readonly PENDING_DEPLOYMENT: "PENDING_DEPLOYMENT";
|
|
1004
1095
|
readonly PENDING_VERIFICATION: "PENDING_VERIFICATION";
|
|
@@ -1032,8 +1123,24 @@ export interface SubDomain {
|
|
|
1032
1123
|
}
|
|
1033
1124
|
/**
|
|
1034
1125
|
* @public
|
|
1035
|
-
*
|
|
1036
|
-
|
|
1126
|
+
* @enum
|
|
1127
|
+
*/
|
|
1128
|
+
export declare const UpdateStatus: {
|
|
1129
|
+
readonly AWAITING_APP_CNAME: "AWAITING_APP_CNAME";
|
|
1130
|
+
readonly IMPORTING_CUSTOM_CERTIFICATE: "IMPORTING_CUSTOM_CERTIFICATE";
|
|
1131
|
+
readonly PENDING_DEPLOYMENT: "PENDING_DEPLOYMENT";
|
|
1132
|
+
readonly PENDING_VERIFICATION: "PENDING_VERIFICATION";
|
|
1133
|
+
readonly REQUESTING_CERTIFICATE: "REQUESTING_CERTIFICATE";
|
|
1134
|
+
readonly UPDATE_COMPLETE: "UPDATE_COMPLETE";
|
|
1135
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
1136
|
+
};
|
|
1137
|
+
/**
|
|
1138
|
+
* @public
|
|
1139
|
+
*/
|
|
1140
|
+
export type UpdateStatus = (typeof UpdateStatus)[keyof typeof UpdateStatus];
|
|
1141
|
+
/**
|
|
1142
|
+
* @public
|
|
1143
|
+
* <p>Describes the association between a custom domain and an Amplify app. </p>
|
|
1037
1144
|
*/
|
|
1038
1145
|
export interface DomainAssociation {
|
|
1039
1146
|
/**
|
|
@@ -1069,7 +1176,57 @@ export interface DomainAssociation {
|
|
|
1069
1176
|
domainStatus: DomainStatus | undefined;
|
|
1070
1177
|
/**
|
|
1071
1178
|
* @public
|
|
1072
|
-
* <p>
|
|
1179
|
+
* <p>The status of the domain update operation that is currently in progress. The following
|
|
1180
|
+
* list describes the valid update states.</p>
|
|
1181
|
+
* <dl>
|
|
1182
|
+
* <dt>REQUESTING_CERTIFICATE</dt>
|
|
1183
|
+
* <dd>
|
|
1184
|
+
* <p>The certificate is in the process of being updated.</p>
|
|
1185
|
+
* </dd>
|
|
1186
|
+
* <dt>PENDING_VERIFICATION</dt>
|
|
1187
|
+
* <dd>
|
|
1188
|
+
* <p>Indicates that an Amplify managed certificate is in the
|
|
1189
|
+
* process of being verified. This occurs during the creation of a custom
|
|
1190
|
+
* domain or when a custom domain is updated to use a managed
|
|
1191
|
+
* certificate.</p>
|
|
1192
|
+
* </dd>
|
|
1193
|
+
* <dt>IMPORTING_CUSTOM_CERTIFICATE</dt>
|
|
1194
|
+
* <dd>
|
|
1195
|
+
* <p>Indicates that an Amplify custom certificate is in the
|
|
1196
|
+
* process of being imported. This occurs during the creation of a custom
|
|
1197
|
+
* domain or when a custom domain is updated to use a custom
|
|
1198
|
+
* certificate.</p>
|
|
1199
|
+
* </dd>
|
|
1200
|
+
* <dt>PENDING_DEPLOYMENT</dt>
|
|
1201
|
+
* <dd>
|
|
1202
|
+
* <p>Indicates that the subdomain or certificate changes are being
|
|
1203
|
+
* propagated.</p>
|
|
1204
|
+
* </dd>
|
|
1205
|
+
* <dt>AWAITING_APP_CNAME</dt>
|
|
1206
|
+
* <dd>
|
|
1207
|
+
* <p>Amplify is waiting for CNAME records corresponding to
|
|
1208
|
+
* subdomains to be propagated. If your custom domain is on Route 53,
|
|
1209
|
+
* Amplify handles this for you automatically. For more
|
|
1210
|
+
* information about custom domains, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html">Setting up custom
|
|
1211
|
+
* domains</a> in the <i>Amplify Hosting User
|
|
1212
|
+
* Guide</i>. </p>
|
|
1213
|
+
* </dd>
|
|
1214
|
+
* <dt>UPDATE_COMPLETE</dt>
|
|
1215
|
+
* <dd>
|
|
1216
|
+
* <p>The certificate has been associated with a domain.</p>
|
|
1217
|
+
* </dd>
|
|
1218
|
+
* <dt>UPDATE_FAILED</dt>
|
|
1219
|
+
* <dd>
|
|
1220
|
+
* <p>The certificate has failed to be provisioned or associated, and there is
|
|
1221
|
+
* no existing active certificate to roll back to.</p>
|
|
1222
|
+
* </dd>
|
|
1223
|
+
* </dl>
|
|
1224
|
+
*/
|
|
1225
|
+
updateStatus?: UpdateStatus;
|
|
1226
|
+
/**
|
|
1227
|
+
* @public
|
|
1228
|
+
* <p> Additional information that describes why the domain association is in the current
|
|
1229
|
+
* state.</p>
|
|
1073
1230
|
*/
|
|
1074
1231
|
statusReason: string | undefined;
|
|
1075
1232
|
/**
|
|
@@ -1082,6 +1239,17 @@ export interface DomainAssociation {
|
|
|
1082
1239
|
* <p> The subdomains for the domain association. </p>
|
|
1083
1240
|
*/
|
|
1084
1241
|
subDomains: SubDomain[] | undefined;
|
|
1242
|
+
/**
|
|
1243
|
+
* @public
|
|
1244
|
+
* <p>Describes the SSL/TLS certificate for the domain association. This can be your own
|
|
1245
|
+
* custom certificate or the default certificate that Amplify provisions for
|
|
1246
|
+
* you.</p>
|
|
1247
|
+
* <p>If you are updating your domain to use a different certificate,
|
|
1248
|
+
* <code>certificate</code> points to the new certificate that is being created instead
|
|
1249
|
+
* of the current active certificate. Otherwise, <code>certificate</code> points to the
|
|
1250
|
+
* current active certificate.</p>
|
|
1251
|
+
*/
|
|
1252
|
+
certificate?: Certificate;
|
|
1085
1253
|
}
|
|
1086
1254
|
/**
|
|
1087
1255
|
* @public
|
|
@@ -1186,8 +1354,8 @@ export interface DeleteAppRequest {
|
|
|
1186
1354
|
export interface DeleteAppResult {
|
|
1187
1355
|
/**
|
|
1188
1356
|
* @public
|
|
1189
|
-
* <p>Represents the different branches of a repository for building, deploying, and
|
|
1190
|
-
*
|
|
1357
|
+
* <p>Represents the different branches of a repository for building, deploying, and hosting
|
|
1358
|
+
* an Amplify app. </p>
|
|
1191
1359
|
*/
|
|
1192
1360
|
app: App | undefined;
|
|
1193
1361
|
}
|
|
@@ -1267,8 +1435,7 @@ export interface DeleteDomainAssociationRequest {
|
|
|
1267
1435
|
export interface DeleteDomainAssociationResult {
|
|
1268
1436
|
/**
|
|
1269
1437
|
* @public
|
|
1270
|
-
* <p>
|
|
1271
|
-
* </p>
|
|
1438
|
+
* <p>Describes the association between a custom domain and an Amplify app. </p>
|
|
1272
1439
|
*/
|
|
1273
1440
|
domainAssociation: DomainAssociation | undefined;
|
|
1274
1441
|
}
|
|
@@ -1468,8 +1635,8 @@ export interface GetAppRequest {
|
|
|
1468
1635
|
export interface GetAppResult {
|
|
1469
1636
|
/**
|
|
1470
1637
|
* @public
|
|
1471
|
-
* <p>Represents the different branches of a repository for building, deploying, and
|
|
1472
|
-
*
|
|
1638
|
+
* <p>Represents the different branches of a repository for building, deploying, and hosting
|
|
1639
|
+
* an Amplify app. </p>
|
|
1473
1640
|
*/
|
|
1474
1641
|
app: App | undefined;
|
|
1475
1642
|
}
|
|
@@ -1978,8 +2145,8 @@ export interface ListJobsResult {
|
|
|
1978
2145
|
jobSummaries: JobSummary[] | undefined;
|
|
1979
2146
|
/**
|
|
1980
2147
|
* @public
|
|
1981
|
-
* <p>A pagination token. If non-null the pagination token is returned in a result. Pass
|
|
1982
|
-
*
|
|
2148
|
+
* <p>A pagination token. If non-null the pagination token is returned in a result. Pass its
|
|
2149
|
+
* value in another request to retrieve more entries. </p>
|
|
1983
2150
|
*/
|
|
1984
2151
|
nextToken?: string;
|
|
1985
2152
|
}
|
|
@@ -2123,9 +2290,8 @@ export interface StartJobRequest {
|
|
|
2123
2290
|
* <p>Describes the type for the job. The job type <code>RELEASE</code> starts a new job
|
|
2124
2291
|
* with the latest change from the specified branch. This value is available only for apps
|
|
2125
2292
|
* that are connected to a repository. </p>
|
|
2126
|
-
* <p>The job type <code>RETRY</code> retries an existing
|
|
2127
|
-
*
|
|
2128
|
-
* required. </p>
|
|
2293
|
+
* <p>The job type <code>RETRY</code> retries an existing job. If the job type value is
|
|
2294
|
+
* <code>RETRY</code>, the <code>jobId</code> is also required. </p>
|
|
2129
2295
|
*/
|
|
2130
2296
|
jobType: JobType | undefined;
|
|
2131
2297
|
/**
|
|
@@ -2258,10 +2424,10 @@ export interface UpdateAppRequest {
|
|
|
2258
2424
|
description?: string;
|
|
2259
2425
|
/**
|
|
2260
2426
|
* @public
|
|
2261
|
-
* <p>The platform for the Amplify app. For a static app, set the platform type to
|
|
2262
|
-
*
|
|
2263
|
-
* <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
|
|
2264
|
-
* <code>WEB_DYNAMIC</code>.</p>
|
|
2427
|
+
* <p>The platform for the Amplify app. For a static app, set the platform type to
|
|
2428
|
+
* <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
|
|
2429
|
+
* type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
|
|
2430
|
+
* support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
|
|
2265
2431
|
*/
|
|
2266
2432
|
platform?: Platform;
|
|
2267
2433
|
/**
|
|
@@ -2474,7 +2640,8 @@ export interface UpdateBranchRequest {
|
|
|
2474
2640
|
backendEnvironmentArn?: string;
|
|
2475
2641
|
/**
|
|
2476
2642
|
* @public
|
|
2477
|
-
* <p>The backend for a <code>Branch</code> of an Amplify app. Use for a
|
|
2643
|
+
* <p>The backend for a <code>Branch</code> of an Amplify app. Use for a
|
|
2644
|
+
* backend created from an CloudFormation stack.</p>
|
|
2478
2645
|
*/
|
|
2479
2646
|
backend?: Backend;
|
|
2480
2647
|
}
|
|
@@ -2525,6 +2692,11 @@ export interface UpdateDomainAssociationRequest {
|
|
|
2525
2692
|
* Resource Name (ARN) for automatically creating subdomains. </p>
|
|
2526
2693
|
*/
|
|
2527
2694
|
autoSubDomainIAMRole?: string;
|
|
2695
|
+
/**
|
|
2696
|
+
* @public
|
|
2697
|
+
* <p>The type of SSL/TLS certificate to use for your custom domain.</p>
|
|
2698
|
+
*/
|
|
2699
|
+
certificateSettings?: CertificateSettings;
|
|
2528
2700
|
}
|
|
2529
2701
|
/**
|
|
2530
2702
|
* @public
|
|
@@ -222,6 +222,16 @@ export interface CreateDeploymentResult {
|
|
|
222
222
|
fileUploadUrls: Record<string, string> | undefined;
|
|
223
223
|
zipUploadUrl: string | undefined;
|
|
224
224
|
}
|
|
225
|
+
export declare const CertificateType: {
|
|
226
|
+
readonly AMPLIFY_MANAGED: "AMPLIFY_MANAGED";
|
|
227
|
+
readonly CUSTOM: "CUSTOM";
|
|
228
|
+
};
|
|
229
|
+
export type CertificateType =
|
|
230
|
+
(typeof CertificateType)[keyof typeof CertificateType];
|
|
231
|
+
export interface CertificateSettings {
|
|
232
|
+
type: CertificateType | undefined;
|
|
233
|
+
customCertificateArn?: string;
|
|
234
|
+
}
|
|
225
235
|
export interface SubDomainSetting {
|
|
226
236
|
prefix: string | undefined;
|
|
227
237
|
branchName: string | undefined;
|
|
@@ -233,11 +243,19 @@ export interface CreateDomainAssociationRequest {
|
|
|
233
243
|
subDomainSettings: SubDomainSetting[] | undefined;
|
|
234
244
|
autoSubDomainCreationPatterns?: string[];
|
|
235
245
|
autoSubDomainIAMRole?: string;
|
|
246
|
+
certificateSettings?: CertificateSettings;
|
|
247
|
+
}
|
|
248
|
+
export interface Certificate {
|
|
249
|
+
type: CertificateType | undefined;
|
|
250
|
+
customCertificateArn?: string;
|
|
251
|
+
certificateVerificationDNSRecord?: string;
|
|
236
252
|
}
|
|
237
253
|
export declare const DomainStatus: {
|
|
238
254
|
readonly AVAILABLE: "AVAILABLE";
|
|
255
|
+
readonly AWAITING_APP_CNAME: "AWAITING_APP_CNAME";
|
|
239
256
|
readonly CREATING: "CREATING";
|
|
240
257
|
readonly FAILED: "FAILED";
|
|
258
|
+
readonly IMPORTING_CUSTOM_CERTIFICATE: "IMPORTING_CUSTOM_CERTIFICATE";
|
|
241
259
|
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
242
260
|
readonly PENDING_DEPLOYMENT: "PENDING_DEPLOYMENT";
|
|
243
261
|
readonly PENDING_VERIFICATION: "PENDING_VERIFICATION";
|
|
@@ -250,6 +268,16 @@ export interface SubDomain {
|
|
|
250
268
|
verified: boolean | undefined;
|
|
251
269
|
dnsRecord: string | undefined;
|
|
252
270
|
}
|
|
271
|
+
export declare const UpdateStatus: {
|
|
272
|
+
readonly AWAITING_APP_CNAME: "AWAITING_APP_CNAME";
|
|
273
|
+
readonly IMPORTING_CUSTOM_CERTIFICATE: "IMPORTING_CUSTOM_CERTIFICATE";
|
|
274
|
+
readonly PENDING_DEPLOYMENT: "PENDING_DEPLOYMENT";
|
|
275
|
+
readonly PENDING_VERIFICATION: "PENDING_VERIFICATION";
|
|
276
|
+
readonly REQUESTING_CERTIFICATE: "REQUESTING_CERTIFICATE";
|
|
277
|
+
readonly UPDATE_COMPLETE: "UPDATE_COMPLETE";
|
|
278
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
279
|
+
};
|
|
280
|
+
export type UpdateStatus = (typeof UpdateStatus)[keyof typeof UpdateStatus];
|
|
253
281
|
export interface DomainAssociation {
|
|
254
282
|
domainAssociationArn: string | undefined;
|
|
255
283
|
domainName: string | undefined;
|
|
@@ -257,9 +285,11 @@ export interface DomainAssociation {
|
|
|
257
285
|
autoSubDomainCreationPatterns?: string[];
|
|
258
286
|
autoSubDomainIAMRole?: string;
|
|
259
287
|
domainStatus: DomainStatus | undefined;
|
|
288
|
+
updateStatus?: UpdateStatus;
|
|
260
289
|
statusReason: string | undefined;
|
|
261
290
|
certificateVerificationDNSRecord?: string;
|
|
262
291
|
subDomains: SubDomain[] | undefined;
|
|
292
|
+
certificate?: Certificate;
|
|
263
293
|
}
|
|
264
294
|
export interface CreateDomainAssociationResult {
|
|
265
295
|
domainAssociation: DomainAssociation | undefined;
|
|
@@ -602,6 +632,7 @@ export interface UpdateDomainAssociationRequest {
|
|
|
602
632
|
subDomainSettings?: SubDomainSetting[];
|
|
603
633
|
autoSubDomainCreationPatterns?: string[];
|
|
604
634
|
autoSubDomainIAMRole?: string;
|
|
635
|
+
certificateSettings?: CertificateSettings;
|
|
605
636
|
}
|
|
606
637
|
export interface UpdateDomainAssociationResult {
|
|
607
638
|
domainAssociation: DomainAssociation | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-amplify",
|
|
3
3
|
"description": "AWS SDK for JavaScript Amplify Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.517.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-amplify",
|