Skip to content

Commit 8e3234c

Browse files
author
AWS
committed
AWS Transfer for SFTP Update: This release adds support for per-server host-key management. You can now specify the SSH RSA private key used by your SFTP server.
1 parent 9f46ae9 commit 8e3234c

File tree

3 files changed

+76
-13
lines changed

3 files changed

+76
-13
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"category": "AWS Transfer for SFTP",
3+
"type": "feature",
4+
"description": "This release adds support for per-server host-key management. You can now specify the SSH RSA private key used by your SFTP server."
5+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
11
{
22
"pagination": {
3+
"ListServers": {
4+
"input_token": "NextToken",
5+
"output_token": "NextToken",
6+
"limit_key": "MaxResults"
7+
},
8+
"ListTagsForResource": {
9+
"input_token": "NextToken",
10+
"output_token": "NextToken",
11+
"limit_key": "MaxResults"
12+
},
13+
"ListUsers": {
14+
"input_token": "NextToken",
15+
"output_token": "NextToken",
16+
"limit_key": "MaxResults"
17+
}
318
}
419
}

services/transfer/src/main/resources/codegen-resources/service-2.json

Lines changed: 56 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
"errors":[
2626
{"shape":"ServiceUnavailableException"},
2727
{"shape":"InternalServiceError"},
28-
{"shape":"InvalidRequestException"}
28+
{"shape":"InvalidRequestException"},
29+
{"shape":"ResourceExistsException"}
2930
],
3031
"documentation":"<p>Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the <code>ServerId</code> property assigned by the service to the newly created server. Reference this <code>ServerId</code> property when you make updates to your server, or work with users.</p> <p>The response returns the <code>ServerId</code> value for the newly created server.</p>"
3132
},
@@ -305,8 +306,18 @@
305306
"CreateServerRequest":{
306307
"type":"structure",
307308
"members":{
308-
"EndpointDetails":{"shape":"EndpointDetails"},
309-
"EndpointType":{"shape":"EndpointType"},
309+
"EndpointDetails":{
310+
"shape":"EndpointDetails",
311+
"documentation":"<p>The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.</p>"
312+
},
313+
"EndpointType":{
314+
"shape":"EndpointType",
315+
"documentation":"<p>The type of VPC endpoint that you want your SFTP server connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.</p>"
316+
},
317+
"HostKey":{
318+
"shape":"HostKey",
319+
"documentation":"<p>The RSA private key as generated by <code>ssh-keygen -N \"\" -f my-new-server-key</code> command.</p> <important> <p>If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see <a>change-host-key</a> in the <i>AWS SFTP User Guide.</i> </p> </important>"
320+
},
310321
"IdentityProviderDetails":{
311322
"shape":"IdentityProviderDetails",
312323
"documentation":"<p>An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the <code>IdentityProviderType</code> value of server that is created uses the <code>SERVICE_MANAGED</code> authentication method.</p>"
@@ -369,7 +380,7 @@
369380
},
370381
"UserName":{
371382
"shape":"UserName",
372-
"documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>.</p>"
383+
"documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.</p>"
373384
}
374385
}
375386
},
@@ -502,8 +513,18 @@
502513
"shape":"Arn",
503514
"documentation":"<p>Specifies the unique Amazon Resource Name (ARN) for the server to be described.</p>"
504515
},
505-
"EndpointDetails":{"shape":"EndpointDetails"},
506-
"EndpointType":{"shape":"EndpointType"},
516+
"EndpointDetails":{
517+
"shape":"EndpointDetails",
518+
"documentation":"<p>The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.</p>"
519+
},
520+
"EndpointType":{
521+
"shape":"EndpointType",
522+
"documentation":"<p>The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.</p>"
523+
},
524+
"HostKeyFingerprint":{
525+
"shape":"HostKeyFingerprint",
526+
"documentation":"<p>This value contains the Message-Digest Algorithm (MD5) hash of the server's host key. This value is equivalent to the output of <code>ssh-keygen -l -E md5 -f my-new-server-key</code> command.</p>"
527+
},
507528
"IdentityProviderDetails":{
508529
"shape":"IdentityProviderDetails",
509530
"documentation":"<p>Specifies information to call a customer-supplied authentication API. This field is not populated when the <code>IdentityProviderType</code> of the server is <code>SERVICE_MANAGED</code>&gt;.</p>"
@@ -573,8 +594,12 @@
573594
"EndpointDetails":{
574595
"type":"structure",
575596
"members":{
576-
"VpcEndpointId":{"shape":"VpcEndpointId"}
577-
}
597+
"VpcEndpointId":{
598+
"shape":"VpcEndpointId",
599+
"documentation":"<p>The ID of the VPC endpoint.</p>"
600+
}
601+
},
602+
"documentation":"<p>The configuration settings for the virtual private cloud (VPC) endpoint for your SFTP server.</p>"
578603
},
579604
"EndpointType":{
580605
"type":"string",
@@ -588,6 +613,11 @@
588613
"max":1024,
589614
"pattern":"^$|/.*"
590615
},
616+
"HostKey":{
617+
"type":"string",
618+
"max":4096
619+
},
620+
"HostKeyFingerprint":{"type":"string"},
591621
"IdentityProviderDetails":{
592622
"type":"structure",
593623
"members":{
@@ -796,7 +826,10 @@
796826
"shape":"IdentityProviderType",
797827
"documentation":"<p>The authentication method used to validate a user for the server that was specified. listed. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include <code>SERVICE_MANAGED</code> or <code>API_GATEWAY</code>.</p>"
798828
},
799-
"EndpointType":{"shape":"EndpointType"},
829+
"EndpointType":{
830+
"shape":"EndpointType",
831+
"documentation":"<p>The type of VPC endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.</p>"
832+
},
800833
"LoggingRole":{
801834
"shape":"Role",
802835
"documentation":"<p>The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.</p>"
@@ -1101,15 +1134,25 @@
11011134
"type":"structure",
11021135
"required":["ServerId"],
11031136
"members":{
1104-
"EndpointDetails":{"shape":"EndpointDetails"},
1105-
"EndpointType":{"shape":"EndpointType"},
1137+
"EndpointDetails":{
1138+
"shape":"EndpointDetails",
1139+
"documentation":"<p>The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, your SFTP server isn't accessible over the public internet.</p>"
1140+
},
1141+
"EndpointType":{
1142+
"shape":"EndpointType",
1143+
"documentation":"<p>The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet. </p>"
1144+
},
1145+
"HostKey":{
1146+
"shape":"HostKey",
1147+
"documentation":"<p>The RSA private key as generated by <code>ssh-keygen -N \"\" -f my-new-server-key</code>.</p> <important> <p>If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see <a>change-host-key</a> in the <i>AWS SFTP User Guide.</i> </p> </important>"
1148+
},
11061149
"IdentityProviderDetails":{
11071150
"shape":"IdentityProviderDetails",
11081151
"documentation":"<p>This response parameter is an array containing all of the information required to call a customer's authentication API method.</p>"
11091152
},
11101153
"LoggingRole":{
11111154
"shape":"NullableRole",
1112-
"documentation":"<p>Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.</p>"
1155+
"documentation":"<p>A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.</p>"
11131156
},
11141157
"ServerId":{
11151158
"shape":"ServerId",
@@ -1152,7 +1195,7 @@
11521195
},
11531196
"UserName":{
11541197
"shape":"UserName",
1155-
"documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server.</p>"
1198+
"documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.</p>"
11561199
}
11571200
}
11581201
},

0 commit comments

Comments
 (0)