AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartBackupJob operation. Starts a job to create a one-time backup of the specified resource.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Backup.AmazonBackupRequest
      Amazon.Backup.Model.StartBackupJobRequest

Namespace: Amazon.Backup.Model
Assembly: AWSSDK.Backup.dll
Version: 3.x.y.z

Syntax

C#
public class StartBackupJobRequest : AmazonBackupRequest
         IAmazonWebServiceRequest

The StartBackupJobRequest type exposes the following members

Constructors

NameDescription
Public Method StartBackupJobRequest()

Properties

NameTypeDescription
Public Property BackupVaultName System.String

Gets and sets the property BackupVaultName.

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Public Property CompleteWindowMinutes System.Int64

Gets and sets the property CompleteWindowMinutes.

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.

Public Property IamRoleArn System.String

Gets and sets the property IamRoleArn.

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Public Property IdempotencyToken System.String

Gets and sets the property IdempotencyToken.

A customer chosen string that can be used to distinguish between calls to StartBackupJob.

Public Property Lifecycle Amazon.Backup.Model.Lifecycle

Gets and sets the property Lifecycle.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” 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.

Public Property RecoveryPointTags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property RecoveryPointTags.

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Public Property ResourceArn System.String

Gets and sets the property ResourceArn.

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Public Property StartWindowMinutes System.Int64

Gets and sets the property StartWindowMinutes.

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

Version Information

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms