-BacktrackWindow <Int64>
The target backtrack window, in seconds. To disable backtracking, set this value to 0.Default: 0Constraints:
- If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Amazon.PowerShell.Cmdlets.RDS.AmazonRDSClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
The name of the new DB cluster to be created.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
Valid 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 custom DB cluster parameter group to associate with this DB cluster.If the
DBClusterParameterGroupName parameter is omitted, the default DB cluster parameter group for the specified engine is used.Constraints:
- If supplied, must match the name of an existing 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) |
The DB subnet group name to use for the new DB cluster.Constraints: If supplied, must match the name of an existing DBSubnetGroup.Example: mydbsubnetgroupValid for: Aurora DB clusters and Multi-AZ DB clusters
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see
Kerberos Authentication in the
Amazon Aurora User Guide.Valid for: Aurora DB clusters only
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
The list of logs that the restored DB cluster is to export to 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
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EnableCloudwatchLogsExports |
-EnableIAMDatabaseAuthentication <
Boolean>
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) |
Aliases | EnablePerformanceInsights |
-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) |
The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify the engine mode serverless.Valid for: Aurora DB clusters only
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
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: Multi-AZ DB clusters only
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.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.You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the
KmsKeyId parameter.If you don't specify a value for the
KmsKeyId parameter, then the following occurs:
- If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
- If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If
DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.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) |
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) |
The network type of the DB cluster.Valid Values:
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) |
The name of the option group for the new 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) |
The port number on which the new DB cluster accepts connections.Constraints: A value from 1150-65535.Default: The default port for the engine.Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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: Multi-AZ DB clusters only
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) |
-RestoreToTime <DateTime>
The date and time to restore the DB cluster to.Valid Values: Value must be a time in Universal Coordinated Time (UTC) formatConstraints:
- Must be before the latest restorable time for the DB instance
- Must be specified if UseLatestRestorableTime parameter isn't provided
- Can't be specified if the UseLatestRestorableTime parameter is enabled
- Can't be specified if the RestoreType parameter is copy-on-write
Example:
2015-03-07T23:45:00ZValid for: Aurora DB clusters and Multi-AZ DB clusters
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The type of restore to be performed. You can specify one of the following values:
- full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
- copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
If you don't specify a
RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.Valid for: Aurora DB clusters and Multi-AZ DB clusters
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) |
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.RestoreDBClusterToPointInTimeResponse). Specifying the name of a property of type Amazon.RDS.Model.RestoreDBClusterToPointInTimeResponse 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.
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) |
-SourceDBClusterIdentifier <
String>
The identifier of the source DB cluster from which to restore.Constraints:
- Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-SourceDbClusterResourceId <
String>
The resource ID of the source DB cluster from which to restore.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.Constraints: Can't be specified if RestoreToTime parameter is provided.Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A list of VPC security groups that the new DB cluster belongs to.Valid for: Aurora DB clusters and Multi-AZ DB clusters
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | VpcSecurityGroupIds |