Skip to content

Commit

Permalink
docs(client-efs): Documentation updates for Elastic File System
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Sep 22, 2023
1 parent 2270498 commit 8fc8760
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ export interface CreateReplicationConfigurationCommandOutput
* <ul>
* <li>
* <p>
* <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 that Amazon EFS is available in,
* except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe
* (Milan), and Middle East (Bahrain).</p>
* <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
* available. To use EFS replication in a Region that is disabled by default, you must
* 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
* Reference Guide</i>
* </p>
* </li>
* <li>
* <p>
Expand Down Expand Up @@ -117,7 +117,7 @@ export interface CreateReplicationConfigurationCommandOutput
* </li>
* <li>
* <p>
* <b>Automatic backups</b> - Automatic daily backups not enabled on
* <b>Automatic backups</b> - Automatic daily backups are enabled on
* the destination file system. After the file system is created, you can change this
* setting.</p>
* </li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ export interface DeleteReplicationConfigurationCommandOutput extends __MetadataB

/**
* @public
* <p>Deletes an existing replication configuration. To delete a replication configuration, you
* must make the request from the Amazon Web Services Region in which the destination file system
* is located. Deleting a replication configuration ends the replication process. After a
* <p>Deletes an existing replication configuration. Deleting a replication configuration ends the replication process. After a
* replication configuration is deleted, the destination file system is no longer read-only. You
* can write to the destination file system after its status becomes
* <code>Writeable</code>.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ export interface DescribeAccountPreferencesCommandOutput extends DescribeAccount

/**
* @public
* <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.
* For more information, see <a href="efs/latest/ug/manage-efs-resource-ids.html">Managing Amazon EFS resource IDs</a>.</p>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
27 changes: 16 additions & 11 deletions clients/client-efs/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -718,6 +718,7 @@ export interface CreateFileSystemRequest {
* <note>
* <p>The <code>maxIO</code> mode is not supported on file systems using One Zone storage classes.</p>
* </note>
* <p>Default is <code>generalPurpose</code>.</p>
*/
PerformanceMode?: PerformanceMode | string;

Expand Down Expand Up @@ -779,12 +780,12 @@ export interface CreateFileSystemRequest {

/**
* @public
* <p>The throughput, measured in
* MiB/s,
* that you want to provision for a file system that you're creating. Valid values are
* 1-1024. Required if <code>ThroughputMode</code> is set to <code>provisioned</code>. The upper
* limit for throughput is 1024 MiB/s. 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 that you can increase</a> in the <i>Amazon EFS User Guide</i>.</p>
* <p>The throughput, measured in mebibytes per second (MiBps), that you want to provision for a
* file system that you're creating. Required if <code>ThroughputMode</code> is set to
* <code>provisioned</code>. Valid values are 1-3414 MiBps, with the upper limit depending on
* 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
* that you can increase</a> in the <i>Amazon EFS User
* Guide</i>.</p>
*/
ProvisionedThroughputInMibps?: number;

Expand Down Expand Up @@ -1011,7 +1012,7 @@ export interface FileSystemDescription {

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

/**
* @public
* <p>Describes the replication configuration for a specific file system.</p>
*/
export interface ReplicationConfigurationDescription {
/**
Expand Down Expand Up @@ -2946,10 +2948,13 @@ export interface UpdateFileSystemRequest {

/**
* @public
* <p>(Optional) Sets the amount of provisioned throughput, in MiB/s, for the file
* system. Valid values are 1-1024. If you are changing the throughput mode to provisioned, you must also
* provide the amount of provisioned throughput. Required if <code>ThroughputMode</code> is changed
* to <code>provisioned</code> on update.</p>
* <p>(Optional) The throughput, measured in mebibytes per second (MiBps), that you want to
* provision for a file system that you're creating. Required if <code>ThroughputMode</code>
* is set to <code>provisioned</code>. Valid values are 1-3414 MiBps, with the upper limit
* depending on 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 that you can increase</a> in the <i>Amazon EFS User
* Guide</i>.</p>
*/
ProvisionedThroughputInMibps?: number;
}
Loading

0 comments on commit 8fc8760

Please sign in to comment.