|
109 | 109 | } |
110 | 110 | }, |
111 | 111 | "EndpointDetails": { |
112 | | - "base": null, |
| 112 | + "base": "<p>The configuration settings for the virtual private cloud (VPC) endpoint for your SFTP server.</p>", |
113 | 113 | "refs": { |
114 | | - "CreateServerRequest$EndpointDetails": null, |
115 | | - "DescribedServer$EndpointDetails": null, |
116 | | - "UpdateServerRequest$EndpointDetails": null |
| 114 | + "CreateServerRequest$EndpointDetails": "<p>The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.</p>", |
| 115 | + "DescribedServer$EndpointDetails": "<p>The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.</p>", |
| 116 | + "UpdateServerRequest$EndpointDetails": "<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>" |
117 | 117 | } |
118 | 118 | }, |
119 | 119 | "EndpointType": { |
120 | 120 | "base": null, |
121 | 121 | "refs": { |
122 | | - "CreateServerRequest$EndpointType": null, |
123 | | - "DescribedServer$EndpointType": null, |
124 | | - "ListedServer$EndpointType": null, |
125 | | - "UpdateServerRequest$EndpointType": null |
| 122 | + "CreateServerRequest$EndpointType": "<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>", |
| 123 | + "DescribedServer$EndpointType": "<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>", |
| 124 | + "ListedServer$EndpointType": "<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>", |
| 125 | + "UpdateServerRequest$EndpointType": "<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>" |
126 | 126 | } |
127 | 127 | }, |
128 | 128 | "HomeDirectory": { |
|
134 | 134 | "UpdateUserRequest$HomeDirectory": "<p>The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client. An example would be: <code>/home/<i>username</i> </code>.</p>" |
135 | 135 | } |
136 | 136 | }, |
| 137 | + "HostKey": { |
| 138 | + "base": null, |
| 139 | + "refs": { |
| 140 | + "CreateServerRequest$HostKey": "<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>", |
| 141 | + "UpdateServerRequest$HostKey": "<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>" |
| 142 | + } |
| 143 | + }, |
| 144 | + "HostKeyFingerprint": { |
| 145 | + "base": null, |
| 146 | + "refs": { |
| 147 | + "DescribedServer$HostKeyFingerprint": "<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>" |
| 148 | + } |
| 149 | + }, |
137 | 150 | "IdentityProviderDetails": { |
138 | 151 | "base": "<p>Returns information related to the type of user authentication that is in use for a server's users. A server can only have one method of authentication.</p>", |
139 | 152 | "refs": { |
|
262 | 275 | "NullableRole": { |
263 | 276 | "base": null, |
264 | 277 | "refs": { |
265 | | - "UpdateServerRequest$LoggingRole": "<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>" |
| 278 | + "UpdateServerRequest$LoggingRole": "<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>" |
266 | 279 | } |
267 | 280 | }, |
268 | 281 | "Policy": { |
|
498 | 511 | "UserName": { |
499 | 512 | "base": null, |
500 | 513 | "refs": { |
501 | | - "CreateUserRequest$UserName": "<p>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>.</p>", |
| 514 | + "CreateUserRequest$UserName": "<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>", |
502 | 515 | "CreateUserResponse$UserName": "<p>A unique string that identifies a user account associated with an SFTP server.</p>", |
503 | 516 | "DeleteSshPublicKeyRequest$UserName": "<p>A unique string that identifies a user whose public key is being deleted.</p>", |
504 | 517 | "DeleteUserRequest$UserName": "<p>A unique string that identifies a user that is being deleted from the server.</p>", |
|
508 | 521 | "ImportSshPublicKeyResponse$UserName": "<p>A user name assigned to the <code>ServerID</code> value that you specified.</p>", |
509 | 522 | "ListedUser$UserName": "<p>The name of the user whose ARN was specified. User names are used for authentication purposes.</p>", |
510 | 523 | "TestIdentityProviderRequest$UserName": "<p>This request parameter is name of the user account to be tested.</p>", |
511 | | - "UpdateUserRequest$UserName": "<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>", |
| 524 | + "UpdateUserRequest$UserName": "<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>", |
512 | 525 | "UpdateUserResponse$UserName": "<p>The unique identifier for a user that is assigned to the SFTP server instance that was specified in the request.</p>" |
513 | 526 | } |
514 | 527 | }, |
|
521 | 534 | "VpcEndpointId": { |
522 | 535 | "base": null, |
523 | 536 | "refs": { |
524 | | - "EndpointDetails$VpcEndpointId": null |
| 537 | + "EndpointDetails$VpcEndpointId": "<p>The ID of the VPC endpoint.</p>" |
525 | 538 | } |
526 | 539 | } |
527 | 540 | } |
|
0 commit comments