Skip to content

Authorize Snapshot Access

redshift_authorize_snapshot_access R Documentation

Authorizes the specified Amazon Web Services account to restore the specified snapshot

Description

Authorizes the specified Amazon Web Services account to restore the specified snapshot.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Usage

redshift_authorize_snapshot_access(SnapshotIdentifier, SnapshotArn,
  SnapshotClusterIdentifier, AccountWithRestoreAccess)

Arguments

SnapshotIdentifier

The identifier of the snapshot the account is authorized to restore.
SnapshotArn

The Amazon Resource Name (ARN) of the snapshot to authorize access to.
SnapshotClusterIdentifier

The identifier of the cluster the snapshot was created from.

  • If the snapshot to access doesn't exist and the associated IAM policy doesn't allow access to all () snapshots* - This parameter is required. Otherwise, permissions aren't available to check if the snapshot exists.

  • If the snapshot to access exists - This parameter isn't required. Redshift can retrieve the cluster identifier and use it to validate snapshot authorization.
AccountWithRestoreAccess

[required] The identifier of the Amazon Web Services account authorized to restore the specified snapshot.

To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.

Value

A list with the following syntax:

list(
  Snapshot = list(
    SnapshotIdentifier = "string",
    ClusterIdentifier = "string",
    SnapshotCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    Status = "string",
    Port = 123,
    AvailabilityZone = "string",
    ClusterCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    MasterUsername = "string",
    ClusterVersion = "string",
    EngineFullVersion = "string",
    SnapshotType = "string",
    NodeType = "string",
    NumberOfNodes = 123,
    DBName = "string",
    VpcId = "string",
    Encrypted = TRUE|FALSE,
    KmsKeyId = "string",
    EncryptedWithHSM = TRUE|FALSE,
    AccountsWithRestoreAccess = list(
      list(
        AccountId = "string",
        AccountAlias = "string"
      )
    ),
    OwnerAccount = "string",
    TotalBackupSizeInMegaBytes = 123.0,
    ActualIncrementalBackupSizeInMegaBytes = 123.0,
    BackupProgressInMegaBytes = 123.0,
    CurrentBackupRateInMegaBytesPerSecond = 123.0,
    EstimatedSecondsToCompletion = 123,
    ElapsedTimeInSeconds = 123,
    SourceRegion = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    RestorableNodeTypes = list(
      "string"
    ),
    EnhancedVpcRouting = TRUE|FALSE,
    MaintenanceTrackName = "string",
    ManualSnapshotRetentionPeriod = 123,
    ManualSnapshotRemainingDays = 123,
    SnapshotRetentionStartTime = as.POSIXct(
      "2015-01-01"
    ),
    MasterPasswordSecretArn = "string",
    MasterPasswordSecretKmsKeyId = "string",
    SnapshotArn = "string"
  )
)

Request syntax

svc$authorize_snapshot_access(
  SnapshotIdentifier = "string",
  SnapshotArn = "string",
  SnapshotClusterIdentifier = "string",
  AccountWithRestoreAccess = "string"
)