These pages cover SQL Monitor 13, which is not the latest version. Help for other versions is also available.
New-SqlMonitorAmazonRdsHost
Published 21 March 2023
Creates a new temporary object that holds information about an Amazon RDS Aurora cluster.
Syntax
- New-SqlMonitorAmazonRdsHost [-FullName] <string> [-BaseMonitor] <BaseMonitor> [[-Group] <Group>] [[-ApiAccessKey] <string>] [[-ApiSecretKey] <string>] [[-AwsRegion] <string>] [[-DbInstanceIdentifier] <string>] [<CommonParameters>]
Description
The New-SqlMonitorAmazonRdsHost cmdlet creates a new temporary object that holds information about an Amazon RDS Aurora cluster. The returned object needs to be passed to Add-SqlMonitorMonitoredObject, as it does not add anything to SQL Monitor on its own.
Parameters
-FullName
<String>
The address of the monitored object e.g. "sample.rds.amazonaws.com".
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-BaseMonitor
<BaseMonitor>
The base monitor to add the monitored object to. For more informatiom, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorbasemonitor.
| Aliases | None |
| Required? | true |
| Position? | 2 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Group
<Group>
Group object - use Get-Group or related methods to find the group.
| Aliases | None |
| Required? | false |
| Position? | 3 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ApiAccessKey
<String>
The AWS web service API access key.
| Aliases | None |
| Required? | false |
| Position? | 4 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ApiSecretKey
<String>
The AWS web service API secret key.
| Aliases | None |
| Required? | false |
| Position? | 5 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-AwsRegion
<String>
The region where the AWS web service is hosted.
| Aliases | None |
| Required? | false |
| Position? | 6 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-DbInstanceIdentifier
<String>
The db instance identifier of the RDS instance.
| Aliases | None |
| Required? | false |
| Position? | 7 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ProgressAction
<ActionPreference>
{{ Fill ProgressAction Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
None.
You cannot pipe input to this cmdlet.
Examples
-------------------------- EXAMPLE 1 --------------------------
- $server = New-SqlMonitorAmazonRdsHost -HostName "localhost" -BaseMonitor $BaseMonitor -ApiAccessKey "access_key" -ApiSecretKey "secret_key"
- $instance = New-SqlMonitorPostgreSql -FullName "localhost" -BaseMonitor $BaseMonitor -UserName "pg_username" -Password "pg_pass" -Port 5432
- $server, $instance | Add-SqlMonitorMonitoredObject
