Redgate Monitor 14

Creates a new temporary object that holds information about an Amazon RDS Aurora cluster.

Syntax

New-RedgateMonitorAmazonRdsHost -FullName <string> -BaseMonitor <BaseMonitor> [-Group <Group>] [<CommonParameters>]

New-RedgateMonitorAmazonRdsHost -FullName <string> -BaseMonitor <BaseMonitor> -ApiRoleIdentifier <string> [-Group <Group>] [-AwsRegion <string>] [-DbInstanceIdentifier <string>] [<CommonParameters>]

New-RedgateMonitorAmazonRdsHost -FullName <string> -BaseMonitor <BaseMonitor> -ApiRoleInstanceProfile [-Group <Group>] [-AwsRegion <string>] [-DbInstanceIdentifier <string>] [<CommonParameters>]

New-RedgateMonitorAmazonRdsHost -FullName <string> -BaseMonitor <BaseMonitor> -ApiAccessKey <string> -ApiSecretKey <string> [-Group <Group>] [-AwsRegion <string>] [-DbInstanceIdentifier <string>] [<CommonParameters>]

Description

The New-RedgateMonitorAmazonRdsHost cmdlet creates a new temporary object that holds information about an Amazon RDS Aurora cluster. The returned object needs to be passed to Add-RedgateMonitorMonitoredObject, as it does not add anything to Redgate Monitor on its own.

Parameters

`-FullName <String>`

The address of the monitored object e.g. "sample.id.us-west-1.rds.amazonaws.com".

Aliases	None
Required?	true
Position?	named
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/monitor14/api/powershell-api/powershell-cmdlet-reference/get-redgatemonitorbasemonitor.

Aliases	None
Required?	true
Position?	named
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?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-ApiAccessKey <String>`

The AWS web service API access key.

Aliases	None
Required?	true
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-ApiSecretKey <String>`

The AWS web service API secret key.

Aliases	None
Required?	true
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-ApiRoleIdentifier <String>`

The identifer (ARN) of the role with permission to access to the AWS API. Defaults to the role associated with the instance if blank.

Aliases	None
Required?	true
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-ApiRoleInstanceProfile <SwitchParameter>`

Determines if the Base Monitor's EC2 instance profile (attached role) should be used as the IAM role to query the AWS API.

Aliases	None
Required?	true
Position?	named
Default Value	False
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-AwsRegion <String>`

The region where the AWS web service is hosted.

Aliases	None
Required?	false
Position?	named
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?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-ProgressAction <ActionPreference>`

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-RedgateMonitorAmazonRdsHost -HostName "localhost" -BaseMonitor $BaseMonitor -ApiAccessKey "access_key" -ApiSecretKey "secret_key"
$instance = New-RedgateMonitorPostgreSql -FullName "localhost" -BaseMonitor $BaseMonitor -UserName "pg_username" -Password "pg_pass" -Port 5432
$server, $instance | Add-RedgateMonitorMonitoredObject