Revoke Snapshot Access

redshift_revoke_snapshot_access

R Documentation

Removes the ability of the specified Amazon Web Services account to restore the specified snapshot¶

Description¶

Removes the ability of the specified Amazon Web Services account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.

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

Usage¶

redshift_revoke_snapshot_access(SnapshotIdentifier, SnapshotArn,
  SnapshotClusterIdentifier, AccountWithRestoreAccess)

Arguments¶

SnapshotIdentifier

The identifier of the snapshot that the account can no longer access.

SnapshotArn

The Amazon Resource Name (ARN) of the snapshot associated with the message to revoke access.

SnapshotClusterIdentifier

The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

AccountWithRestoreAccess

[required] The identifier of the Amazon Web Services account that can no longer restore the specified snapshot.

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$revoke_snapshot_access(
  SnapshotIdentifier = "string",
  SnapshotArn = "string",
  SnapshotClusterIdentifier = "string",
  AccountWithRestoreAccess = "string"
)