docs(client-datasync): Updated guidance on using private or self-signed certificate authorities (CAs) with AWS DataSync object storage locations.

awstools · awstools · commit c4eb11d1cc87 · 2024-05-03T18:19:47.000Z
diff --git a/clients/client-datasync/src/commands/UpdateLocationObjectStorageCommand.ts b/clients/client-datasync/src/commands/UpdateLocationObjectStorageCommand.ts
@@ -33,10 +33,8 @@ export interface UpdateLocationObjectStorageCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Updates some parameters of an existing object storage location that DataSync
- *       accesses for a transfer. For information about creating a self-managed object storage
- *       location, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object
- *         storage</a>.</p>
+ * <p>Updates some parameters of an existing DataSync location for an object
+ *       storage system.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-datasync/src/models/models_0.ts b/clients/client-datasync/src/models/models_0.ts
@@ -1470,24 +1470,29 @@ export interface CreateLocationObjectStorageRequest {
   Tags?: TagListEntry[];
 
   /**
-   * <p>Specifies a file with the certificates that are used to sign the object storage server's
-   *       certificate (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>).
-   *       The file you specify must include the following:</p>
+   * <p>Specifies a certificate chain for DataSync to authenticate with your object
+   *       storage system if the system uses a private or self-signed certificate authority (CA). You
+   *       must specify a single <code>.pem</code> file with a full certificate chain (for example,
+   *         <code>file:///home/user/.ssh/object_storage_certificates.pem</code>).</p>
+   *          <p>The certificate chain might include:</p>
    *          <ul>
    *             <li>
-   *                <p>The certificate of the signing certificate authority (CA)</p>
+   *                <p>The object storage system's certificate</p>
    *             </li>
    *             <li>
-   *                <p>Any intermediate certificates</p>
+   *                <p>All intermediate certificates (if there are any)</p>
    *             </li>
    *             <li>
-   *                <p>base64 encoding</p>
-   *             </li>
-   *             <li>
-   *                <p>A <code>.pem</code> extension</p>
+   *                <p>The root certificate of the signing CA</p>
    *             </li>
    *          </ul>
-   *          <p>The file can be up to 32768 bytes (before base64 encoding).</p>
+   *          <p>You can concatenate your certificates into a <code>.pem</code> file (which can be up to
+   *       32768 bytes before base64 encoding). The following example <code>cat</code> command creates an
+   *         <code>object_storage_certificates.pem</code> file that includes three certificates:</p>
+   *          <p>
+   *             <code>cat object_server_certificate.pem intermediate_certificate.pem
+   *         ca_root_certificate.pem > object_storage_certificates.pem</code>
+   *          </p>
    *          <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>
    * @public
    */
@@ -2440,8 +2445,9 @@ export interface TaskSchedule {
 
   /**
    * <p>Specifies whether to enable or disable your task schedule. Your schedule is enabled by
-   *       default, but there can be situations where you need to disable it. For example,
-   *       you might need to pause a recurring transfer or fix an issue with your task or perform maintenance on your storage system.</p>
+   *       default, but there can be situations where you need to disable it. For example, you might need
+   *       to pause a recurring transfer to fix an issue with your task or perform maintenance on your
+   *       storage system.</p>
    *          <p>DataSync might disable your schedule automatically if your task fails repeatedly
    *       with the same error. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html">TaskScheduleDetails</a>.</p>
    * @public
@@ -3529,8 +3535,8 @@ export interface DescribeLocationObjectStorageResponse {
   CreationTime?: Date;
 
   /**
-   * <p>The self-signed certificate that DataSync uses to securely authenticate with
-   *       your object storage system.</p>
+   * <p>The certificate chain for DataSync to authenticate with your object storage
+   *       system if the system uses a private or self-signed certificate authority (CA).</p>
    * @public
    */
   ServerCertificate?: Uint8Array;
@@ -6122,12 +6128,31 @@ export interface UpdateLocationObjectStorageRequest {
   AgentArns?: string[];
 
   /**
-   * <p>Specifies a certificate to authenticate with an object storage system that uses a private
-   *       or self-signed certificate authority (CA). You must specify a Base64-encoded <code>.pem</code>
-   *       file (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The
-   *       certificate can be up to 32768 bytes (before Base64 encoding).</p>
+   * <p>Specifies a certificate chain for DataSync to authenticate with your object
+   *       storage system if the system uses a private or self-signed certificate authority (CA). You
+   *       must specify a single <code>.pem</code> file with a full certificate chain (for example,
+   *         <code>file:///home/user/.ssh/object_storage_certificates.pem</code>).</p>
+   *          <p>The certificate chain might include:</p>
+   *          <ul>
+   *             <li>
+   *                <p>The object storage system's certificate</p>
+   *             </li>
+   *             <li>
+   *                <p>All intermediate certificates (if there are any)</p>
+   *             </li>
+   *             <li>
+   *                <p>The root certificate of the signing CA</p>
+   *             </li>
+   *          </ul>
+   *          <p>You can concatenate your certificates into a <code>.pem</code> file (which can be up to
+   *       32768 bytes before base64 encoding). The following example <code>cat</code> command creates an
+   *         <code>object_storage_certificates.pem</code> file that includes three certificates:</p>
+   *          <p>
+   *             <code>cat object_server_certificate.pem intermediate_certificate.pem
+   *       ca_root_certificate.pem > object_storage_certificates.pem</code>
+   *          </p>
    *          <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>
-   *          <p>Updating the certificate doesn't interfere with tasks that you have in progress.</p>
+   *          <p>Updating this parameter doesn't interfere with tasks that you have in progress.</p>
    * @public
    */
   ServerCertificate?: Uint8Array;
diff --git a/codegen/sdk-codegen/aws-models/datasync.json b/codegen/sdk-codegen/aws-models/datasync.json
@@ -1276,7 +1276,7 @@
         "ServerCertificate": {
           "target": "com.amazonaws.datasync#ObjectStorageCertificate",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies a file with the certificates that are used to sign the object storage server's\n      certificate (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>).\n      The file you specify must include the following:</p>\n         <ul>\n            <li>\n               <p>The certificate of the signing certificate authority (CA)</p>\n            </li>\n            <li>\n               <p>Any intermediate certificates</p>\n            </li>\n            <li>\n               <p>base64 encoding</p>\n            </li>\n            <li>\n               <p>A <code>.pem</code> extension</p>\n            </li>\n         </ul>\n         <p>The file can be up to 32768 bytes (before base64 encoding).</p>\n         <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>"
+            "smithy.api#documentation": "<p>Specifies a certificate chain for DataSync to authenticate with your object\n      storage system if the system uses a private or self-signed certificate authority (CA). You\n      must specify a single <code>.pem</code> file with a full certificate chain (for example,\n        <code>file:///home/user/.ssh/object_storage_certificates.pem</code>).</p>\n         <p>The certificate chain might include:</p>\n         <ul>\n            <li>\n               <p>The object storage system's certificate</p>\n            </li>\n            <li>\n               <p>All intermediate certificates (if there are any)</p>\n            </li>\n            <li>\n               <p>The root certificate of the signing CA</p>\n            </li>\n         </ul>\n         <p>You can concatenate your certificates into a <code>.pem</code> file (which can be up to\n      32768 bytes before base64 encoding). The following example <code>cat</code> command creates an\n        <code>object_storage_certificates.pem</code> file that includes three certificates:</p>\n         <p>\n            <code>cat object_server_certificate.pem intermediate_certificate.pem\n        ca_root_certificate.pem > object_storage_certificates.pem</code>\n         </p>\n         <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>"
           }
         }
       },
@@ -2657,7 +2657,7 @@
         "ServerCertificate": {
           "target": "com.amazonaws.datasync#ObjectStorageCertificate",
           "traits": {
-            "smithy.api#documentation": "<p>The self-signed certificate that DataSync uses to securely authenticate with\n      your object storage system.</p>"
+            "smithy.api#documentation": "<p>The certificate chain for DataSync to authenticate with your object storage\n      system if the system uses a private or self-signed certificate authority (CA).</p>"
           }
         }
       },
