Synopsis
Calls the Amazon Relational Database Service DescribeDBClusterSnapshots API operation.
Syntax
Get-RDSDBClusterSnapshot-DBClusterIdentifier <String>-DBClusterSnapshotIdentifier <String>-Filter <Filter[]>-IncludePublic <Boolean>-IncludeShared <Boolean>-SnapshotType <String>-Marker <String>-MaxRecord <Int32>
Description
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
Parameters
-DBClusterIdentifier <String>
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the
DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive. Constraints:- If supplied, must match the identifier of an existing DBCluster.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DBClusterSnapshotIdentifier <String>
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the
DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints:- If supplied, must match the identifier of an existing DBClusterSnapshot.
- If this identifier is for an automated snapshot, the
SnapshotTypeparameter must also be specified.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Filter <Filter[]>
This parameter is not currently supported.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filters |
-IncludePublic <Boolean>
True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is
false. The default is false.You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-IncludeShared <Boolean>
True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is
false.You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Marker <String>
An optional pagination token provided by a previous
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter.
DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | NextToken |
-MaxRecord <Int32>
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: Minimum 20, maximum 100. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | MaxItems, MaxRecords |
-SnapshotType <String>
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.manual- Return all DB cluster snapshots that have been taken by my AWS account.shared- Return all manual DB cluster snapshots that have been shared to my AWS account.public- Return all DB cluster snapshots that have been marked as public.
SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
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
This cmdlet does not accept pipeline input.
Outputs
This cmdlet returns a collection of DBClusterSnapshot objects.
The service call response (type Amazon.RDS.Model.DescribeDBClusterSnapshotsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
