Skip to content

Commit ccb46a4

Browse files
author
AWS
committed
AWS Amplify Update: This release contains API changes that enable users to configure their Amplify domains with their own custom SSL/TLS certificate.
1 parent 9ae82e9 commit ccb46a4

File tree

2 files changed

+91
-8
lines changed

2 files changed

+91
-8
lines changed

‎.changes/next-release/feature-AWSAmplify-edbc6f8.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Amplify",
4+
"contributor": "",
5+
"description": "This release contains API changes that enable users to configure their Amplify domains with their own custom SSL/TLS certificate."
6+
}

‎services/amplify/src/main/resources/codegen-resources/service-2.json

Lines changed: 85 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
{"shape":"LimitExceededException"},
9898
{"shape":"DependentServiceFailureException"}
9999
],
100-
"documentation":"<p> Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app </p>"
100+
"documentation":"<p>Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app </p>"
101101
},
102102
"CreateWebhook":{
103103
"name":"CreateWebhook",
@@ -183,7 +183,7 @@
183183
{"shape":"InternalFailureException"},
184184
{"shape":"DependentServiceFailureException"}
185185
],
186-
"documentation":"<p> Deletes a domain association for an Amplify app. </p>"
186+
"documentation":"<p>Deletes a domain association for an Amplify app. </p>"
187187
},
188188
"DeleteJob":{
189189
"name":"DeleteJob",
@@ -314,7 +314,7 @@
314314
{"shape":"NotFoundException"},
315315
{"shape":"InternalFailureException"}
316316
],
317-
"documentation":"<p> Returns the domain information for an Amplify app. </p>"
317+
"documentation":"<p>Returns the domain information for an Amplify app. </p>"
318318
},
319319
"GetJob":{
320320
"name":"GetJob",
@@ -424,7 +424,7 @@
424424
{"shape":"UnauthorizedException"},
425425
{"shape":"InternalFailureException"}
426426
],
427-
"documentation":"<p> Returns the domain associations for an Amplify app. </p>"
427+
"documentation":"<p>Returns the domain associations for an Amplify app. </p>"
428428
},
429429
"ListJobs":{
430430
"name":"ListJobs",
@@ -602,7 +602,7 @@
602602
{"shape":"InternalFailureException"},
603603
{"shape":"DependentServiceFailureException"}
604604
],
605-
"documentation":"<p> Creates a new domain association for an Amplify app.</p>"
605+
"documentation":"<p>Creates a new domain association for an Amplify app.</p>"
606606
},
607607
"UpdateWebhook":{
608608
"name":"UpdateWebhook",
@@ -1112,6 +1112,53 @@
11121112
"pattern":"(?s).+",
11131113
"sensitive":true
11141114
},
1115+
"Certificate":{
1116+
"type":"structure",
1117+
"required":["type"],
1118+
"members":{
1119+
"type":{
1120+
"shape":"CertificateType",
1121+
"documentation":"<p>The type of SSL/TLS certificate that you want to use.</p> <p>Specify <code>AMPLIFY_MANAGED</code> to use the default certificate that Amplify provisions for you.</p> <p>Specify <code>CUSTOM</code> to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing certificates into Certificate Manager</a> in the <i>ACM User guide</i> .</p>"
1122+
},
1123+
"customCertificateArn":{
1124+
"shape":"CertificateArn",
1125+
"documentation":"<p>The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate Manager in your Amazon Web Services account. </p> <p>This field is required only when the certificate type is <code>CUSTOM</code>.</p>"
1126+
},
1127+
"certificateVerificationDNSRecord":{
1128+
"shape":"CertificateVerificationDNSRecord",
1129+
"documentation":"<p>The DNS record for certificate verification.</p>"
1130+
}
1131+
},
1132+
"documentation":"<p>Describes the current SSL/TLS certificate that is in use for the domain. If you are using <code>CreateDomainAssociation</code> to create a new domain association, <code>Certificate</code> describes the new certificate that you are creating.</p>"
1133+
},
1134+
"CertificateArn":{
1135+
"type":"string",
1136+
"max":1000,
1137+
"min":0,
1138+
"pattern":"^arn:aws:acm:[a-z0-9-]+:\\d{12}:certificate\\/.+$"
1139+
},
1140+
"CertificateSettings":{
1141+
"type":"structure",
1142+
"required":["type"],
1143+
"members":{
1144+
"type":{
1145+
"shape":"CertificateType",
1146+
"documentation":"<p>The certificate type.</p> <p>Specify <code>AMPLIFY_MANAGED</code> to use the default certificate that Amplify provisions for you.</p> <p>Specify <code>CUSTOM</code> to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing certificates into Certificate Manager</a> in the <i>ACM User guide</i>.</p>"
1147+
},
1148+
"customCertificateArn":{
1149+
"shape":"CertificateArn",
1150+
"documentation":"<p>The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.</p> <p>This field is required only when the certificate type is <code>CUSTOM</code>.</p>"
1151+
}
1152+
},
1153+
"documentation":"<p>The type of SSL/TLS certificate to use for your custom domain. If a certificate type isn't specified, Amplify uses the default <code>AMPLIFY_MANAGED</code> certificate.</p>"
1154+
},
1155+
"CertificateType":{
1156+
"type":"string",
1157+
"enum":[
1158+
"AMPLIFY_MANAGED",
1159+
"CUSTOM"
1160+
]
1161+
},
11151162
"CertificateVerificationDNSRecord":{
11161163
"type":"string",
11171164
"max":1000
@@ -1444,6 +1491,10 @@
14441491
"autoSubDomainIAMRole":{
14451492
"shape":"AutoSubDomainIAMRole",
14461493
"documentation":"<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>"
1494+
},
1495+
"certificateSettings":{
1496+
"shape":"CertificateSettings",
1497+
"documentation":"<p>The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.</p>"
14471498
}
14481499
},
14491500
"documentation":"<p> The request structure for the create domain association request. </p>"
@@ -1527,7 +1578,7 @@
15271578
},
15281579
"status":{
15291580
"shape":"Status",
1530-
"documentation":"<p>The status code for a URL rewrite or redirect rule. </p> <dl> <dt>200</dt> <dd> <p>Represents a 200 rewrite rule.</p> </dd> <dt>301</dt> <dd> <p>Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL. </p> </dd> <dt>302</dt> <dd> <p>Represents a 302 temporary redirect rule.</p> </dd> <dt>404</dt> <dd> <p>Represents a 404 redirect rule.</p> </dd> <dt>404-200</dt> <dd> <p>Represents a 404 rewrite rule.</p> </dd> </dl>"
1581+
"documentation":"<p>The status code for a URL rewrite or redirect rule. </p> <dl> <dt>200</dt> <dd> <p>Represents a 200 rewrite rule.</p> </dd> <dt>301</dt> <dd> <p>Represents a 301 (moved permanently) redirect rule. This and all future requests should be directed to the target URL. </p> </dd> <dt>302</dt> <dd> <p>Represents a 302 temporary redirect rule.</p> </dd> <dt>404</dt> <dd> <p>Represents a 404 redirect rule.</p> </dd> <dt>404-200</dt> <dd> <p>Represents a 404 rewrite rule.</p> </dd> </dl>"
15311582
},
15321583
"condition":{
15331584
"shape":"Condition",
@@ -1786,9 +1837,13 @@
17861837
"shape":"DomainStatus",
17871838
"documentation":"<p> The current status of the domain association. </p>"
17881839
},
1840+
"updateStatus":{
1841+
"shape":"UpdateStatus",
1842+
"documentation":"<p>The status of the domain update operation that is currently in progress. The following list describes the valid update states.</p> <dl> <dt>REQUESTING_CERTIFICATE</dt> <dd> <p>The certificate is in the process of being updated.</p> </dd> <dt>PENDING_VERIFICATION</dt> <dd> <p>Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.</p> </dd> <dt>IMPORTING_CUSTOM_CERTIFICATE</dt> <dd> <p>Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.</p> </dd> <dt>PENDING_DEPLOYMENT</dt> <dd> <p>Indicates that the subdomain or certificate changes are being propagated.</p> </dd> <dt>AWAITING_APP_CNAME</dt> <dd> <p>Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html\">Setting up custom domains</a> in the <i>Amplify Hosting User Guide</i>. </p> </dd> <dt>UPDATE_COMPLETE</dt> <dd> <p>The certificate has been associated with a domain.</p> </dd> <dt>UPDATE_FAILED</dt> <dd> <p>The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.</p> </dd> </dl>"
1843+
},
17891844
"statusReason":{
17901845
"shape":"StatusReason",
1791-
"documentation":"<p> The reason for the current status of the domain association. </p>"
1846+
"documentation":"<p> Additional information that describes why the domain association is in the current state.</p>"
17921847
},
17931848
"certificateVerificationDNSRecord":{
17941849
"shape":"CertificateVerificationDNSRecord",
@@ -1797,9 +1852,13 @@
17971852
"subDomains":{
17981853
"shape":"SubDomains",
17991854
"documentation":"<p> The subdomains for the domain association. </p>"
1855+
},
1856+
"certificate":{
1857+
"shape":"Certificate",
1858+
"documentation":"<p>Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.</p> <p>If you are updating your domain to use a different certificate, <code>certificate</code> points to the new certificate that is being created instead of the current active certificate. Otherwise, <code>certificate</code> points to the current active certificate.</p>"
18001859
}
18011860
},
1802-
"documentation":"<p> Describes a domain association that associates a custom domain with an Amplify app. </p>"
1861+
"documentation":"<p>Describes the association between a custom domain and an Amplify app. </p>"
18031862
},
18041863
"DomainAssociationArn":{
18051864
"type":"string",
@@ -1826,7 +1885,9 @@
18261885
"PENDING_VERIFICATION",
18271886
"IN_PROGRESS",
18281887
"AVAILABLE",
1888+
"IMPORTING_CUSTOM_CERTIFICATE",
18291889
"PENDING_DEPLOYMENT",
1890+
"AWAITING_APP_CNAME",
18301891
"FAILED",
18311892
"CREATING",
18321893
"REQUESTING_CERTIFICATE",
@@ -3354,6 +3415,10 @@
33543415
"autoSubDomainIAMRole":{
33553416
"shape":"AutoSubDomainIAMRole",
33563417
"documentation":"<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>"
3418+
},
3419+
"certificateSettings":{
3420+
"shape":"CertificateSettings",
3421+
"documentation":"<p>The type of SSL/TLS certificate to use for your custom domain.</p>"
33573422
}
33583423
},
33593424
"documentation":"<p> The request structure for the update domain association request. </p>"
@@ -3369,6 +3434,18 @@
33693434
},
33703435
"documentation":"<p> The result structure for the update domain association request. </p>"
33713436
},
3437+
"UpdateStatus":{
3438+
"type":"string",
3439+
"enum":[
3440+
"REQUESTING_CERTIFICATE",
3441+
"PENDING_VERIFICATION",
3442+
"IMPORTING_CUSTOM_CERTIFICATE",
3443+
"PENDING_DEPLOYMENT",
3444+
"AWAITING_APP_CNAME",
3445+
"UPDATE_COMPLETE",
3446+
"UPDATE_FAILED"
3447+
]
3448+
},
33723449
"UpdateTime":{"type":"timestamp"},
33733450
"UpdateWebhookRequest":{
33743451
"type":"structure",

0 commit comments

Comments
 (0)