@@ -8723,7 +8723,7 @@
         "Status": {
           "target": "com.amazonaws.datasync#ScheduleStatus",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies whether to enable or disable your task schedule. Your schedule is enabled by\n      default, but there can be situations where you need to disable it. For example,\n      you might need to pause a recurring transfer or fix an issue with your task or perform maintenance on your storage system.</p>\n         <p>DataSync might disable your schedule automatically if your task fails repeatedly\n      with the same error. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html\">TaskScheduleDetails</a>.</p>"
+            "smithy.api#documentation": "<p>Specifies whether to enable or disable your task schedule. Your schedule is enabled by\n      default, but there can be situations where you need to disable it. For example, you might need\n      to pause a recurring transfer to fix an issue with your task or perform maintenance on your\n      storage system.</p>\n         <p>DataSync might disable your schedule automatically if your task fails repeatedly\n      with the same error. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html\">TaskScheduleDetails</a>.</p>"
           }
         }
       },
@@ -9290,7 +9290,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Updates some parameters of an existing object storage location that DataSync\n      accesses for a transfer. For information about creating a self-managed object storage\n      location, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html\">Creating a location for object\n        storage</a>.</p>"
+        "smithy.api#documentation": "<p>Updates some parameters of an existing DataSync location for an object\n      storage system.</p>"
       }
     },
     "com.amazonaws.datasync#UpdateLocationObjectStorageRequest": {
@@ -9342,7 +9342,7 @@
         "ServerCertificate": {
           "target": "com.amazonaws.datasync#ObjectStorageCertificate",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies a certificate to authenticate with an object storage system that uses a private\n      or self-signed certificate authority (CA). You must specify a Base64-encoded <code>.pem</code>\n      file (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The\n      certificate can be up to 32768 bytes (before Base64 encoding).</p>\n         <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>\n         <p>Updating the certificate doesn't interfere with tasks that you have in progress.</p>"
+            "smithy.api#documentation": "<p>Specifies a certificate chain for DataSync to authenticate with your object\n      storage system if the system uses a private or self-signed certificate authority (CA). You\n      must specify a single <code>.pem</code> file with a full certificate chain (for example,\n        <code>file:///home/user/.ssh/object_storage_certificates.pem</code>).</p>\n         <p>The certificate chain might include:</p>\n         <ul>\n            <li>\n               <p>The object storage system's certificate</p>\n            </li>\n            <li>\n               <p>All intermediate certificates (if there are any)</p>\n            </li>\n            <li>\n               <p>The root certificate of the signing CA</p>\n            </li>\n         </ul>\n         <p>You can concatenate your certificates into a <code>.pem</code> file (which can be up to\n      32768 bytes before base64 encoding). The following example <code>cat</code> command creates an\n        <code>object_storage_certificates.pem</code> file that includes three certificates:</p>\n         <p>\n            <code>cat object_server_certificate.pem intermediate_certificate.pem\n      ca_root_certificate.pem > object_storage_certificates.pem</code>\n         </p>\n         <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>\n         <p>Updating this parameter doesn't interfere with tasks that you have in progress.</p>"
           }
         }
       },

