AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

StartBackupJobInput

import "github.com/aws/aws-sdk-go/service/backup"

type StartBackupJobInput struct { BackupVaultName *string `type:"string" required:"true"` CompleteWindowMinutes *int64 `type:"long"` IamRoleArn *string `type:"string" required:"true"` IdempotencyToken *string `type:"string"` Lifecycle *Lifecycle `type:"structure"` RecoveryPointTags map[string]*string `type:"map" sensitive:"true"` ResourceArn *string `type:"string" required:"true"` StartWindowMinutes *int64 `type:"long"` }

BackupVaultName

Type: *string

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.

BackupVaultName is a required field

CompleteWindowMinutes

Type: *int64

The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

IamRoleArn

Type: *string

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

IamRoleArn is a required field

IdempotencyToken

Type: *string

A customer chosen string that can be used to distinguish between calls to StartBackupJob. Idempotency tokens time out after one hour. Therefore, if you call StartBackupJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.

Lifecycle

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

RecoveryPointTags

Type: map[string]*string

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

ResourceArn

Type: *string

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

ResourceArn is a required field

StartWindowMinutes

Type: *int64

The amount of time in minutes before beginning a backup.

Method

GoString

func (s StartBackupJobInput) GoString() string

GoString returns the string representation

SetBackupVaultName

func (s *StartBackupJobInput) SetBackupVaultName(v string) *StartBackupJobInput

SetBackupVaultName sets the BackupVaultName field's value.

SetCompleteWindowMinutes

func (s *StartBackupJobInput) SetCompleteWindowMinutes(v int64) *StartBackupJobInput

SetCompleteWindowMinutes sets the CompleteWindowMinutes field's value.

SetIamRoleArn

func (s *StartBackupJobInput) SetIamRoleArn(v string) *StartBackupJobInput

SetIamRoleArn sets the IamRoleArn field's value.

SetIdempotencyToken

func (s *StartBackupJobInput) SetIdempotencyToken(v string) *StartBackupJobInput

SetIdempotencyToken sets the IdempotencyToken field's value.

SetLifecycle

func (s *StartBackupJobInput) SetLifecycle(v *Lifecycle) *StartBackupJobInput

SetLifecycle sets the Lifecycle field's value.

SetRecoveryPointTags

func (s *StartBackupJobInput) SetRecoveryPointTags(v map[string]*string) *StartBackupJobInput

SetRecoveryPointTags sets the RecoveryPointTags field's value.

SetResourceArn

func (s *StartBackupJobInput) SetResourceArn(v string) *StartBackupJobInput

SetResourceArn sets the ResourceArn field's value.

SetStartWindowMinutes

func (s *StartBackupJobInput) SetStartWindowMinutes(v int64) *StartBackupJobInput

SetStartWindowMinutes sets the StartWindowMinutes field's value.

String

func (s StartBackupJobInput) String() string

String returns the string representation

Validate

func (s *StartBackupJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: