Skip to content

Commit

Permalink
The latest update introduces two new attributes, VaultType and VaultS…
Browse files Browse the repository at this point in the history
…tate, to the DescribeBackupVault and ListBackupVaults APIs. The VaultState attribute reflects the current status of the vault, while the VaultType attribute indicates the specific category of the vault.
  • Loading branch information
aws-sdk-dotnet-automation committed Aug 30, 2024
1 parent 838b763 commit 4b3e374
Show file tree
Hide file tree
Showing 125 changed files with 1,724 additions and 1,449 deletions.
7 changes: 6 additions & 1 deletion generator/ServiceModels/backup/backup-2018-11-15.api.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@
"endpointPrefix":"backup",
"jsonVersion":"1.1",
"protocol":"rest-json",
"protocols":["rest-json"],
"serviceFullName":"AWS Backup",
"serviceId":"Backup",
"signatureVersion":"v4",
"uid":"backup-2018-11-15"
"uid":"backup-2018-11-15",
"auth":["aws.auth#sigv4"]
},
"operations":{
"CancelLegalHold":{
Expand Down Expand Up @@ -1739,6 +1741,8 @@
"members":{
"BackupVaultName":{"shape":"BackupVaultName"},
"BackupVaultArn":{"shape":"ARN"},
"VaultType":{"shape":"VaultType"},
"VaultState":{"shape":"VaultState"},
"CreationDate":{"shape":"timestamp"},
"EncryptionKeyArn":{"shape":"ARN"},
"CreatorRequestId":{"shape":"string"},
Expand Down Expand Up @@ -2421,6 +2425,7 @@
"BackupVaultName":{"shape":"string"},
"BackupVaultArn":{"shape":"ARN"},
"VaultType":{"shape":"VaultType"},
"VaultState":{"shape":"VaultState"},
"EncryptionKeyArn":{"shape":"ARN"},
"CreationDate":{"shape":"timestamp"},
"CreatorRequestId":{"shape":"string"},
Expand Down
521 changes: 262 additions & 259 deletions generator/ServiceModels/backup/backup-2018-11-15.docs.json

Large diffs are not rendered by default.

534 changes: 274 additions & 260 deletions generator/ServiceModels/backup/backup-2018-11-15.normal.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
namespace Amazon.Backup.Model
{
/// <summary>
/// A list of backup options for each resource type.
/// The backup options for each resource type.
/// </summary>
public partial class AdvancedBackupSetting
{
Expand Down
8 changes: 4 additions & 4 deletions sdk/src/Services/Backup/Generated/Model/BackupJob.cs
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ internal bool IsSetBackupType()
/// Gets and sets the property BackupVaultArn.
/// <para>
/// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
/// <c>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</c>.
/// <c>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</c>.
/// </para>
/// </summary>
public string BackupVaultArn
Expand All @@ -182,7 +182,7 @@ internal bool IsSetBackupVaultArn()
/// <para>
/// The name of a logical container where backups are stored. Backup vaults are identified
/// by names that are unique to the account used to create them and the Amazon Web Services
/// Region where they are created. They consist of lowercase letters, numbers, and hyphens.
/// Region where they are created.
/// </para>
/// </summary>
public string BackupVaultName
Expand Down Expand Up @@ -322,7 +322,7 @@ internal bool IsSetIamRoleArn()
/// <summary>
/// Gets and sets the property InitiationDate.
/// <para>
/// This is the date on which the backup job was initiated.
/// The date on which the backup job was initiated.
/// </para>
/// </summary>
public DateTime InitiationDate
Expand Down Expand Up @@ -466,7 +466,7 @@ internal bool IsSetResourceArn()
/// <summary>
/// Gets and sets the property ResourceName.
/// <para>
/// This is the non-unique name of the resource that belongs to the specified backup.
/// The non-unique name of the resource that belongs to the specified backup.
/// </para>
/// </summary>
public string ResourceName
Expand Down
8 changes: 7 additions & 1 deletion sdk/src/Services/Backup/Generated/Model/BackupPlan.cs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,13 @@ internal bool IsSetAdvancedBackupSettings()
/// <summary>
/// Gets and sets the property BackupPlanName.
/// <para>
/// The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
/// The display name of a backup plan. Must contain only alphanumeric or '-_.' special
/// characters.
/// </para>
///
/// <para>
/// If this is set in the console, it can contain 1 to 50 characters; if this is set through
/// CLI or API, it can contain 1 to 200 characters.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,10 @@ internal bool IsSetDeletionDate()
/// <summary>
/// Gets and sets the property LastExecutionDate.
/// <para>
/// The last time a job to back up resources was run with this rule. A date and time,
/// in Unix format and Coordinated Universal Time (UTC). The value of <c>LastExecutionDate</c>
/// is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
/// January 26, 2018 12:11:30.087 AM.
/// The last time this backup plan was run. A date and time, in Unix format and Coordinated
/// Universal Time (UTC). The value of <c>LastExecutionDate</c> is accurate to milliseconds.
/// For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
/// AM.
/// </para>
/// </summary>
public DateTime LastExecutionDate
Expand Down
15 changes: 7 additions & 8 deletions sdk/src/Services/Backup/Generated/Model/BackupRule.cs
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,9 @@ internal bool IsSetEnableContinuousBackup()
/// </para>
///
/// <para>
/// Resource types that are able to be transitioned to cold storage are listed in the
/// "Lifecycle to cold storage" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource">
/// Feature availability by resource</a> table. Backup ignores this expression for other
/// resource types.
/// Resource types that can transition to cold storage are listed in the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource">Feature
/// availability by resource</a> table. Backup ignores this expression for other resource
/// types.
/// </para>
/// </summary>
public Lifecycle Lifecycle
Expand All @@ -140,8 +139,8 @@ internal bool IsSetLifecycle()
/// <summary>
/// Gets and sets the property RecoveryPointTags.
/// <para>
/// An array of key-value pair strings that are assigned to resources that are associated
/// with this rule when restored from backup.
/// The tags that are assigned to resources that are associated with this rule when restored
/// from backup.
/// </para>
/// </summary>
[AWSProperty(Sensitive=true)]
Expand Down Expand Up @@ -221,7 +220,7 @@ internal bool IsSetScheduleExpression()
/// <summary>
/// Gets and sets the property ScheduleExpressionTimezone.
/// <para>
/// This is the timezone in which the schedule expression is set. By default, ScheduleExpressions
/// The timezone in which the schedule expression is set. By default, ScheduleExpressions
/// are in UTC. You can modify this to a specified timezone.
/// </para>
/// </summary>
Expand Down Expand Up @@ -272,7 +271,7 @@ internal bool IsSetStartWindowMinutes()
/// <para>
/// The name of a logical container where backups are stored. Backup vaults are identified
/// by names that are unique to the account used to create them and the Amazon Web Services
/// Region where they are created. They consist of lowercase letters, numbers, and hyphens.
/// Region where they are created.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
Expand Down
16 changes: 7 additions & 9 deletions sdk/src/Services/Backup/Generated/Model/BackupRuleInput.cs
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,13 @@ internal bool IsSetEnableContinuousBackup()
/// Backups transitioned to cold storage must be stored in cold storage for a minimum
/// of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition
/// to cold after days” setting. The “transition to cold after days” setting cannot be
/// changed after a backup has been transitioned to cold.
/// changed after a backup has been transitioned to cold storage.
/// </para>
///
/// <para>
/// Resource types that are able to be transitioned to cold storage are listed in the
/// "Lifecycle to cold storage" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource">
/// Feature availability by resource</a> table. Backup ignores this expression for other
/// resource types.
/// Resource types that can transition to cold storage are listed in the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource">Feature
/// availability by resource</a> table. Backup ignores this expression for other resource
/// types.
/// </para>
///
/// <para>
Expand All @@ -143,8 +142,7 @@ internal bool IsSetLifecycle()
/// <summary>
/// Gets and sets the property RecoveryPointTags.
/// <para>
/// To help organize your resources, you can assign your own metadata to the resources
/// that you create. Each tag is a key-value pair.
/// The tags to assign to the resources.
/// </para>
/// </summary>
[AWSProperty(Sensitive=true)]
Expand Down Expand Up @@ -200,7 +198,7 @@ internal bool IsSetScheduleExpression()
/// <summary>
/// Gets and sets the property ScheduleExpressionTimezone.
/// <para>
/// This is the timezone in which the schedule expression is set. By default, ScheduleExpressions
/// The timezone in which the schedule expression is set. By default, ScheduleExpressions
/// are in UTC. You can modify this to a specified timezone.
/// </para>
/// </summary>
Expand Down Expand Up @@ -255,7 +253,7 @@ internal bool IsSetStartWindowMinutes()
/// <para>
/// The name of a logical container where backups are stored. Backup vaults are identified
/// by names that are unique to the account used to create them and the Amazon Web Services
/// Region where they are created. They consist of lowercase letters, numbers, and hyphens.
/// Region where they are created.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
Expand Down
64 changes: 30 additions & 34 deletions sdk/src/Services/Backup/Generated/Model/BackupSelection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,14 @@ namespace Amazon.Backup.Model
///
///
/// <para>
/// Specifying your desired <c>Conditions</c>, <c>ListOfTags</c>, <c>NotResources</c>,
/// and/or <c>Resources</c> is recommended. If none of these are specified, Backup will
/// attempt to select all supported and opted-in storage resources, which could have unintended
/// cost implications.
/// We recommend that you specify conditions, tags, or resources to include or exclude.
/// Otherwise, Backup attempts to select all supported and opted-in storage resources,
/// which could have unintended cost implications.
/// </para>
///
/// <para>
/// For more information, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json">Assigning
/// resources programmatically</a>.
/// </para>
/// </summary>
public partial class BackupSelection
Expand All @@ -52,25 +56,19 @@ public partial class BackupSelection
/// <summary>
/// Gets and sets the property Conditions.
/// <para>
/// A list of conditions that you define to assign resources to your backup plans using
/// tags. For example, <c>"StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value":
/// "true" },</c>. Condition operators are case sensitive.
/// The conditions that you define to assign resources to your backup plans using tags.
/// For example, <c>"StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue":
/// "daily" }</c>.
/// </para>
///
/// <para>
/// <c>Conditions</c> differs from <c>ListOfTags</c> as follows:
/// </para>
/// <ul> <li>
/// <para>
/// When you specify more than one condition, you only assign the resources that match
/// ALL conditions (using AND logic).
/// <c>Conditions</c> supports <c>StringEquals</c>, <c>StringLike</c>, <c>StringNotEquals</c>,
/// and <c>StringNotLike</c>. Condition operators are case sensitive.
/// </para>
/// </li> <li>
///
/// <para>
/// <c>Conditions</c> supports <c>StringEquals</c>, <c>StringLike</c>, <c>StringNotEquals</c>,
/// and <c>StringNotLike</c>. <c>ListOfTags</c> only supports <c>StringEquals</c>.
/// If you specify multiple conditions, the resources much match all conditions (AND logic).
/// </para>
/// </li> </ul>
/// </summary>
public Conditions Conditions
{
Expand Down Expand Up @@ -107,25 +105,19 @@ internal bool IsSetIamRoleArn()
/// <summary>
/// Gets and sets the property ListOfTags.
/// <para>
/// A list of conditions that you define to assign resources to your backup plans using
/// tags. For example, <c>"StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value":
/// "true" },</c>. Condition operators are case sensitive.
/// The conditions that you define to assign resources to your backup plans using tags.
/// For example, <c>"StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}</c>.
/// </para>
///
/// <para>
/// <c>ListOfTags</c> differs from <c>Conditions</c> as follows:
/// </para>
/// <ul> <li>
/// <para>
/// When you specify more than one condition, you assign all resources that match AT LEAST
/// ONE condition (using OR logic).
/// <c>ListOfTags</c> supports only <c>StringEquals</c>. Condition operators are case
/// sensitive.
/// </para>
/// </li> <li>
///
/// <para>
/// <c>ListOfTags</c> only supports <c>StringEquals</c>. <c>Conditions</c> supports <c>StringEquals</c>,
/// <c>StringLike</c>, <c>StringNotEquals</c>, and <c>StringNotLike</c>.
/// If you specify multiple conditions, the resources much match any of the conditions
/// (OR logic).
/// </para>
/// </li> </ul>
/// </summary>
public List<Condition> ListOfTags
{
Expand All @@ -142,8 +134,8 @@ internal bool IsSetListOfTags()
/// <summary>
/// Gets and sets the property NotResources.
/// <para>
/// A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum
/// number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
/// The Amazon Resource Names (ARNs) of the resources to exclude from a backup plan. The
/// maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
/// </para>
///
/// <para>
Expand All @@ -167,15 +159,19 @@ internal bool IsSetNotResources()
/// <summary>
/// Gets and sets the property Resources.
/// <para>
/// A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number
/// of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
/// The Amazon Resource Names (ARNs) of the resources to assign to a backup plan. The
/// maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
/// </para>
///
/// <para>
/// If you need to assign many resources to a backup plan, consider a different resource
/// selection strategy, such as assigning all resources of a resource type or refining
/// your resource selection using tags.
/// </para>
///
/// <para>
/// If you specify multiple ARNs, the resources much match any of the ARNs (OR logic).
/// </para>
/// </summary>
public List<string> Resources
{
Expand Down
42 changes: 40 additions & 2 deletions sdk/src/Services/Backup/Generated/Model/BackupVaultListMember.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,14 @@ public partial class BackupVaultListMember
private long? _maxRetentionDays;
private long? _minRetentionDays;
private long? _numberOfRecoveryPoints;
private VaultState _vaultState;
private VaultType _vaultType;

/// <summary>
/// Gets and sets the property BackupVaultArn.
/// <para>
/// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
/// <c>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</c>.
/// <c>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</c>.
/// </para>
/// </summary>
public string BackupVaultArn
Expand All @@ -69,7 +71,7 @@ internal bool IsSetBackupVaultArn()
/// <para>
/// The name of a logical container where backups are stored. Backup vaults are identified
/// by names that are unique to the account used to create them and the Amazon Web Services
/// Region where they are created. They consist of lowercase letters, numbers, and hyphens.
/// Region where they are created.
/// </para>
/// </summary>
public string BackupVaultName
Expand Down Expand Up @@ -281,5 +283,41 @@ internal bool IsSetNumberOfRecoveryPoints()
return this._numberOfRecoveryPoints.HasValue;
}

/// <summary>
/// Gets and sets the property VaultState.
/// <para>
/// The current state of the vault.
/// </para>
/// </summary>
public VaultState VaultState
{
get { return this._vaultState; }
set { this._vaultState = value; }
}

// Check to see if VaultState property is set
internal bool IsSetVaultState()
{
return this._vaultState != null;
}

/// <summary>
/// Gets and sets the property VaultType.
/// <para>
/// The type of vault in which the described recovery point is stored.
/// </para>
/// </summary>
public VaultType VaultType
{
get { return this._vaultType; }
set { this._vaultType = value; }
}

// Check to see if VaultType property is set
internal bool IsSetVaultType()
{
return this._vaultType != null;
}

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,9 @@ namespace Amazon.Backup.Model
/// </para>
///
/// <para>
/// Resource types that are able to be transitioned to cold storage are listed in the
/// "Lifecycle to cold storage" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource">
/// Feature availability by resource</a> table. Backup ignores this expression for other
/// resource types.
/// Resource types that can transition to cold storage are listed in the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource">Feature
/// availability by resource</a> table. Backup ignores this expression for other resource
/// types.
/// </para>
/// </summary>
public partial class CalculatedLifecycle
Expand Down
Loading

0 comments on commit 4b3e374

Please sign in to comment.