Original file line number	Diff line number	Diff line change
`@@ -1276,7 +1276,7 @@`
`1276`	`1276`	`"ServerCertificate": {`
`1277`	`1277`	`"target": "com.amazonaws.datasync#ObjectStorageCertificate",`
`1278`	`1278`	`"traits": {`
`1279`		- "smithy.api#documentation": "<p>Specifies a file with the certificates that are used to sign the object storage server's\n certificate (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>).\n The file you specify must include the following:</p>\n <ul>\n <li>\n <p>The certificate of the signing certificate authority (CA)</p>\n </li>\n <li>\n <p>Any intermediate certificates</p>\n </li>\n <li>\n <p>base64 encoding</p>\n </li>\n <li>\n <p>A <code>.pem</code> extension</p>\n </li>\n </ul>\n <p>The file can be up to 32768 bytes (before base64 encoding).</p>\n <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>"
	`1279`	+ "smithy.api#documentation": "<p>Specifies a certificate chain for DataSync to authenticate with your object\n storage system if the system uses a private or self-signed certificate authority (CA). You\n must specify a single <code>.pem</code> file with a full certificate chain (for example,\n <code>file:///home/user/.ssh/object_storage_certificates.pem</code>).</p>\n <p>The certificate chain might include:</p>\n <ul>\n <li>\n <p>The object storage system's certificate</p>\n </li>\n <li>\n <p>All intermediate certificates (if there are any)</p>\n </li>\n <li>\n <p>The root certificate of the signing CA</p>\n </li>\n </ul>\n <p>You can concatenate your certificates into a <code>.pem</code> file (which can be up to\n 32768 bytes before base64 encoding). The following example <code>cat</code> command creates an\n <code>object_storage_certificates.pem</code> file that includes three certificates:</p>\n <p>\n <code>cat object_server_certificate.pem intermediate_certificate.pem\n ca_root_certificate.pem > object_storage_certificates.pem</code>\n </p>\n <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>"
