AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Relational Database Service RestoreDBClusterFromSnapshot API operation.

Syntax

Restore-RDSDBClusterFromSnapshot
-DBClusterIdentifier <String>
-ScalingConfiguration_AutoPause <Boolean>
-AvailabilityZone <String[]>
-BacktrackWindow <Int64>
-CopyTagsToSnapshot <Boolean>
-DatabaseName <String>
-DBClusterInstanceClass <String>
-DBClusterParameterGroupName <String>
-DBSubnetGroupName <String>
-DeletionProtection <Boolean>
-Domain <String>
-DomainIAMRoleName <String>
-EnableCloudwatchLogsExport <String[]>
-EnableIAMDatabaseAuthentication <Boolean>
-EnablePerformanceInsight <Boolean>
-Engine <String>
-EngineLifecycleSupport <String>
-EngineMode <String>
-EngineVersion <String>
-RdsCustomClusterConfiguration_InterconnectSubnetId <String>
-Iops <Int32>
-KmsKeyId <String>
-ScalingConfiguration_MaxCapacity <Int32>
-ServerlessV2ScalingConfiguration_MaxCapacity <Double>
-ScalingConfiguration_MinCapacity <Int32>
-ServerlessV2ScalingConfiguration_MinCapacity <Double>
-MonitoringInterval <Int32>
-MonitoringRoleArn <String>
-NetworkType <String>
-OptionGroupName <String>
-PerformanceInsightsKMSKeyId <String>
-PerformanceInsightsRetentionPeriod <Int32>
-Port <Int32>
-PubliclyAccessible <Boolean>
-RdsCustomClusterConfiguration_ReplicaMode <ReplicaMode>
-ScalingConfiguration_SecondsBeforeTimeout <Int32>
-ScalingConfiguration_SecondsUntilAutoPause <Int32>
-ServerlessV2ScalingConfiguration_SecondsUntilAutoPause <Int32>
-SnapshotIdentifier <String>
-StorageType <String>
-Tag <Tag[]>
-ScalingConfiguration_TimeoutAction <String>
-RdsCustomClusterConfiguration_TransitGatewayMulticastDomainId <String>
-VpcSecurityGroupId <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonRDSConfig>

Description

Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameters

-AvailabilityZone <String[]>
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.Valid for: Aurora DB clusters only Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvailabilityZones
-BacktrackWindow <Int64>
The target backtrack window, in seconds. To disable backtracking, set this value to 0.Currently, Backtrack is only supported for Aurora MySQL DB clusters.Default: 0Constraints:
  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonRDSConfig>
Amazon.PowerShell.Cmdlets.RDS.AmazonRDSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CopyTagsToSnapshot <Boolean>
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatabaseName <String>
The database name for the restored DB cluster.Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterIdentifier <String>
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.Constraints:
  • Must contain from 1 to 63 letters, numbers, or hyphens
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-idValid for: Aurora DB clusters and Multi-AZ DB clusters
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DBClusterInstanceClass <String>
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.Valid for: Multi-AZ DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterParameterGroupName <String>
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.Constraints:
  • If supplied, must match the name of an existing default DB cluster parameter group.
  • Must be 1 to 255 letters, numbers, or hyphens.
  • First character must be a letter.
  • Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBSubnetGroupName <String>
