Skip to content

Commit fdaf7bc

Browse files
author
awstools
committed
feat(client-datasync): AWS DataSync now supports modifying ServerHostname while updating locations SMB, NFS, and ObjectStorage.
1 parent 0c829af commit fdaf7bc

File tree

6 files changed

+67
-13
lines changed

6 files changed

+67
-13
lines changed

‎clients/client-datasync/src/commands/UpdateLocationNfsCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ export interface UpdateLocationNfsCommandOutput extends UpdateLocationNfsRespons
4040
* const input = { // UpdateLocationNfsRequest
4141
* LocationArn: "STRING_VALUE", // required
4242
* Subdirectory: "STRING_VALUE",
43+
* ServerHostname: "STRING_VALUE",
4344
* OnPremConfig: { // OnPremConfig
4445
* AgentArns: [ // AgentArnList // required
4546
* "STRING_VALUE",

‎clients/client-datasync/src/commands/UpdateLocationObjectStorageCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ export interface UpdateLocationObjectStorageCommandOutput
4747
* ServerPort: Number("int"),
4848
* ServerProtocol: "HTTPS" || "HTTP",
4949
* Subdirectory: "STRING_VALUE",
50+
* ServerHostname: "STRING_VALUE",
5051
* AccessKey: "STRING_VALUE",
5152
* SecretKey: "STRING_VALUE",
5253
* AgentArns: [ // AgentArnList

‎clients/client-datasync/src/commands/UpdateLocationSmbCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export interface UpdateLocationSmbCommandOutput extends UpdateLocationSmbRespons
4444
* const input = { // UpdateLocationSmbRequest
4545
* LocationArn: "STRING_VALUE", // required
4646
* Subdirectory: "STRING_VALUE",
47+
* ServerHostname: "STRING_VALUE",
4748
* User: "STRING_VALUE",
4849
* Domain: "STRING_VALUE",
4950
* Password: "STRING_VALUE",

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

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1347,7 +1347,7 @@ export interface CreateLocationNfsRequest {
13471347
Subdirectory: string | undefined;
13481348

13491349
/**
1350-
* <p>Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS file
1350+
* <p>Specifies the DNS name or IP version 4 address of the NFS file
13511351
* server that your DataSync agent connects to.</p>
13521352
* @public
13531353
*/
@@ -1410,8 +1410,8 @@ export type ObjectStorageServerProtocol =
14101410
*/
14111411
export interface CreateLocationObjectStorageRequest {
14121412
/**
1413-
* <p>Specifies the domain name or IP address of the object storage server. A DataSync
1414-
* agent uses this hostname to mount the object storage server in a network.</p>
1413+
* <p>Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync
1414+
* agent connects to.</p>
14151415
* @public
14161416
*/
14171417
ServerHostname: string | undefined;
@@ -1676,7 +1676,7 @@ export interface CreateLocationSmbRequest {
16761676
Subdirectory: string | undefined;
16771677

16781678
/**
1679-
* <p>Specifies the domain name or IP address of the SMB file server that your DataSync agent will mount.</p>
1679+
* <p>Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to.</p>
16801680
* <p>Remember the following when configuring this parameter:</p>
16811681
* <ul>
16821682
* <li>
@@ -1742,6 +1742,7 @@ export interface CreateLocationSmbRequest {
17421742
* <p>Specifies the authentication protocol that DataSync uses to connect to your SMB
17431743
* file server. DataSync supports <code>NTLM</code> (default) and <code>KERBEROS</code>
17441744
* authentication.</p>
1745+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">Providing DataSync access to SMB file servers</a>.</p>
17451746
* @public
17461747
*/
17471748
AuthenticationType?: SmbAuthenticationType | undefined;
@@ -1759,7 +1760,7 @@ export interface CreateLocationSmbRequest {
17591760
/**
17601761
* <p>Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has
17611762
* permission to access the files, folders, and file metadata in your SMB file server.</p>
1762-
* <p>A Kerberos principal might look like <code>HOST/kerberosuser@EXAMPLE.COM</code>.</p>
1763+
* <p>A Kerberos principal might look like <code>HOST/kerberosuser@MYDOMAIN.ORG</code>.</p>
17631764
* <p>Principal names are case sensitive. Your DataSync task execution will fail if
17641765
* the principal that you specify for this parameter doesn’t exactly match the principal that you
17651766
* use to create the keytab file.</p>
@@ -6644,6 +6645,13 @@ export interface UpdateLocationNfsRequest {
66446645
*/
66456646
Subdirectory?: string | undefined;
66466647

6648+
/**
6649+
* <p>Specifies the DNS name or IP version 4 (IPv4) address of the NFS file
6650+
* server that your DataSync agent connects to.</p>
6651+
* @public
6652+
*/
6653+
ServerHostname?: string | undefined;
6654+
66476655
/**
66486656
* <p>The DataSync agents that can connect to your Network File System (NFS)
66496657
* file server.</p>
@@ -6694,6 +6702,13 @@ export interface UpdateLocationObjectStorageRequest {
66946702
*/
66956703
Subdirectory?: string | undefined;
66966704

6705+
/**
6706+
* <p>Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync
6707+
* agent connects to.</p>
6708+
* @public
6709+
*/
6710+
ServerHostname?: string | undefined;
6711+
66976712
/**
66986713
* <p>Specifies the access key (for example, a user name) if credentials are required to
66996714
* authenticate with the object storage server.</p>
@@ -6841,6 +6856,21 @@ export interface UpdateLocationSmbRequest {
68416856
*/
68426857
Subdirectory?: string | undefined;
68436858

6859+
/**
6860+
* <p>Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to.</p>
6861+
* <p>Remember the following when configuring this parameter:</p>
6862+
* <ul>
6863+
* <li>
6864+
* <p>You can't specify an IP version 6 (IPv6) address.</p>
6865+
* </li>
6866+
* <li>
6867+
* <p>If you're using Kerberos authentication, you must specify a domain name.</p>
6868+
* </li>
6869+
* </ul>
6870+
* @public
6871+
*/
6872+
ServerHostname?: string | undefined;
6873+
68446874
/**
68456875
* <p>Specifies the user name that can mount your SMB file server and has permission to access
68466876
* the files and folders involved in your transfer. This parameter applies only if
@@ -6884,6 +6914,7 @@ export interface UpdateLocationSmbRequest {
68846914
* <p>Specifies the authentication protocol that DataSync uses to connect to your SMB
68856915
* file server. DataSync supports <code>NTLM</code> (default) and <code>KERBEROS</code>
68866916
* authentication.</p>
6917+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">Providing DataSync access to SMB file servers</a>.</p>
68876918
* @public
68886919
*/
68896920
AuthenticationType?: SmbAuthenticationType | undefined;
@@ -6901,7 +6932,7 @@ export interface UpdateLocationSmbRequest {
69016932
/**
69026933
* <p>Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has
69036934
* permission to access the files, folders, and file metadata in your SMB file server.</p>
6904-
* <p>A Kerberos principal might look like <code>HOST/kerberosuser@EXAMPLE.COM</code>.</p>
6935+
* <p>A Kerberos principal might look like <code>HOST/kerberosuser@MYDOMAIN.ORG</code>.</p>
69056936
* <p>Principal names are case sensitive. Your DataSync task execution will fail if
69066937
* the principal that you specify for this parameter doesn’t exactly match the principal that you
69076938
* use to create the keytab file.</p>

‎clients/client-datasync/src/protocols/Aws_json1_1.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2987,6 +2987,7 @@ const se_UpdateLocationObjectStorageRequest = (
29872987
LocationArn: [],
29882988
SecretKey: [],
29892989
ServerCertificate: context.base64Encoder,
2990+
ServerHostname: [],
29902991
ServerPort: [],
29912992
ServerProtocol: [],
29922993
Subdirectory: [],
@@ -3010,6 +3011,7 @@ const se_UpdateLocationSmbRequest = (input: UpdateLocationSmbRequest, context: _
30103011
LocationArn: [],
30113012
MountOptions: _json,
30123013
Password: [],
3014+
ServerHostname: [],
30133015
Subdirectory: [],
30143016
User: [],
30153017
});

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

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1149,7 +1149,7 @@
11491149
"ServerHostname": {
11501150
"target": "com.amazonaws.datasync#ServerHostname",
11511151
"traits": {
1152-
"smithy.api#documentation": "<p>Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS file\n server that your DataSync agent connects to.</p>",
1152+
"smithy.api#documentation": "<p>Specifies the DNS name or IP version 4 address of the NFS file\n server that your DataSync agent connects to.</p>",
11531153
"smithy.api#required": {}
11541154
}
11551155
},
@@ -1219,7 +1219,7 @@
12191219
"ServerHostname": {
12201220
"target": "com.amazonaws.datasync#ServerHostname",
12211221
"traits": {
1222-
"smithy.api#documentation": "<p>Specifies the domain name or IP address of the object storage server. A DataSync\n agent uses this hostname to mount the object storage server in a network.</p>",
1222+
"smithy.api#documentation": "<p>Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync\n agent connects to.</p>",
12231223
"smithy.api#required": {}
12241224
}
12251225
},
@@ -1414,7 +1414,7 @@
14141414
"ServerHostname": {
14151415
"target": "com.amazonaws.datasync#ServerHostname",
14161416
"traits": {
1417-
"smithy.api#documentation": "<p>Specifies the domain name or IP address of the SMB file server that your DataSync agent will mount.</p>\n <p>Remember the following when configuring this parameter:</p>\n <ul>\n <li>\n <p>You can't specify an IP version 6 (IPv6) address.</p>\n </li>\n <li>\n <p>If you're using Kerberos authentication, you must specify a domain name.</p>\n </li>\n </ul>",
1417+
"smithy.api#documentation": "<p>Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to.</p>\n <p>Remember the following when configuring this parameter:</p>\n <ul>\n <li>\n <p>You can't specify an IP version 6 (IPv6) address.</p>\n </li>\n <li>\n <p>If you're using Kerberos authentication, you must specify a domain name.</p>\n </li>\n </ul>",
14181418
"smithy.api#required": {}
14191419
}
14201420
},
@@ -1458,7 +1458,7 @@
14581458
"AuthenticationType": {
14591459
"target": "com.amazonaws.datasync#SmbAuthenticationType",
14601460
"traits": {
1461-
"smithy.api#documentation": "<p>Specifies the authentication protocol that DataSync uses to connect to your SMB\n file server. DataSync supports <code>NTLM</code> (default) and <code>KERBEROS</code>\n authentication.</p>"
1461+
"smithy.api#documentation": "<p>Specifies the authentication protocol that DataSync uses to connect to your SMB\n file server. DataSync supports <code>NTLM</code> (default) and <code>KERBEROS</code>\n authentication.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">Providing DataSync access to SMB file servers</a>.</p>"
14621462
}
14631463
},
14641464
"DnsIpAddresses": {
@@ -1470,7 +1470,7 @@
14701470
"KerberosPrincipal": {
14711471
"target": "com.amazonaws.datasync#KerberosPrincipal",
14721472
"traits": {
1473-
"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/kerberosuser@EXAMPLE.COM</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>"
1473+
"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/kerberosuser@MYDOMAIN.ORG</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>"
14741474
}
14751475
},
14761476
"KerberosKeytab": {
@@ -9819,6 +9819,12 @@
98199819
"smithy.api#documentation": "<p>Specifies the export path in your NFS file server that you want DataSync to\n mount.</p>\n <p>This path (or a subdirectory of the path) is where DataSync transfers data to\n or from. For information on configuring an export for DataSync, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs\">Accessing NFS file servers</a>.</p>"
98209820
}
98219821
},
9822+
"ServerHostname": {
9823+
"target": "com.amazonaws.datasync#ServerHostname",
9824+
"traits": {
9825+
"smithy.api#documentation": "<p>Specifies the DNS name or IP version 4 (IPv4) address of the NFS file\n server that your DataSync agent connects to.</p>"
9826+
}
9827+
},
98229828
"OnPremConfig": {
98239829
"target": "com.amazonaws.datasync#OnPremConfig"
98249830
},
@@ -9885,6 +9891,12 @@
98859891
"smithy.api#documentation": "<p>Specifies the object prefix for your object storage server. If this is a source location,\n DataSync only copies objects with this prefix. If this is a destination location, DataSync\n writes all objects with this prefix.</p>"
98869892
}
98879893
},
9894+
"ServerHostname": {
9895+
"target": "com.amazonaws.datasync#ServerHostname",
9896+
"traits": {
9897+
"smithy.api#documentation": "<p>Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync\n agent connects to.</p>"
9898+
}
9899+
},
98889900
"AccessKey": {
98899901
"target": "com.amazonaws.datasync#ObjectStorageAccessKey",
98909902
"traits": {
@@ -10014,6 +10026,12 @@
1001410026
"smithy.api#documentation": "<p>Specifies the name of the share exported by your SMB file server where DataSync\n will read or write data. You can include a subdirectory in the share path (for example,\n <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can\n also mount this path.</p>\n <p>To copy all data in the specified subdirectory, DataSync must be able to mount\n the SMB share and access all of its data. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">Providing DataSync access to SMB file servers</a>.</p>"
1001510027
}
1001610028
},
10029+
"ServerHostname": {
10030+
"target": "com.amazonaws.datasync#ServerHostname",
10031+
"traits": {
10032+
"smithy.api#documentation": "<p>Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to.</p>\n <p>Remember the following when configuring this parameter:</p>\n <ul>\n <li>\n <p>You can't specify an IP version 6 (IPv6) address.</p>\n </li>\n <li>\n <p>If you're using Kerberos authentication, you must specify a domain name.</p>\n </li>\n </ul>"
10033+
}
10034+
},
1001710035
"User": {
1001810036
"target": "com.amazonaws.datasync#SmbUser",
1001910037
"traits": {
@@ -10044,7 +10062,7 @@
1004410062
"AuthenticationType": {
1004510063
"target": "com.amazonaws.datasync#SmbAuthenticationType",
1004610064
"traits": {
10047-
"smithy.api#documentation": "<p>Specifies the authentication protocol that DataSync uses to connect to your SMB\n file server. DataSync supports <code>NTLM</code> (default) and <code>KERBEROS</code>\n authentication.</p>"
10065+
"smithy.api#documentation": "<p>Specifies the authentication protocol that DataSync uses to connect to your SMB\n file server. DataSync supports <code>NTLM</code> (default) and <code>KERBEROS</code>\n authentication.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">Providing DataSync access to SMB file servers</a>.</p>"
1004810066
}
1004910067
},
1005010068
"DnsIpAddresses": {
@@ -10056,7 +10074,7 @@
1005610074
"KerberosPrincipal": {
1005710075
"target": "com.amazonaws.datasync#KerberosPrincipal",
1005810076
"traits": {
10059-
"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/kerberosuser@EXAMPLE.COM</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>"
10077+
"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/kerberosuser@MYDOMAIN.ORG</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>"
1006010078
}
1006110079
},
1006210080
"KerberosKeytab": {

0 commit comments

Comments
 (0)