`1280`	`1280`	`}`
`1281`	`1281`	`}`
`1282`	`1282`	`},`
`@@ -2657,7 +2657,7 @@`
`2657`	`2657`	`"ServerCertificate": {`
`2658`	`2658`	`"target": "com.amazonaws.datasync#ObjectStorageCertificate",`
`2659`	`2659`	`"traits": {`
`2660`		`- "smithy.api#documentation": "<p>The self-signed certificate that DataSync uses to securely authenticate with\n your object storage system.</p>"`
	`2660`	`+ "smithy.api#documentation": "<p>The certificate chain for DataSync to authenticate with your object storage\n system if the system uses a private or self-signed certificate authority (CA).</p>"`
`2661`	`2661`	`}`
`2662`	`2662`	`}`
`2663`	`2663`	`},`
`@@ -8723,7 +8723,7 @@`
`8723`	`8723`	`"Status": {`
`8724`	`8724`	`"target": "com.amazonaws.datasync#ScheduleStatus",`
`8725`	`8725`	`"traits": {`
`8726`		- "smithy.api#documentation": "<p>Specifies whether to enable or disable your task schedule. Your schedule is enabled by\n default, but there can be situations where you need to disable it. For example,\n you might need to pause a recurring transfer or fix an issue with your task or perform maintenance on your storage system.</p>\n <p>DataSync might disable your schedule automatically if your task fails repeatedly\n with the same error. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html\">TaskScheduleDetails</a>.</p>"
	`8726`	+ "smithy.api#documentation": "<p>Specifies whether to enable or disable your task schedule. Your schedule is enabled by\n default, but there can be situations where you need to disable it. For example, you might need\n to pause a recurring transfer to fix an issue with your task or perform maintenance on your\n storage system.</p>\n <p>DataSync might disable your schedule automatically if your task fails repeatedly\n with the same error. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html\">TaskScheduleDetails</a>.</p>"
`8727`	`8727`	`}`
`8728`	`8728`	`}`
`8729`	`8729`	`},`
`@@ -9290,7 +9290,7 @@`
`9290`	`9290`	`}`
`9291`	`9291`	`],`
`9292`	`9292`	`"traits": {`
`9293`		`- "smithy.api#documentation": "<p>Updates some parameters of an existing object storage location that DataSync\n accesses for a transfer. For information about creating a self-managed object storage\n location, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html\">Creating a location for object\n storage</a>.</p>"`
	`9293`	`+ "smithy.api#documentation": "<p>Updates some parameters of an existing DataSync location for an object\n storage system.</p>"`
`9294`	`9294`	`}`
`9295`	`9295`	`},`
`9296`	`9296`	`"com.amazonaws.datasync#UpdateLocationObjectStorageRequest": {`
`@@ -9342,7 +9342,7 @@`
`9342`	`9342`	`"ServerCertificate": {`
`9343`	`9343`	`"target": "com.amazonaws.datasync#ObjectStorageCertificate",`
`9344`	`9344`	`"traits": {`
`9345`		- "smithy.api#documentation": "<p>Specifies a certificate to authenticate with an object storage system that uses a private\n or self-signed certificate authority (CA). You must specify a Base64-encoded <code>.pem</code>\n file (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The\n certificate can be up to 32768 bytes (before Base64 encoding).</p>\n <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>\n <p>Updating the certificate doesn't interfere with tasks that you have in progress.</p>"
	`9345`	+ "smithy.api#documentation": "<p>Specifies a certificate chain for DataSync to authenticate with your object\n storage system if the system uses a private or self-signed certificate authority (CA). You\n must specify a single <code>.pem</code> file with a full certificate chain (for example,\n <code>file:///home/user/.ssh/object_storage_certificates.pem</code>).</p>\n <p>The certificate chain might include:</p>\n <ul>\n <li>\n <p>The object storage system's certificate</p>\n </li>\n <li>\n <p>All intermediate certificates (if there are any)</p>\n </li>\n <li>\n <p>The root certificate of the signing CA</p>\n </li>\n </ul>\n <p>You can concatenate your certificates into a <code>.pem</code> file (which can be up to\n 32768 bytes before base64 encoding). The following example <code>cat</code> command creates an\n <code>object_storage_certificates.pem</code> file that includes three certificates:</p>\n <p>\n <code>cat object_server_certificate.pem intermediate_certificate.pem\n ca_root_certificate.pem > object_storage_certificates.pem</code>\n </p>\n <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>\n <p>Updating this parameter doesn't interfere with tasks that you have in progress.</p>"
`9346`	`9346`	`}`
`9347`	`9347`	`}`
`9348`	`9348`	`},`