authorize-snapshot-access¶

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 .

Synopsis¶

  authorize-snapshot-access
[--snapshot-identifier <value>]
[--snapshot-arn <value>]
[--snapshot-cluster-identifier <value>]
--account-with-restore-access <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--snapshot-identifier (string)

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

--snapshot-arn (string)

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

--snapshot-cluster-identifier (string)

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.

--account-with-restore-access (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Authorize an AWS Account to Restore a Snapshot¶

This example authorizes the AWS account 444455556666 to restore the snapshot my-snapshot-id. By default, the output is in JSON format.

Command:

aws redshift authorize-snapshot-access --snapshot-id my-snapshot-id --account-with-restore-access 444455556666

Result:

{
   "Snapshot": {
      "Status": "available",
      "SnapshotCreateTime": "2013-07-17T22:04:18.947Z",
      "EstimatedSecondsToCompletion": 0,
      "AvailabilityZone": "us-east-1a",
      "ClusterVersion": "1.0",
      "MasterUsername": "adminuser",
      "Encrypted": false,
      "OwnerAccount": "111122223333",
      "BackupProgressInMegabytes": 11.0,
      "ElapsedTimeInSeconds": 0,
      "DBName": "dev",
      "CurrentBackupRateInMegabytesPerSecond: 0.1534,
      "ClusterCreateTime": "2013-01-22T21:59:29.559Z",
      "ActualIncrementalBackupSizeInMegabytes"; 11.0,
      "SnapshotType": "manual",
      "NodeType": "dw.hs1.xlarge",
      "ClusterIdentifier": "mycluster",
      "TotalBackupSizeInMegabytes": 20.0,
      "Port": 5439,
      "NumberOfNodes": 2,
      "SnapshotIdentifier": "my-snapshot-id"
   }
}

Output¶

Snapshot -> (structure)

Describes a snapshot.

SnapshotIdentifier -> (string)

The snapshot identifier that is provided in the request.

ClusterIdentifier -> (string)

The identifier of the cluster for which the snapshot was taken.

SnapshotCreateTime -> (timestamp)

The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Status -> (string)

The snapshot status. The value of the status depends on the API operation used:

CreateClusterSnapshot and CopyClusterSnapshot returns status as “creating”.

DescribeClusterSnapshots returns status as “creating”, “available”, “final snapshot”, or “failed”.

DeleteClusterSnapshot returns status as “deleted”.

Port -> (integer)

The port that the cluster is listening on.

AvailabilityZone -> (string)

The Availability Zone in which the cluster was created.

ClusterCreateTime -> (timestamp)

The time (UTC) when the cluster was originally created.

MasterUsername -> (string)

The admin user name for the cluster.

ClusterVersion -> (string)

The version ID of the Amazon Redshift engine that is running on the cluster.

EngineFullVersion -> (string)

The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

SnapshotType -> (string)

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type “manual”.

NodeType -> (string)

The node type of the nodes in the cluster.

NumberOfNodes -> (integer)

The number of nodes in the cluster.

DBName -> (string)

The name of the database that was created when the cluster was created.

VpcId -> (string)

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Encrypted -> (boolean)

If true , the data in the snapshot is encrypted at rest.

KmsKeyId -> (string)

The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

EncryptedWithHSM -> (boolean)

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

AccountsWithRestoreAccess -> (list)

A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

(structure)

Describes an Amazon Web Services account authorized to restore a snapshot.

AccountId -> (string)

The identifier of an Amazon Web Services account authorized to restore a snapshot.

AccountAlias -> (string)

The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support .

OwnerAccount -> (string)

For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

TotalBackupSizeInMegaBytes -> (double)

The size of the complete set of backup data that would be used to restore the cluster.

ActualIncrementalBackupSizeInMegaBytes -> (double)

The size of the incremental backup.

BackupProgressInMegaBytes -> (double)

The number of megabytes that have been transferred to the snapshot backup.

CurrentBackupRateInMegaBytesPerSecond -> (double)

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

EstimatedSecondsToCompletion -> (long)

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

ElapsedTimeInSeconds -> (long)

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

SourceRegion -> (string)

The source region from which the snapshot was copied.

Tags -> (list)

The list of tags for the cluster snapshot.

(structure)

A tag consisting of a name/value pair for a resource.

Key -> (string)

The key, or name, for the resource tag.

Value -> (string)

The value for the resource tag.

RestorableNodeTypes -> (list)

The list of node types that this cluster snapshot is able to restore into.

(string)

EnhancedVpcRouting -> (boolean)

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true , enhanced VPC routing is enabled.

Default: false

MaintenanceTrackName -> (string)

The name of the maintenance track for the snapshot.

ManualSnapshotRetentionPeriod -> (integer)

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

ManualSnapshotRemainingDays -> (integer)

The number of days until a manual snapshot will pass its retention period.

SnapshotRetentionStartTime -> (timestamp)

A timestamp representing the start of the retention period for the snapshot.

Table of Contents

Feedback

User Guide