Skip to content

Commit 8fc8760

Browse files
author
awstools
committed
docs(client-efs): Documentation updates for Elastic File System
1 parent 2270498 commit 8fc8760

File tree

5 files changed

+39
-40
lines changed

5 files changed

+39
-40
lines changed

clients/client-efs/src/commands/CreateReplicationConfigurationCommand.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ export interface CreateReplicationConfigurationCommandOutput
6262
* <ul>
6363
* <li>
6464
* <p>
65-
* <b>Amazon Web Services Region</b> - The Amazon Web Services Region in
66-
* which the destination file system is created. Amazon EFS replication is
67-
* available in all Amazon Web Services Regions that Amazon EFS is available in,
68-
* except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe
69-
* (Milan), and Middle East (Bahrain).</p>
65+
* <b>Amazon Web Services Region</b> - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is
66+
* available. To use EFS replication in a Region that is disabled by default, you must
67+
* first opt in to the Region. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable">Managing Amazon Web Services Regions</a> in the <i>Amazon Web Services General Reference
68+
* Reference Guide</i>
69+
* </p>
7070
* </li>
7171
* <li>
7272
* <p>
@@ -117,7 +117,7 @@ export interface CreateReplicationConfigurationCommandOutput
117117
* </li>
118118
* <li>
119119
* <p>
120-
* <b>Automatic backups</b> - Automatic daily backups not enabled on
120+
* <b>Automatic backups</b> - Automatic daily backups are enabled on
121121
* the destination file system. After the file system is created, you can change this
122122
* setting.</p>
123123
* </li>

clients/client-efs/src/commands/DeleteReplicationConfigurationCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,7 @@ export interface DeleteReplicationConfigurationCommandOutput extends __MetadataB
4040

4141
/**
4242
* @public
43-
* <p>Deletes an existing replication configuration. To delete a replication configuration, you
44-
* must make the request from the Amazon Web Services Region in which the destination file system
45-
* is located. Deleting a replication configuration ends the replication process. After a
43+
* <p>Deletes an existing replication configuration. Deleting a replication configuration ends the replication process. After a
4644
* replication configuration is deleted, the destination file system is no longer read-only. You
4745
* can write to the destination file system after its status becomes
4846
* <code>Writeable</code>.</p>

clients/client-efs/src/commands/DescribeAccountPreferencesCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ export interface DescribeAccountPreferencesCommandOutput extends DescribeAccount
3737

3838
/**
3939
* @public
40-
* <p>Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
41-
* For more information, see <a href="efs/latest/ug/manage-efs-resource-ids.html">Managing Amazon EFS resource IDs</a>.</p>
40+
* <p>Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.</p>
4241
* @example
4342
* Use a bare-bones client and the command you need to make an API call.
4443
* ```javascript

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

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -718,6 +718,7 @@ export interface CreateFileSystemRequest {
718718
* <note>
719719
* <p>The <code>maxIO</code> mode is not supported on file systems using One Zone storage classes.</p>
720720
* </note>
721+
* <p>Default is <code>generalPurpose</code>.</p>
721722
*/
722723
PerformanceMode?: PerformanceMode | string;
723724

@@ -779,12 +780,12 @@ export interface CreateFileSystemRequest {
779780

780781
/**
781782
* @public
782-
* <p>The throughput, measured in
783-
* MiB/s,
784-
* that you want to provision for a file system that you're creating. Valid values are
785-
* 1-1024. Required if <code>ThroughputMode</code> is set to <code>provisioned</code>. The upper
786-
* limit for throughput is 1024 MiB/s. To increase this limit, contact Amazon Web Services Support. For
787-
* more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits">Amazon EFS quotas that you can increase</a> in the <i>Amazon EFS User Guide</i>.</p>
783+
* <p>The throughput, measured in mebibytes per second (MiBps), that you want to provision for a
784+
* file system that you're creating. Required if <code>ThroughputMode</code> is set to
785+
* <code>provisioned</code>. Valid values are 1-3414 MiBps, with the upper limit depending on
786+
* Region. To increase this limit, contact Amazon Web Services Support. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits">Amazon EFS quotas
787+
* that you can increase</a> in the <i>Amazon EFS User
788+
* Guide</i>.</p>
788789
*/
789790
ProvisionedThroughputInMibps?: number;
790791

@@ -1011,7 +1012,7 @@ export interface FileSystemDescription {
10111012

10121013
/**
10131014
* @public
1014-
* <p>The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for
1015+
* <p>The amount of provisioned throughput, measured in MiBps, for the file system. Valid for
10151016
* file systems using <code>ThroughputMode</code> set to <code>provisioned</code>.</p>
10161017
*/
10171018
ProvisionedThroughputInMibps?: number;
@@ -1711,6 +1712,7 @@ export interface Destination {
17111712

17121713
/**
17131714
* @public
1715+
* <p>Describes the replication configuration for a specific file system.</p>
17141716
*/
17151717
export interface ReplicationConfigurationDescription {
17161718
/**
@@ -2946,10 +2948,13 @@ export interface UpdateFileSystemRequest {
29462948

29472949
/**
29482950
* @public
2949-
* <p>(Optional) Sets the amount of provisioned throughput, in MiB/s, for the file
2950-
* system. Valid values are 1-1024. If you are changing the throughput mode to provisioned, you must also
2951-
* provide the amount of provisioned throughput. Required if <code>ThroughputMode</code> is changed
2952-
* to <code>provisioned</code> on update.</p>
2951+
* <p>(Optional) The throughput, measured in mebibytes per second (MiBps), that you want to
2952+
* provision for a file system that you're creating. Required if <code>ThroughputMode</code>
2953+
* is set to <code>provisioned</code>. Valid values are 1-3414 MiBps, with the upper limit
2954+
* depending on Region. To increase this limit, contact Amazon Web Services Support. For more information,
2955+
* see <a href="https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits">Amazon EFS
2956+
* quotas that you can increase</a> in the <i>Amazon EFS User
2957+
* Guide</i>.</p>
29532958
*/
29542959
ProvisionedThroughputInMibps?: number;
29552960
}

0 commit comments

Comments
 (0)