Skip to content

Commit 4d91221

Browse files
author
awstools
committed
docs(client-backup): Fix Typo for S3Backup Options ( S3BackupACLs to BackupACLs)
1 parent c8fe185 commit 4d91221

4 files changed

Lines changed: 82 additions & 40 deletions

File tree

‎clients/client-backup/src/commands/DescribeGlobalSettingsCommand.ts‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,7 @@ export interface DescribeGlobalSettingsCommandInput extends DescribeGlobalSettin
2727
export interface DescribeGlobalSettingsCommandOutput extends DescribeGlobalSettingsOutput, __MetadataBearer {}
2828

2929
/**
30-
* <p>Describes whether the Amazon Web Services account is opted in to cross-account backup.
31-
* Returns an error if the account is not a member of an Organizations organization.
32-
* Example: <code>describe-global-settings --region us-west-2</code>
30+
* <p>Describes whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not a member of an Organizations organization. Example: <code>describe-global-settings --region us-west-2</code>
3331
* </p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-backup/src/commands/UpdateGlobalSettingsCommand.ts‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,7 @@ export interface UpdateGlobalSettingsCommandInput extends UpdateGlobalSettingsIn
2727
export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {}
2828

2929
/**
30-
* <p>Updates whether the Amazon Web Services account is opted in to cross-account backup.
31-
* Returns an error if the account is not an Organizations management account. Use the
32-
* <code>DescribeGlobalSettings</code> API to determine the current settings.</p>
30+
* <p>Updates whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not an Organizations management account. Use the <code>DescribeGlobalSettings</code> API to determine the current settings.</p>
3331
* @example
3432
* Use a bare-bones client and the command you need to make an API call.
3533
* ```javascript

‎clients/client-backup/src/models/models_0.ts‎

Lines changed: 63 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ export interface AdvancedBackupSetting {
5858
* option and create a Windows VSS backup. </p>
5959
* <p>Set to <code>"WindowsVSS":"disabled"</code> to create a regular backup. The
6060
* <code>WindowsVSS</code> option is not enabled by default.</p>
61-
* <p>For S3 backups, set to <code>"S3BackupACLs":"disabled"</code> to exclude ACLs from the backup,
62-
* or <code>"S3BackupObjectTags":"disabled"</code> to exclude object tags from the backup.
61+
* <p>For S3 backups, set to <code>"BackupACLs":"disabled"</code> to exclude ACLs from the backup,
62+
* or <code>"BackupObjectTags":"disabled"</code> to exclude object tags from the backup.
6363
* By default, both ACLs and object tags are included in S3 backups.</p>
6464
* <p>If you specify an invalid option, you get an <code>InvalidParameterValueException</code>
6565
* exception.</p>
@@ -369,6 +369,9 @@ export interface BackupJob {
369369
* backup.</p>
370370
* </li>
371371
* <li>
372+
* <p>For Amazon EKS, this value refers to the size of your nested EKS recovery point.</p>
373+
* </li>
374+
* <li>
372375
* <p>Amazon FSx does not populate this value from the operation
373376
* <code>GetBackupJobStatus</code> for FSx file systems.</p>
374377
* </li>
@@ -1220,6 +1223,9 @@ export interface BackupSelection {
12201223
* selection strategy, such as assigning all resources of a resource type or refining your
12211224
* resource selection using tags.</p>
12221225
* <p>If you specify multiple ARNs, the resources much match any of the ARNs (OR logic).</p>
1226+
* <note>
1227+
* <p>When using wildcards in ARN patterns for backup selections, the asterisk (*) must appear at the end of the ARN string (prefix pattern). For example, <code>arn:aws:s3:::my-bucket-*</code> is valid, but <code>arn:aws:s3:::*-logs</code> is not supported.</p>
1228+
* </note>
12231229
* @public
12241230
*/
12251231
Resources?: string[] | undefined;
@@ -3521,6 +3527,9 @@ export interface DescribeBackupJobOutput {
35213527
* backup.</p>
35223528
* </li>
35233529
* <li>
3530+
* <p>For Amazon EKS, this value refers to the size of your nested EKS recovery point.</p>
3531+
* </li>
3532+
* <li>
35243533
* <p>Amazon FSx does not populate this value from the operation
35253534
* <code>GetBackupJobStatus</code> for FSx file systems.</p>
35263535
* </li>
@@ -3979,17 +3988,27 @@ export interface DescribeGlobalSettingsInput {}
39793988
*/
39803989
export interface DescribeGlobalSettingsOutput {
39813990
/**
3982-
* <p>The status of the flags <code>isCrossAccountBackupEnabled</code>,
3983-
* <code>isMpaEnabled</code> ('Mpa' refers to multi-party approval), and <code>isDelegatedAdministratorEnabled</code>.</p>
3991+
* <p>The status of the flags <code>isCrossAccountBackupEnabled</code>, <code>isMpaEnabled</code> ('Mpa' refers to multi-party approval), and <code>isDelegatedAdministratorEnabled</code>.</p>
3992+
* <ul>
3993+
* <li>
3994+
* <p>
3995+
* <code>isCrossAccountBackupEnabled</code>: Allow accounts in your organization to copy backups to other accounts.</p>
3996+
* </li>
3997+
* <li>
3998+
* <p>
3999+
* <code>isMpaEnabled</code>: Add cross-account access to your organization with the option to assign a Multi-party approval team to a logically air-gapped vault.</p>
4000+
* </li>
4001+
* <li>
4002+
* <p>
4003+
* <code>isDelegatedAdministratorEnabled</code>: Allow Backup to automatically synchronize delegated administrator permissions with Organizations.</p>
4004+
* </li>
4005+
* </ul>
39844006
* @public
39854007
*/
39864008
GlobalSettings?: Record<string, string> | undefined;
39874009

39884010
/**
3989-
* <p>The date and time that the flag <code>isCrossAccountBackupEnabled</code> was last
3990-
* updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of
3991-
* <code>LastUpdateTime</code> is accurate to milliseconds. For example, the value
3992-
* 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
4011+
* <p>The date and time that the supported flags were last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of <code>LastUpdateTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
39934012
* @public
39944013
*/
39954014
LastUpdateTime?: Date | undefined;
@@ -6030,6 +6049,10 @@ export interface GetSupportedResourceTypesOutput {
60306049
* </li>
60316050
* <li>
60326051
* <p>
6052+
* <code>EKS</code> for Amazon Elastic Kubernetes Service</p>
6053+
* </li>
6054+
* <li>
6055+
* <p>
60336056
* <code>FSx</code> for Amazon FSx</p>
60346057
* </li>
60356058
* <li>
@@ -6248,6 +6271,10 @@ export interface ListBackupJobsInput {
62486271
* </li>
62496272
* <li>
62506273
* <p>
6274+
* <code>EKS</code> for Amazon Elastic Kubernetes Service</p>
6275+
* </li>
6276+
* <li>
6277+
* <p>
62516278
* <code>FSx</code> for Amazon FSx</p>
62526279
* </li>
62536280
* <li>
@@ -6813,6 +6840,10 @@ export interface ListCopyJobsInput {
68136840
* </li>
68146841
* <li>
68156842
* <p>
6843+
* <code>EKS</code> for Amazon Elastic Kubernetes Service</p>
6844+
* </li>
6845+
* <li>
6846+
* <p>
68166847
* <code>FSx</code> for Amazon FSx</p>
68176848
* </li>
68186849
* <li>
@@ -7667,6 +7698,10 @@ export interface ListRecoveryPointsByBackupVaultInput {
76677698
* </li>
76687699
* <li>
76697700
* <p>
7701+
* <code>EKS</code> for Amazon Elastic Kubernetes Service</p>
7702+
* </li>
7703+
* <li>
7704+
* <p>
76707705
* <code>FSx</code> for Amazon FSx</p>
76717706
* </li>
76727707
* <li>
@@ -8519,6 +8554,10 @@ export interface ListRestoreJobsInput {
85198554
* </li>
85208555
* <li>
85218556
* <p>
8557+
* <code>EKS</code> for Amazon Elastic Kubernetes Service</p>
8558+
* </li>
8559+
* <li>
8560+
* <p>
85228561
* <code>FSx</code> for Amazon FSx</p>
85238562
* </li>
85248563
* <li>
@@ -9943,6 +9982,7 @@ export interface PutBackupVaultLockConfigurationInput {
99439982
* <p>Backup enforces a 72-hour cooling-off period before Vault Lock takes effect
99449983
* and becomes immutable. Therefore, you must set <code>ChangeableForDays</code> to 3 or
99459984
* greater.</p>
9985+
* <p>The maximum value you can specify is 36,500 days (approximately 100 years).</p>
99469986
* <p>Before the lock date, you can delete Vault Lock from the vault using
99479987
* <code>DeleteBackupVaultLockConfiguration</code> or change the Vault Lock configuration
99489988
* using <code>PutBackupVaultLockConfiguration</code>. On and after the lock date, the Vault
@@ -10371,6 +10411,11 @@ export interface StartRestoreJobInput {
1037110411
* </li>
1037210412
* <li>
1037310413
* <p>
10414+
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-eks.html#eks-restore-backup-section">Metadata for Amazon EKS</a>
10415+
* </p>
10416+
* </li>
10417+
* <li>
10418+
* <p>
1037410419
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli">Metadata for Amazon FSx</a>
1037510420
* </p>
1037610421
* </li>
@@ -10463,6 +10508,10 @@ export interface StartRestoreJobInput {
1046310508
* </li>
1046410509
* <li>
1046510510
* <p>
10511+
* <code>EKS</code> - Amazon Elastic Kubernetes Service</p>
10512+
* </li>
10513+
* <li>
10514+
* <p>
1046610515
* <code>FSx</code> - Amazon FSx</p>
1046710516
* </li>
1046810517
* <li>
@@ -10792,17 +10841,14 @@ export interface UpdateFrameworkOutput {
1079210841
export interface UpdateGlobalSettingsInput {
1079310842
/**
1079410843
* <p>Inputs can include:</p>
10795-
* <p>A value for <code>isCrossAccountBackupEnabled</code> and a Region. Example:
10796-
* <code>update-global-settings --global-settings isCrossAccountBackupEnabled=false
10797-
* --region us-west-2</code>.</p>
10798-
* <p>A value for Multi-party approval, styled as "Mpa": <code>isMpaEnabled</code>. Values can
10844+
* <p>A value for <code>isCrossAccountBackupEnabled</code>. Values can be true or false. Example:
10845+
* <code>update-global-settings --global-settings isCrossAccountBackupEnabled=false</code>.</p>
10846+
* <p>A value for Multi-party approval, styled as <code>isMpaEnabled</code>. Values can
1079910847
* be true or false. Example:
10800-
* <code>update-global-settings --global-settings isMpaEnabled=false
10801-
* --region us-west-2</code>.</p>
10802-
* <p>A value for Backup Service-Linked Role creation, styled as<code>isDelegatedAdministratorEnabled</code>.
10848+
* <code>update-global-settings --global-settings isMpaEnabled=false</code>.</p>
10849+
* <p>A value for Backup Service-Linked Role creation, styled as <code>isDelegatedAdministratorEnabled</code>.
1080310850
* Values can be true or false. Example:
10804-
* <code>update-global-settings --global-settings isDelegatedAdministratorEnabled=false
10805-
* --region us-west-2</code>.</p>
10851+
* <code>update-global-settings --global-settings isDelegatedAdministratorEnabled=false</code>.</p>
1080610852
* @public
1080710853
*/
1080810854
GlobalSettings?: Record<string, string> | undefined;

0 commit comments

Comments
 (0)