Skip to content

Commit db9943e

Browse files
author
aws-sdk-cpp-automation
committed
Documentation updates for AWS Backup
1 parent b2bf140 commit db9943e

22 files changed

+396
-267
lines changed

aws-cpp-sdk-backup/include/aws/backup/BackupClient.h

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -740,16 +740,16 @@ namespace Model
740740
virtual void DescribeCopyJobAsync(const Model::DescribeCopyJobRequest& request, const DescribeCopyJobResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const;
741741

742742
/**
743-
* <p>The current feature settings for the AWS Account.</p><p><h3>See Also:</h3>
744-
* <a
743+
* <p>Describes the global settings of the AWS account, including whether it is
744+
* opted in to cross-account backup.</p><p><h3>See Also:</h3> <a
745745
* href="http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeGlobalSettings">AWS
746746
* API Reference</a></p>
747747
*/
748748
virtual Model::DescribeGlobalSettingsOutcome DescribeGlobalSettings(const Model::DescribeGlobalSettingsRequest& request) const;
749749

750750
/**
751-
* <p>The current feature settings for the AWS Account.</p><p><h3>See Also:</h3>
752-
* <a
751+
* <p>Describes the global settings of the AWS account, including whether it is
752+
* opted in to cross-account backup.</p><p><h3>See Also:</h3> <a
753753
* href="http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeGlobalSettings">AWS
754754
* API Reference</a></p>
755755
*
@@ -758,8 +758,8 @@ namespace Model
758758
virtual Model::DescribeGlobalSettingsOutcomeCallable DescribeGlobalSettingsCallable(const Model::DescribeGlobalSettingsRequest& request) const;
759759

760760
/**
761-
* <p>The current feature settings for the AWS Account.</p><p><h3>See Also:</h3>
762-
* <a
761+
* <p>Describes the global settings of the AWS account, including whether it is
762+
* opted in to cross-account backup.</p><p><h3>See Also:</h3> <a
763763
* href="http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeGlobalSettings">AWS
764764
* API Reference</a></p>
765765
*
@@ -1764,7 +1764,7 @@ namespace Model
17641764
virtual void UpdateBackupPlanAsync(const Model::UpdateBackupPlanRequest& request, const UpdateBackupPlanResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const;
17651765

17661766
/**
1767-
* <p>Updates the current global settings for the AWS Account. Use the
1767+
* <p>Updates the current global settings for the AWS account. Use the
17681768
* <code>DescribeGlobalSettings</code> API to determine the current
17691769
* settings.</p><p><h3>See Also:</h3> <a
17701770
* href="http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateGlobalSettings">AWS
@@ -1773,7 +1773,7 @@ namespace Model
17731773
virtual Model::UpdateGlobalSettingsOutcome UpdateGlobalSettings(const Model::UpdateGlobalSettingsRequest& request) const;
17741774

17751775
/**
1776-
* <p>Updates the current global settings for the AWS Account. Use the
1776+
* <p>Updates the current global settings for the AWS account. Use the
17771777
* <code>DescribeGlobalSettings</code> API to determine the current
17781778
* settings.</p><p><h3>See Also:</h3> <a
17791779
* href="http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateGlobalSettings">AWS
@@ -1784,7 +1784,7 @@ namespace Model
17841784
virtual Model::UpdateGlobalSettingsOutcomeCallable UpdateGlobalSettingsCallable(const Model::UpdateGlobalSettingsRequest& request) const;
17851785

17861786
/**
1787-
* <p>Updates the current global settings for the AWS Account. Use the
1787+
* <p>Updates the current global settings for the AWS account. Use the
17881788
* <code>DescribeGlobalSettings</code> API to determine the current
17891789
* settings.</p><p><h3>See Also:</h3> <a
17901790
* href="http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateGlobalSettings">AWS
@@ -1802,7 +1802,8 @@ namespace Model
18021802
* be stored in cold storage for a minimum of 90 days. Therefore, the “expire after
18031803
* days” setting must be 90 days greater than the “transition to cold after days”
18041804
* setting. The “transition to cold after days” setting cannot be changed after a
1805-
* backup has been transitioned to cold. </p><p><h3>See Also:</h3> <a
1805+
* backup has been transitioned to cold. </p> <p>Only Amazon EFS file system
1806+
* backups can be transitioned to cold storage.</p><p><h3>See Also:</h3> <a
18061807
* href="http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRecoveryPointLifecycle">AWS
18071808
* API Reference</a></p>
18081809
*/
@@ -1816,7 +1817,8 @@ namespace Model
18161817
* be stored in cold storage for a minimum of 90 days. Therefore, the “expire after
18171818
* days” setting must be 90 days greater than the “transition to cold after days”
18181819
* setting. The “transition to cold after days” setting cannot be changed after a
1819-
* backup has been transitioned to cold. </p><p><h3>See Also:</h3> <a
1820+
* backup has been transitioned to cold. </p> <p>Only Amazon EFS file system
1821+
* backups can be transitioned to cold storage.</p><p><h3>See Also:</h3> <a
18201822
* href="http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRecoveryPointLifecycle">AWS
18211823
* API Reference</a></p>
18221824
*
@@ -1832,7 +1834,8 @@ namespace Model
18321834
* be stored in cold storage for a minimum of 90 days. Therefore, the “expire after
18331835
* days” setting must be 90 days greater than the “transition to cold after days”
18341836
* setting. The “transition to cold after days” setting cannot be changed after a
1835-
* backup has been transitioned to cold. </p><p><h3>See Also:</h3> <a
1837+
* backup has been transitioned to cold. </p> <p>Only Amazon EFS file system
1838+
* backups can be transitioned to cold storage.</p><p><h3>See Also:</h3> <a
18361839
* href="http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRecoveryPointLifecycle">AWS
18371840
* API Reference</a></p>
18381841
*

aws-cpp-sdk-backup/include/aws/backup/model/AdvancedBackupSetting.h

Lines changed: 48 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -40,58 +40,82 @@ namespace Model
4040

4141

4242
/**
43-
* <p>The type of AWS resource to be backed up. For VSS Windows backups, the only
44-
* supported resource type is Amazon EC2.</p> <p>Valid values:
45-
* <code>EC2</code>.</p>
43+
* <p>Specifies an object containing resource type and backup options. The only
44+
* supported resource type is Amazon EC2 instances with Windows VSS. For an
45+
* CloudFormation example, see the <a
46+
* href="https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html">sample
47+
* CloudFormation template to enable Windows VSS</a> in the <i>AWS Backup User
48+
* Guide</i>.</p> <p>Valid values: <code>EC2</code>.</p>
4649
*/
4750
inline const Aws::String& GetResourceType() const{ return m_resourceType; }
4851

4952
/**
50-
* <p>The type of AWS resource to be backed up. For VSS Windows backups, the only
51-
* supported resource type is Amazon EC2.</p> <p>Valid values:
52-
* <code>EC2</code>.</p>
53+
* <p>Specifies an object containing resource type and backup options. The only
54+
* supported resource type is Amazon EC2 instances with Windows VSS. For an
55+
* CloudFormation example, see the <a
56+
* href="https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html">sample
57+
* CloudFormation template to enable Windows VSS</a> in the <i>AWS Backup User
58+
* Guide</i>.</p> <p>Valid values: <code>EC2</code>.</p>
5359
*/
5460
inline bool ResourceTypeHasBeenSet() const { return m_resourceTypeHasBeenSet; }
5561

5662
/**
57-
* <p>The type of AWS resource to be backed up. For VSS Windows backups, the only
58-
* supported resource type is Amazon EC2.</p> <p>Valid values:
59-
* <code>EC2</code>.</p>
63+
* <p>Specifies an object containing resource type and backup options. The only
64+
* supported resource type is Amazon EC2 instances with Windows VSS. For an
65+
* CloudFormation example, see the <a
66+
* href="https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html">sample
67+
* CloudFormation template to enable Windows VSS</a> in the <i>AWS Backup User
68+
* Guide</i>.</p> <p>Valid values: <code>EC2</code>.</p>
6069
*/
6170
inline void SetResourceType(const Aws::String& value) { m_resourceTypeHasBeenSet = true; m_resourceType = value; }
6271

6372
/**
64-
* <p>The type of AWS resource to be backed up. For VSS Windows backups, the only
65-
* supported resource type is Amazon EC2.</p> <p>Valid values:
66-
* <code>EC2</code>.</p>
73+
* <p>Specifies an object containing resource type and backup options. The only
74+
* supported resource type is Amazon EC2 instances with Windows VSS. For an
75+
* CloudFormation example, see the <a
76+
* href="https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html">sample
77+
* CloudFormation template to enable Windows VSS</a> in the <i>AWS Backup User
78+
* Guide</i>.</p> <p>Valid values: <code>EC2</code>.</p>
6779
*/
6880
inline void SetResourceType(Aws::String&& value) { m_resourceTypeHasBeenSet = true; m_resourceType = std::move(value); }
6981

7082
/**
71-
* <p>The type of AWS resource to be backed up. For VSS Windows backups, the only
72-
* supported resource type is Amazon EC2.</p> <p>Valid values:
73-
* <code>EC2</code>.</p>
83+
* <p>Specifies an object containing resource type and backup options. The only
84+
* supported resource type is Amazon EC2 instances with Windows VSS. For an
85+
* CloudFormation example, see the <a
86+
* href="https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html">sample
87+
* CloudFormation template to enable Windows VSS</a> in the <i>AWS Backup User
88+
* Guide</i>.</p> <p>Valid values: <code>EC2</code>.</p>
7489
*/
7590
inline void SetResourceType(const char* value) { m_resourceTypeHasBeenSet = true; m_resourceType.assign(value); }
7691

7792
/**
78-
* <p>The type of AWS resource to be backed up. For VSS Windows backups, the only
79-
* supported resource type is Amazon EC2.</p> <p>Valid values:
80-
* <code>EC2</code>.</p>
93+
* <p>Specifies an object containing resource type and backup options. The only
94+
* supported resource type is Amazon EC2 instances with Windows VSS. For an
95+
* CloudFormation example, see the <a
96+
* href="https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html">sample
97+
* CloudFormation template to enable Windows VSS</a> in the <i>AWS Backup User
98+
* Guide</i>.</p> <p>Valid values: <code>EC2</code>.</p>
8199
*/
82100
inline AdvancedBackupSetting& WithResourceType(const Aws::String& value) { SetResourceType(value); return *this;}
83101

84102
/**
85-
* <p>The type of AWS resource to be backed up. For VSS Windows backups, the only
86-
* supported resource type is Amazon EC2.</p> <p>Valid values:
87-
* <code>EC2</code>.</p>
103+
* <p>Specifies an object containing resource type and backup options. The only
104+
* supported resource type is Amazon EC2 instances with Windows VSS. For an
105+
* CloudFormation example, see the <a
106+
* href="https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html">sample
107+
* CloudFormation template to enable Windows VSS</a> in the <i>AWS Backup User
108+
* Guide</i>.</p> <p>Valid values: <code>EC2</code>.</p>
88109
*/
89110
inline AdvancedBackupSetting& WithResourceType(Aws::String&& value) { SetResourceType(std::move(value)); return *this;}
90111

91112
/**
92-
* <p>The type of AWS resource to be backed up. For VSS Windows backups, the only
93-
* supported resource type is Amazon EC2.</p> <p>Valid values:
94-
* <code>EC2</code>.</p>
113+
* <p>Specifies an object containing resource type and backup options. The only
114+
* supported resource type is Amazon EC2 instances with Windows VSS. For an
115+
* CloudFormation example, see the <a
116+
* href="https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html">sample
117+
* CloudFormation template to enable Windows VSS</a> in the <i>AWS Backup User
118+
* Guide</i>.</p> <p>Valid values: <code>EC2</code>.</p>
95119
*/
96120
inline AdvancedBackupSetting& WithResourceType(const char* value) { SetResourceType(value); return *this;}
97121

aws-cpp-sdk-backup/include/aws/backup/model/BackupJob.h

Lines changed: 40 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -592,50 +592,74 @@ namespace Model
592592

593593

594594
/**
595-
* <p>Specifies the IAM role ARN used to create the target recovery point; for
596-
* example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
595+
* <p>Specifies the IAM role ARN used to create the target recovery point. IAM
596+
* roles other than the default role must include either <code>AWSBackup</code> or
597+
* <code>AwsBackup</code> in the role name. For example,
598+
* <code>arn:aws:iam::123456789012:role/AWSBackupRDSAccess</code>. Role names
599+
* without those strings lack permissions to perform backup jobs.</p>
597600
*/
598601
inline const Aws::String& GetIamRoleArn() const{ return m_iamRoleArn; }
599602

600603
/**
601-
* <p>Specifies the IAM role ARN used to create the target recovery point; for
602-
* example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
604+
* <p>Specifies the IAM role ARN used to create the target recovery point. IAM
605+
* roles other than the default role must include either <code>AWSBackup</code> or
606+
* <code>AwsBackup</code> in the role name. For example,
607+
* <code>arn:aws:iam::123456789012:role/AWSBackupRDSAccess</code>. Role names
608+
* without those strings lack permissions to perform backup jobs.</p>
603609
*/
604610
inline bool IamRoleArnHasBeenSet() const { return m_iamRoleArnHasBeenSet; }
605611

606612
/**
607-
* <p>Specifies the IAM role ARN used to create the target recovery point; for
608-
* example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
613+
* <p>Specifies the IAM role ARN used to create the target recovery point. IAM
614+
* roles other than the default role must include either <code>AWSBackup</code> or
615+
* <code>AwsBackup</code> in the role name. For example,
616+
* <code>arn:aws:iam::123456789012:role/AWSBackupRDSAccess</code>. Role names
617+
* without those strings lack permissions to perform backup jobs.</p>
609618
*/
610619
inline void SetIamRoleArn(const Aws::String& value) { m_iamRoleArnHasBeenSet = true; m_iamRoleArn = value; }
611620

612621
/**
613-
* <p>Specifies the IAM role ARN used to create the target recovery point; for
614-
* example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
622+
* <p>Specifies the IAM role ARN used to create the target recovery point. IAM
623+
* roles other than the default role must include either <code>AWSBackup</code> or
624+
* <code>AwsBackup</code> in the role name. For example,
625+
* <code>arn:aws:iam::123456789012:role/AWSBackupRDSAccess</code>. Role names
626+
* without those strings lack permissions to perform backup jobs.</p>
615627
*/
616628
inline void SetIamRoleArn(Aws::String&& value) { m_iamRoleArnHasBeenSet = true; m_iamRoleArn = std::move(value); }
617629

618630
/**
619-
* <p>Specifies the IAM role ARN used to create the target recovery point; for
620-
* example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
631+
* <p>Specifies the IAM role ARN used to create the target recovery point. IAM
632+
* roles other than the default role must include either <code>AWSBackup</code> or
633+
* <code>AwsBackup</code> in the role name. For example,
634+
* <code>arn:aws:iam::123456789012:role/AWSBackupRDSAccess</code>. Role names
635+
* without those strings lack permissions to perform backup jobs.</p>
621636
*/
622637
inline void SetIamRoleArn(const char* value) { m_iamRoleArnHasBeenSet = true; m_iamRoleArn.assign(value); }
623638

624639
/**
625-
* <p>Specifies the IAM role ARN used to create the target recovery point; for
626-
* example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
640+
* <p>Specifies the IAM role ARN used to create the target recovery point. IAM
641+
* roles other than the default role must include either <code>AWSBackup</code> or
642+
* <code>AwsBackup</code> in the role name. For example,
643+
* <code>arn:aws:iam::123456789012:role/AWSBackupRDSAccess</code>. Role names
644+
* without those strings lack permissions to perform backup jobs.</p>
627645
*/
628646
inline BackupJob& WithIamRoleArn(const Aws::String& value) { SetIamRoleArn(value); return *this;}
629647

630648
/**
631-
* <p>Specifies the IAM role ARN used to create the target recovery point; for
632-
* example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
649+
* <p>Specifies the IAM role ARN used to create the target recovery point. IAM
650+
* roles other than the default role must include either <code>AWSBackup</code> or
651+
* <code>AwsBackup</code> in the role name. For example,
652+
* <code>arn:aws:iam::123456789012:role/AWSBackupRDSAccess</code>. Role names
653+
* without those strings lack permissions to perform backup jobs.</p>
633654
*/
634655
inline BackupJob& WithIamRoleArn(Aws::String&& value) { SetIamRoleArn(std::move(value)); return *this;}
635656

636657
/**
637-
* <p>Specifies the IAM role ARN used to create the target recovery point; for
638-
* example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
658+
* <p>Specifies the IAM role ARN used to create the target recovery point. IAM
659+
* roles other than the default role must include either <code>AWSBackup</code> or
660+
* <code>AwsBackup</code> in the role name. For example,
661+
* <code>arn:aws:iam::123456789012:role/AWSBackupRDSAccess</code>. Role names
662+
* without those strings lack permissions to perform backup jobs.</p>
639663
*/
640664
inline BackupJob& WithIamRoleArn(const char* value) { SetIamRoleArn(value); return *this;}
641665

0 commit comments

Comments
 (0)