/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Backup::StartBackupJob

NAME

Paws::Backup::StartBackupJob - Arguments for method StartBackupJob on Paws::Backup

DESCRIPTION

This class represents the parameters used for calling the method StartBackupJob on the AWS Backup service. Use the attributes of this class as arguments to method StartBackupJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartBackupJob.

SYNOPSIS

my $backup = Paws->service('Backup');
my $StartBackupJobOutput = $backup->StartBackupJob(
  BackupVaultName => 'MyBackupVaultName',
  IamRoleArn      => 'MyIAMRoleArn',
  ResourceArn     => 'MyARN',
  BackupOptions   => { 'MyBackupOptionKey' => 'MyBackupOptionValue', }
  ,                                       # OPTIONAL
  CompleteWindowMinutes => 1,             # OPTIONAL
  IdempotencyToken      => 'Mystring',    # OPTIONAL
  Lifecycle             => {
    DeleteAfterDays            => 1,      # OPTIONAL
    MoveToColdStorageAfterDays => 1,      # OPTIONAL
  },    # OPTIONAL
  RecoveryPointTags  => { 'MyTagKey' => 'MyTagValue', },    # OPTIONAL
  StartWindowMinutes => 1,                                  # OPTIONAL
);

# Results:
my $BackupJobId      = $StartBackupJobOutput->BackupJobId;
my $CreationDate     = $StartBackupJobOutput->CreationDate;
my $RecoveryPointArn = $StartBackupJobOutput->RecoveryPointArn;

# Returns a L<Paws::Backup::StartBackupJobOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/backup/StartBackupJob

ATTRIBUTES

BackupOptions => Paws::Backup::BackupOptions

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.

REQUIRED BackupVaultName => Str

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.

CompleteWindowMinutes => Int

A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

REQUIRED IamRoleArn => Str

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

IdempotencyToken => Str

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

Lifecycle => Paws::Backup::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.

Only Amazon EFS file system backups can be transitioned to cold storage.

RecoveryPointTags => Paws::Backup::Tags

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

REQUIRED ResourceArn => Str

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

StartWindowMinutes => Int

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, and the default is 8 hours.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartBackupJob in Paws::Backup

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues