Synopsis
Calls the Amazon DocumentDB CopyDBClusterSnapshot API operation.
Syntax
Copy-DOCDBClusterSnapshot-TargetDBClusterSnapshotIdentifier <String>-CopyTag <Boolean>-KmsKeyId <String>-PreSignedUrl <String>-SourceDBClusterSnapshotIdentifier <String>-Tag <Tag[]>-Force <SwitchParameter>
Description
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
To cancel the copy operation after it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in the copying status. Parameters
-CopyTag <Boolean>
Set to
true to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | CopyTags |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-KmsKeyId <String>
The AWS KMS key ID for an encrypted DB cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key. If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for
KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same AWS KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId. To copy an encrypted DB cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the DB cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region in another Region.If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-PreSignedUrl <String>
The URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. You must use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another AWS Region.The presigned URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL request must contain the following parameter values:KmsKeyId- The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both theCopyDBClusterSnapshotaction that is called in the destination AWS Region, and the action contained in the presigned URL.DestinationRegion- The name of the AWS Region that the DB cluster snapshot will be created in.SourceDBClusterSnapshotIdentifier- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then yourSourceDBClusterSnapshotIdentifierlooks like the following example:arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SourceDBClusterSnapshotIdentifier <String>
The identifier of the DB cluster snapshot to copy. This parameter is not case sensitive.You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.Constraints:
- Must specify a valid system snapshot in the "available" state.
- If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.
- If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN.
my-cluster-snapshot1 | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Tag <Tag[]>
The tags to be assigned to the DB cluster snapshot.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Tags |
-TargetDBClusterSnapshotIdentifier <String>
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case sensitive.Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
my-cluster-snapshot2 | Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a String object to this cmdlet for the TargetDBClusterSnapshotIdentifier parameter.
Outputs
This cmdlet returns a Amazon.DocDB.Model.DBClusterSnapshot object.
The service call response (type Amazon.DocDB.Model.CopyDBClusterSnapshotResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
