docs(client-datasync): Doc-only update to provide more information on using Kerberos authentication with SMB locations.

Author: awstools

clients/client-datasync/src/models/models_0.ts

@@ -1757,37 +1757,32 @@ export interface CreateLocationSmbRequest {
   DnsIpAddresses?: string[] | undefined;
 
   /**
-   * <p>Specifies a service principal name (SPN), which is an identity in your Kerberos realm that
-   *       has permission to access the files, folders, and file metadata in your SMB file server.</p>
-   *          <p>SPNs are case sensitive and must include a prepended <code>cifs/</code>. For example, an
-   *       SPN might look like <code>cifs/[email protected]</code>.</p>
-   *          <p>Your task execution will fail if the SPN that you provide for this parameter doesn’t match
-   *       what’s exactly in your keytab or <code>krb5.conf</code> files. </p>
+   * <p>Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has
+   *       permission to access the files, folders, and file metadata in your SMB file server.</p>
+   *          <p>A Kerberos principal might look like <code>HOST/[email protected]</code>.</p>
+   *          <p>Principal names are case sensitive. Your DataSync task execution will fail if
+   *       the principal that you specify for this parameter doesn’t exactly match the principal that you
+   *       use to create the keytab file.</p>
    * @public
    */
   KerberosPrincipal?: string | undefined;
 
   /**
    * <p>Specifies your Kerberos key table (keytab) file, which includes mappings between your
-   *       service principal name (SPN) and encryption keys.</p>
-   *          <p>You can specify the keytab using a file path (for example,
-   *         <code>file://path/to/file.keytab</code>). The file must be base64 encoded. If you're using
-   *       the CLI, the encoding is done for you.</p>
-   *          <p>To avoid task execution errors, make sure that the SPN in the keytab file matches exactly
-   *       what you specify for <code>KerberosPrincipal</code> and in your <code>krb5.conf</code> file. </p>
+   *       Kerberos principal and encryption keys.</p>
+   *          <p>The file must be base64 encoded. If you're using the CLI, the encoding is
+   *       done for you.</p>
+   *          <p>To avoid task execution errors, make sure that the Kerberos principal that you use to
+   *       create the keytab file matches exactly what you specify for <code>KerberosPrincipal</code>. </p>
    * @public
    */
   KerberosKeytab?: Uint8Array | undefined;
 
   /**
    * <p>Specifies a Kerberos configuration file (<code>krb5.conf</code>) that defines your
    *       Kerberos realm configuration.</p>
-   *          <p>You can specify the <code>krb5.conf</code> using a file path (for example,
-   *         <code>file://path/to/krb5.conf</code>). The file must be base64 encoded. If you're using the
-   * CLI, the encoding is done for you.</p>
-   *          <p>To avoid task execution errors, make sure that the service principal name (SPN) in the
-   *         <code>krb5.conf</code> file matches exactly what you specify for
-   *         <code>KerberosPrincipal</code> and in your keytab file.</p>
+   *          <p>The file must be base64 encoded. If you're using the CLI, the encoding is
+   *       done for you.</p>
    * @public
    */
   KerberosKrb5Conf?: Uint8Array | undefined;
@@ -3829,8 +3824,8 @@ export interface DescribeLocationSmbResponse {
   DnsIpAddresses?: string[] | undefined;
 
   /**
-   * <p>The Kerberos service principal name (SPN) that has permission to access the files,
-   *       folders, and file metadata in your SMB file server.</p>
+   * <p>The Kerberos principal that has permission to access the files, folders, and file metadata
+   *       in your SMB file server.</p>
    * @public
    */
   KerberosPrincipal?: string | undefined;
@@ -6904,37 +6899,32 @@ export interface UpdateLocationSmbRequest {
   DnsIpAddresses?: string[] | undefined;
 
   /**
-   * <p>Specifies a service principal name (SPN), which is an identity in your Kerberos realm that
-   *       has permission to access the files, folders, and file metadata in your SMB file server.</p>
-   *          <p>SPNs are case sensitive and must include a prepended <code>cifs/</code>. For example, an
-   *       SPN might look like <code>cifs/[email protected]</code>.</p>
-   *          <p>Your task execution will fail if the SPN that you provide for this parameter doesn’t match
-   *       what’s exactly in your keytab or <code>krb5.conf</code> files.</p>
+   * <p>Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has
+   *       permission to access the files, folders, and file metadata in your SMB file server.</p>
+   *          <p>A Kerberos principal might look like <code>HOST/[email protected]</code>.</p>
+   *          <p>Principal names are case sensitive. Your DataSync task execution will fail if
+   *       the principal that you specify for this parameter doesn’t exactly match the principal that you
+   *       use to create the keytab file.</p>
    * @public
    */
   KerberosPrincipal?: string | undefined;
 
   /**
    * <p>Specifies your Kerberos key table (keytab) file, which includes mappings between your
-   *       service principal name (SPN) and encryption keys.</p>
-   *          <p>You can specify the keytab using a file path (for example,
-   *       <code>file://path/to/file.keytab</code>). The file must be base64 encoded. If you're using
-   *       the CLI, the encoding is done for you.</p>
-   *          <p>To avoid task execution errors, make sure that the SPN in the keytab file matches exactly
-   *       what you specify for <code>KerberosPrincipal</code> and in your <code>krb5.conf</code> file.</p>
+   *       Kerberos principal and encryption keys.</p>
+   *          <p>The file must be base64 encoded. If you're using the CLI, the encoding is
+   *       done for you.</p>
+   *          <p>To avoid task execution errors, make sure that the Kerberos principal that you use to
+   *       create the keytab file matches exactly what you specify for <code>KerberosPrincipal</code>.</p>
    * @public
    */
   KerberosKeytab?: Uint8Array | undefined;
 
   /**
    * <p>Specifies a Kerberos configuration file (<code>krb5.conf</code>) that defines your
    *       Kerberos realm configuration.</p>
-   *          <p>You can specify the <code>krb5.conf</code> using a file path (for example,
-   *       <code>file://path/to/krb5.conf</code>). The file must be base64 encoded. If you're using the
-   *       CLI, the encoding is done for you.</p>
-   *          <p>To avoid task execution errors, make sure that the service principal name (SPN) in the
-   *       <code>krb5.conf</code> file matches exactly what you specify for
-   *       <code>KerberosPrincipal</code> and in your keytab file.</p>
+   *          <p>The file must be base64 encoded. If you're using the CLI, the encoding is
+   *       done for you.</p>
    * @public
    */
   KerberosKrb5Conf?: Uint8Array | undefined;

codegen/sdk-codegen/aws-models/datasync.json

@@ -1470,19 +1470,19 @@
         "KerberosPrincipal": {
           "target": "com.amazonaws.datasync#KerberosPrincipal",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies a service principal name (SPN), which is an identity in your Kerberos realm that\n      has permission to access the files, folders, and file metadata in your SMB file server.</p>\n         <p>SPNs are case sensitive and must include a prepended <code>cifs/</code>. For example, an\n      SPN might look like <code>cifs/[email protected]</code>.</p>\n         <p>Your task execution will fail if the SPN that you provide for this parameter doesn’t match\n      what’s exactly in your keytab or <code>krb5.conf</code> files. </p>"
+            "smithy.api#documentation": "<p>Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has\n      permission to access the files, folders, and file metadata in your SMB file server.</p>\n         <p>A Kerberos principal might look like <code>HOST/[email protected]</code>.</p>\n         <p>Principal names are case sensitive. Your DataSync task execution will fail if\n      the principal that you specify for this parameter doesn’t exactly match the principal that you\n      use to create the keytab file.</p>"
           }
         },
         "KerberosKeytab": {
           "target": "com.amazonaws.datasync#KerberosKeytabFile",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies your Kerberos key table (keytab) file, which includes mappings between your\n      service principal name (SPN) and encryption keys.</p>\n         <p>You can specify the keytab using a file path (for example,\n        <code>file://path/to/file.keytab</code>). The file must be base64 encoded. If you're using\n      the CLI, the encoding is done for you.</p>\n         <p>To avoid task execution errors, make sure that the SPN in the keytab file matches exactly\n      what you specify for <code>KerberosPrincipal</code> and in your <code>krb5.conf</code> file. </p>"
+            "smithy.api#documentation": "<p>Specifies your Kerberos key table (keytab) file, which includes mappings between your\n      Kerberos principal and encryption keys.</p>\n         <p>The file must be base64 encoded. If you're using the CLI, the encoding is\n      done for you.</p>\n         <p>To avoid task execution errors, make sure that the Kerberos principal that you use to\n      create the keytab file matches exactly what you specify for <code>KerberosPrincipal</code>. </p>"
           }
         },
         "KerberosKrb5Conf": {
           "target": "com.amazonaws.datasync#KerberosKrb5ConfFile",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies a Kerberos configuration file (<code>krb5.conf</code>) that defines your\n      Kerberos realm configuration.</p>\n         <p>You can specify the <code>krb5.conf</code> using a file path (for example,\n        <code>file://path/to/krb5.conf</code>). The file must be base64 encoded. If you're using the\nCLI, the encoding is done for you.</p>\n         <p>To avoid task execution errors, make sure that the service principal name (SPN) in the\n        <code>krb5.conf</code> file matches exactly what you specify for\n        <code>KerberosPrincipal</code> and in your keytab file.</p>"
+            "smithy.api#documentation": "<p>Specifies a Kerberos configuration file (<code>krb5.conf</code>) that defines your\n      Kerberos realm configuration.</p>\n         <p>The file must be base64 encoded. If you're using the CLI, the encoding is\n      done for you.</p>"
           }
         }
       },
@@ -2868,7 +2868,7 @@
         "KerberosPrincipal": {
           "target": "com.amazonaws.datasync#KerberosPrincipal",
           "traits": {
-            "smithy.api#documentation": "<p>The Kerberos service principal name (SPN) that has permission to access the files,\n      folders, and file metadata in your SMB file server.</p>"
+            "smithy.api#documentation": "<p>The Kerberos principal that has permission to access the files, folders, and file metadata\n      in your SMB file server.</p>"
           }
         },
         "AuthenticationType": {
@@ -10056,19 +10056,19 @@
         "KerberosPrincipal": {
           "target": "com.amazonaws.datasync#KerberosPrincipal",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies a service principal name (SPN), which is an identity in your Kerberos realm that\n      has permission to access the files, folders, and file metadata in your SMB file server.</p>\n         <p>SPNs are case sensitive and must include a prepended <code>cifs/</code>. For example, an\n      SPN might look like <code>cifs/[email protected]</code>.</p>\n         <p>Your task execution will fail if the SPN that you provide for this parameter doesn’t match\n      what’s exactly in your keytab or <code>krb5.conf</code> files.</p>"
+            "smithy.api#documentation": "<p>Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has\n      permission to access the files, folders, and file metadata in your SMB file server.</p>\n         <p>A Kerberos principal might look like <code>HOST/[email protected]</code>.</p>\n         <p>Principal names are case sensitive. Your DataSync task execution will fail if\n      the principal that you specify for this parameter doesn’t exactly match the principal that you\n      use to create the keytab file.</p>"
           }
         },
         "KerberosKeytab": {
           "target": "com.amazonaws.datasync#KerberosKeytabFile",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies your Kerberos key table (keytab) file, which includes mappings between your\n      service principal name (SPN) and encryption keys.</p>\n         <p>You can specify the keytab using a file path (for example,\n      <code>file://path/to/file.keytab</code>). The file must be base64 encoded. If you're using\n      the CLI, the encoding is done for you.</p>\n         <p>To avoid task execution errors, make sure that the SPN in the keytab file matches exactly\n      what you specify for <code>KerberosPrincipal</code> and in your <code>krb5.conf</code> file.</p>"
+            "smithy.api#documentation": "<p>Specifies your Kerberos key table (keytab) file, which includes mappings between your\n      Kerberos principal and encryption keys.</p>\n         <p>The file must be base64 encoded. If you're using the CLI, the encoding is\n      done for you.</p>\n         <p>To avoid task execution errors, make sure that the Kerberos principal that you use to\n      create the keytab file matches exactly what you specify for <code>KerberosPrincipal</code>.</p>"
           }
         },
         "KerberosKrb5Conf": {
           "target": "com.amazonaws.datasync#KerberosKrb5ConfFile",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies a Kerberos configuration file (<code>krb5.conf</code>) that defines your\n      Kerberos realm configuration.</p>\n         <p>You can specify the <code>krb5.conf</code> using a file path (for example,\n      <code>file://path/to/krb5.conf</code>). The file must be base64 encoded. If you're using the\n      CLI, the encoding is done for you.</p>\n         <p>To avoid task execution errors, make sure that the service principal name (SPN) in the\n      <code>krb5.conf</code> file matches exactly what you specify for\n      <code>KerberosPrincipal</code> and in your keytab file.</p>"
+            "smithy.api#documentation": "<p>Specifies a Kerberos configuration file (<code>krb5.conf</code>) that defines your\n      Kerberos realm configuration.</p>\n         <p>The file must be base64 encoded. If you're using the CLI, the encoding is\n      done for you.</p>"
           }
         }
       },