The name of the DB subnet group to use for the new DB cluster.Constraints: If supplied, must match the name of an existing DB subnet group.Example: mydbsubnetgroupValid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtection <Boolean>
Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Domain <String>
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.For more information, see Kerberos Authentication in the Amazon RDS User Guide.Valid for: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainIAMRoleName <String>
The name of the IAM role to be used when making API calls to the Directory Service.Valid for: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableCloudwatchLogsExport <String[]>
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.RDS for MySQLPossible values are error, general, slowquery, and iam-db-auth-error.RDS for PostgreSQLPossible values are postgresql, upgrade, and iam-db-auth-error.Aurora MySQLPossible values are audit, error, general, instance, slowquery, and iam-db-auth-error.Aurora PostgreSQLPossible value are instance, postgresql, and iam-db-auth-error.For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.Valid for: Aurora DB clusters and Multi-AZ DB clusters Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnableCloudwatchLogsExports
-EnableIAMDatabaseAuthentication <Boolean>
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.For more information, see IAM Database Authentication in the Amazon Aurora User Guide or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnablePerformanceInsight <Boolean>
Specifies whether to turn on Performance Insights for the DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnablePerformanceInsights
-Engine <String>
The database engine to use for the new DB cluster.Default: The same as sourceConstraint: Must be compatible with the engine of the sourceValid for: Aurora DB clusters and Multi-AZ DB clusters
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineLifecycleSupport <String>
The life cycle type for this DB cluster.By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clustersValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabledDefault: open-source-rds-extended-support
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineMode <String>
The DB engine mode of the DB cluster, either provisioned or serverless.For more information, see CreateDBCluster.Valid for: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.To list all of the available engine versions for Aurora MySQL, use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"To list all of the available engine versions for Aurora PostgreSQL, use the following command:aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"To list all of the available engine versions for RDS for MySQL, use the following command:aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"To list all of the available engine versions for RDS for PostgreSQL, use the following command:aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"Aurora MySQLSee Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.Aurora PostgreSQLSee Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.MySQLSee Amazon RDS for MySQL in the Amazon RDS User Guide.PostgreSQLSee Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-Iops <Int32>
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <String>
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.When you don't specify a value for the KmsKeyId parameter, then the following occurs:
  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringInterval <Int32>
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitoringRoleArn <String>
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkType <String>
The network type of the DB cluster.Valid Values:
  • IPV4
  • DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.Valid for: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptionGroupName <String>
The name of the option group to use for the restored DB cluster.DB clusters are associated with a default option group that can't be modified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformanceInsightsKMSKeyId <String>
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformanceInsightsRetentionPeriod <Int32>
The number of days to retain Performance Insights data.Valid Values:
  • 7
  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  • 731
Default: 7 daysIf you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The port number on which the new DB cluster accepts connections.Constraints: This value must be 1150-65535Default: The same port as the original DB cluster.Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PubliclyAccessible <Boolean>
Specifies whether the DB cluster is publicly accessible.When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.Default: The default behavior varies depending on whether DBSubnetGroupName is specified.If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
  • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsCustomClusterConfiguration_InterconnectSubnetId <String>
Reserved for future use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsCustomClusterConfiguration_ReplicaMode <ReplicaMode>
Reserved for future use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsCustomClusterConfiguration_TransitGatewayMulticastDomainId <String>
Reserved for future use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_AutoPause <Boolean>
Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_MaxCapacity <Int32>
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The maximum capacity must be greater than or equal to the minimum capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_MinCapacity <Int32>
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The minimum capacity must be less than or equal to the maximum capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_SecondsBeforeTimeout <Int32>
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.Specify a value between 60 and 600 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_SecondsUntilAutoPause <Int32>
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.Specify a value between 300 and 86,400 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_TimeoutAction <String>
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DBCluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.RestoreDBClusterFromSnapshotResponse). Specifying the name of a property of type Amazon.RDS.Model.RestoreDBClusterFromSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerlessV2ScalingConfiguration_MaxCapacity <Double>
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerlessV2ScalingConfiguration_MinCapacity <Double>
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerlessV2ScalingConfiguration_SecondsUntilAutoPause <Int32>
Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnapshotIdentifier <String>
The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.Constraints:
  • Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageType <String>
Specifies the storage type to be associated with the DB cluster.When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The tags to be assigned to the restored DB cluster.Valid for: Aurora DB clusters and Multi-AZ DB clusters Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcSecurityGroupId <String[]>
A list of VPC security groups that the new DB cluster will belong to.Valid for: Aurora DB clusters and Multi-AZ DB clusters Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcSecurityGroupIds

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.RDS.Model.DBCluster or Amazon.RDS.Model.RestoreDBClusterFromSnapshotResponse
This cmdlet returns an Amazon.RDS.Model.DBCluster object. The service call response (type Amazon.RDS.Model.RestoreDBClusterFromSnapshotResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z