Skip to content

Commit 7bcf41f

Browse files
author
awstools
committed
docs(client-transfer): AWS Transfer Family now accepts ECDSA keys for server host keys
1 parent 37c9777 commit 7bcf41f

File tree

2 files changed

+32
-10
lines changed

2 files changed

+32
-10
lines changed

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

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -885,8 +885,19 @@ export interface CreateServerRequest {
885885
EndpointType?: EndpointType | string;
886886

887887
/**
888-
* <p>The RSA private key as generated by the <code>ssh-keygen -N "" -m PEM -f
889-
* my-new-server-key</code> command.</p>
888+
* <p>The RSA or ECDSA private key to use for your server.</p>
889+
*
890+
* <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
891+
* <p>
892+
* <code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
893+
* <p>Use a minimum value of 2048 for the <code>-b</code> option: you can create a stronger key using 3072 or 4096.</p>
894+
*
895+
* <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
896+
* <p>
897+
* <code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
898+
* <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
899+
*
900+
* <p>For both of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p>
890901
*
891902
* <important>
892903
* <p>If you aren't planning to migrate existing users from an existing SFTP-enabled
@@ -3906,18 +3917,29 @@ export interface UpdateServerRequest {
39063917
EndpointType?: EndpointType | string;
39073918

39083919
/**
3909-
* <p>The RSA private key as generated by <code>ssh-keygen -N "" -m PEM -f
3910-
* my-new-server-key</code>.</p>
3920+
* <p>The RSA or ECDSA private key to use for your server.</p>
3921+
*
3922+
* <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
3923+
* <p>
3924+
* <code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
3925+
* <p>Use a minimum value of 2048 for the <code>-b</code> option: you can create a stronger key using 3072 or 4096.</p>
3926+
*
3927+
* <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
3928+
* <p>
3929+
* <code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
3930+
* <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
3931+
*
3932+
* <p>For both of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p>
39113933
*
39123934
* <important>
3913-
* <p>If you aren't planning to migrate existing users from an existing server to a new
3914-
* server, don't update the host key. Accidentally changing a server's host key can
3915-
* be disruptive.</p>
3935+
* <p>If you aren't planning to migrate existing users from an existing SFTP-enabled
3936+
* server to a new server, don't update the host key. Accidentally changing a
3937+
* server's host key can be disruptive.</p>
39163938
* </important>
39173939
*
39183940
*
39193941
*
3920-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web ServicesTransfer
3942+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web Services Transfer
39213943
* Family User Guide</i>.</p>
39223944
*/
39233945
HostKey?: string;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@
298298
"HostKey": {
299299
"target": "com.amazonaws.transfer#HostKey",
300300
"traits": {
301-
"smithy.api#documentation": "<p>The RSA private key as generated by the <code>ssh-keygen -N \"\" -m PEM -f\n my-new-server-key</code> command.</p>\n\n <important>\n <p>If you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.</p>\n </important>\n\n \n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key\">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web Services Transfer\n Family User Guide</i>.</p>"
301+
"smithy.api#documentation": "<p>The RSA or ECDSA private key to use for your server.</p>\n \n <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>\n <p>\n <code>ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key</code>.</p>\n <p>Use a minimum value of 2048 for the <code>-b</code> option: you can create a stronger key using 3072 or 4096.</p>\n \n <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>\n <p>\n <code>ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key</code>.</p>\n <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>\n \n <p>For both of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p>\n\n <important>\n <p>If you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.</p>\n </important>\n\n \n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key\">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web Services Transfer\n Family User Guide</i>.</p>"
302302
}
303303
},
304304
"IdentityProviderDetails": {
@@ -4477,7 +4477,7 @@
44774477
"HostKey": {
44784478
"target": "com.amazonaws.transfer#HostKey",
44794479
"traits": {
4480-
"smithy.api#documentation": "<p>The RSA private key as generated by <code>ssh-keygen -N \"\" -m PEM -f\n my-new-server-key</code>.</p>\n\n <important>\n <p>If you aren't planning to migrate existing users from an existing server to a new\n server, don't update the host key. Accidentally changing a server's host key can\n be disruptive.</p>\n </important>\n\n \n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key\">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web ServicesTransfer\n Family User Guide</i>.</p>"
4480+
"smithy.api#documentation": "<p>The RSA or ECDSA private key to use for your server.</p>\n \n <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>\n <p>\n <code>ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key</code>.</p>\n <p>Use a minimum value of 2048 for the <code>-b</code> option: you can create a stronger key using 3072 or 4096.</p>\n \n <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>\n <p>\n <code>ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key</code>.</p>\n <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>\n \n <p>For both of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p>\n\n <important>\n <p>If you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.</p>\n </important>\n\n \n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key\">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web Services Transfer\n Family User Guide</i>.</p>"
44814481
}
44824482
},
44834483
"IdentityProviderDetails": {

0 commit comments

Comments
 (0)