Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getMonitoredResource

This data source provides details about a specific Monitored Resource resource in Oracle Cloud Infrastructure Stack Monitoring service.

Gets a monitored resource by identifier

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testMonitoredResource = Output.Create(Oci.StackMonitoring.GetMonitoredResource.InvokeAsync(new Oci.StackMonitoring.GetMonitoredResourceArgs
        {
            MonitoredResourceId = oci_stack_monitoring_monitored_resource.Test_monitored_resource.Id,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/StackMonitoring"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := StackMonitoring.GetMonitoredResource(ctx, &stackmonitoring.GetMonitoredResourceArgs{
			MonitoredResourceId: oci_stack_monitoring_monitored_resource.Test_monitored_resource.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_monitored_resource = oci.StackMonitoring.get_monitored_resource(monitored_resource_id=oci_stack_monitoring_monitored_resource["test_monitored_resource"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMonitoredResource = oci.StackMonitoring.getMonitoredResource({
    monitoredResourceId: oci_stack_monitoring_monitored_resource.test_monitored_resource.id,
});

Coming soon!

Using getMonitoredResource

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMonitoredResource(args: GetMonitoredResourceArgs, opts?: InvokeOptions): Promise<GetMonitoredResourceResult>
function getMonitoredResourceOutput(args: GetMonitoredResourceOutputArgs, opts?: InvokeOptions): Output<GetMonitoredResourceResult>
def get_monitored_resource(monitored_resource_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetMonitoredResourceResult
def get_monitored_resource_output(monitored_resource_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetMonitoredResourceResult]
func GetMonitoredResource(ctx *Context, args *GetMonitoredResourceArgs, opts ...InvokeOption) (*GetMonitoredResourceResult, error)
func GetMonitoredResourceOutput(ctx *Context, args *GetMonitoredResourceOutputArgs, opts ...InvokeOption) GetMonitoredResourceResultOutput

> Note: This function is named GetMonitoredResource in the Go SDK.

public static class GetMonitoredResource 
{
    public static Task<GetMonitoredResourceResult> InvokeAsync(GetMonitoredResourceArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitoredResourceResult> Invoke(GetMonitoredResourceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMonitoredResourceResult> getMonitoredResource(GetMonitoredResourceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:StackMonitoring/getMonitoredResource:getMonitoredResource
  Arguments:
    # Arguments dictionary

The following arguments are supported:

MonitoredResourceId string

The OCID of monitored resource.

MonitoredResourceId string

The OCID of monitored resource.

monitoredResourceId String

The OCID of monitored resource.

monitoredResourceId string

The OCID of monitored resource.

monitored_resource_id str

The OCID of monitored resource.

monitoredResourceId String

The OCID of monitored resource.

getMonitoredResource Result

The following output properties are available:

Aliases List<GetMonitoredResourceAlias>

Monitored Resource Alias Credential Details

CompartmentId string

Compartment Identifier OCID

Credentials List<GetMonitoredResourceCredential>

Monitored Resource Credential Details

DatabaseConnectionDetails List<GetMonitoredResourceDatabaseConnectionDetail>

Connection details to connect to the database. HostName, protocol, and port should be specified.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

Monitored resource display name.

ExternalResourceId string
FreeformTags Dictionary<string, object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

HostName string

Monitored resource host name.

Id string

The OCID of monitored resource.

ManagementAgentId string

Management Agent Identifier OCID.

MonitoredResourceId string
Name string

property name

Properties List<GetMonitoredResourceProperty>

List of monitored resource properties

ResourceTimeZone string

Time zone in the form of tz database canonical zone ID.

State string

Lifecycle state of the monitored resource.

SystemTags Dictionary<string, object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TenantId string

Tenancy Identifier OCID

TimeCreated string

The time the the resource was created. An RFC3339 formatted datetime string

TimeUpdated string

The time the the resource was updated. An RFC3339 formatted datetime string

Type string

Monitored resource type

Aliases []GetMonitoredResourceAlias

Monitored Resource Alias Credential Details

CompartmentId string

Compartment Identifier OCID

Credentials []GetMonitoredResourceCredential

Monitored Resource Credential Details

DatabaseConnectionDetails []GetMonitoredResourceDatabaseConnectionDetail

Connection details to connect to the database. HostName, protocol, and port should be specified.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

Monitored resource display name.

ExternalResourceId string
FreeformTags map[string]interface{}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

HostName string

Monitored resource host name.

Id string

The OCID of monitored resource.

ManagementAgentId string

Management Agent Identifier OCID.

MonitoredResourceId string
Name string

property name

Properties []GetMonitoredResourceProperty

List of monitored resource properties

ResourceTimeZone string

Time zone in the form of tz database canonical zone ID.

State string

Lifecycle state of the monitored resource.

SystemTags map[string]interface{}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TenantId string

Tenancy Identifier OCID

TimeCreated string

The time the the resource was created. An RFC3339 formatted datetime string

TimeUpdated string

The time the the resource was updated. An RFC3339 formatted datetime string

Type string

Monitored resource type

aliases List<GetMonitoredResourceAlias>

Monitored Resource Alias Credential Details

compartmentId String

Compartment Identifier OCID

credentials List<GetMonitoredResourceCredential>

Monitored Resource Credential Details

databaseConnectionDetails List<GetMonitoredResourceDatabaseConnectionDetail>

Connection details to connect to the database. HostName, protocol, and port should be specified.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

Monitored resource display name.

externalResourceId String
freeformTags Map<String,Object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

hostName String

Monitored resource host name.

id String

The OCID of monitored resource.

managementAgentId String

Management Agent Identifier OCID.

monitoredResourceId String
name String

property name

properties List<GetMonitoredResourceProperty>

List of monitored resource properties

resourceTimeZone String

Time zone in the form of tz database canonical zone ID.

state String

Lifecycle state of the monitored resource.

systemTags Map<String,Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

tenantId String

Tenancy Identifier OCID

timeCreated String

The time the the resource was created. An RFC3339 formatted datetime string

timeUpdated String

The time the the resource was updated. An RFC3339 formatted datetime string

type String

Monitored resource type

aliases GetMonitoredResourceAlias[]

Monitored Resource Alias Credential Details

compartmentId string

Compartment Identifier OCID

credentials GetMonitoredResourceCredential[]

Monitored Resource Credential Details

databaseConnectionDetails GetMonitoredResourceDatabaseConnectionDetail[]

Connection details to connect to the database. HostName, protocol, and port should be specified.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName string

Monitored resource display name.

externalResourceId string
freeformTags {[key: string]: any}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

hostName string

Monitored resource host name.

id string

The OCID of monitored resource.

managementAgentId string

Management Agent Identifier OCID.

monitoredResourceId string
name string

property name

properties GetMonitoredResourceProperty[]

List of monitored resource properties

resourceTimeZone string

Time zone in the form of tz database canonical zone ID.

state string

Lifecycle state of the monitored resource.

systemTags {[key: string]: any}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

tenantId string

Tenancy Identifier OCID

timeCreated string

The time the the resource was created. An RFC3339 formatted datetime string

timeUpdated string

The time the the resource was updated. An RFC3339 formatted datetime string

type string

Monitored resource type

aliases GetMonitoredResourceAlias]

Monitored Resource Alias Credential Details

compartment_id str

Compartment Identifier OCID

credentials GetMonitoredResourceCredential]

Monitored Resource Credential Details

database_connection_details GetMonitoredResourceDatabaseConnectionDetail]

Connection details to connect to the database. HostName, protocol, and port should be specified.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

display_name str

Monitored resource display name.

external_resource_id str
freeform_tags Mapping[str, Any]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host_name str

Monitored resource host name.

id str

The OCID of monitored resource.

management_agent_id str

Management Agent Identifier OCID.

monitored_resource_id str
name str

property name

properties GetMonitoredResourceProperty]

List of monitored resource properties

resource_time_zone str

Time zone in the form of tz database canonical zone ID.

state str

Lifecycle state of the monitored resource.

system_tags Mapping[str, Any]

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

tenant_id str

Tenancy Identifier OCID

time_created str

The time the the resource was created. An RFC3339 formatted datetime string

time_updated str

The time the the resource was updated. An RFC3339 formatted datetime string

type str

Monitored resource type

aliases List<Property Map>

Monitored Resource Alias Credential Details

compartmentId String

Compartment Identifier OCID

credentials List<Property Map>

Monitored Resource Credential Details

databaseConnectionDetails List<Property Map>

Connection details to connect to the database. HostName, protocol, and port should be specified.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

Monitored resource display name.

externalResourceId String
freeformTags Map<Any>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

hostName String

Monitored resource host name.

id String

The OCID of monitored resource.

managementAgentId String

Management Agent Identifier OCID.

monitoredResourceId String
name String

property name

properties List<Property Map>

List of monitored resource properties

resourceTimeZone String

Time zone in the form of tz database canonical zone ID.

state String

Lifecycle state of the monitored resource.

systemTags Map<Any>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

tenantId String

Tenancy Identifier OCID

timeCreated String

The time the the resource was created. An RFC3339 formatted datetime string

timeUpdated String

The time the the resource was updated. An RFC3339 formatted datetime string

type String

Monitored resource type

Supporting Types

GetMonitoredResourceAlias

Credentials List<GetMonitoredResourceAliasCredential>

Monitored Resource Alias Reference Source Credential

Name string

property name

Source string

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

Credentials []GetMonitoredResourceAliasCredential

Monitored Resource Alias Reference Source Credential

Name string

property name

Source string

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

credentials List<GetMonitoredResourceAliasCredential>

Monitored Resource Alias Reference Source Credential

name String

property name

source String

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

credentials GetMonitoredResourceAliasCredential[]

Monitored Resource Alias Reference Source Credential

name string

property name

source string

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

credentials GetMonitoredResourceAliasCredential]

Monitored Resource Alias Reference Source Credential

name str

property name

source str

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

credentials List<Property Map>

Monitored Resource Alias Reference Source Credential

name String

property name

source String

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

GetMonitoredResourceAliasCredential

Name string

property name

Service string

The name of the service owning the credential. Ex stack-monitoring or dbmgmt

Source string

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

Name string

property name

Service string

The name of the service owning the credential. Ex stack-monitoring or dbmgmt

Source string

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

name String

property name

service String

The name of the service owning the credential. Ex stack-monitoring or dbmgmt

source String

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

name string

property name

service string

The name of the service owning the credential. Ex stack-monitoring or dbmgmt

source string

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

name str

property name

service str

The name of the service owning the credential. Ex stack-monitoring or dbmgmt

source str

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

name String

property name

service String

The name of the service owning the credential. Ex stack-monitoring or dbmgmt

source String

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

GetMonitoredResourceCredential

CredentialType string

Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * PLAINTEXT - The credential properties will have credentials in plain text format. * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent.

Description string

The user-specified textual description of the credential.

KeyId string

The master key OCID and applicable only for property value type ENCRYPTION. Key OCID is passed as input to Key management service decrypt API to retrieve the encrypted property value text.

Name string

property name

Properties List<GetMonitoredResourceCredentialProperty>

List of monitored resource properties

Source string

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

Type string

Monitored resource type

CredentialType string

Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * PLAINTEXT - The credential properties will have credentials in plain text format. * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent.

Description string

The user-specified textual description of the credential.

KeyId string

The master key OCID and applicable only for property value type ENCRYPTION. Key OCID is passed as input to Key management service decrypt API to retrieve the encrypted property value text.

Name string

property name

Properties []GetMonitoredResourceCredentialProperty

List of monitored resource properties

Source string

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

Type string

Monitored resource type

credentialType String

Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * PLAINTEXT - The credential properties will have credentials in plain text format. * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent.

description String

The user-specified textual description of the credential.

keyId String

The master key OCID and applicable only for property value type ENCRYPTION. Key OCID is passed as input to Key management service decrypt API to retrieve the encrypted property value text.

name String

property name

properties List<GetMonitoredResourceCredentialProperty>

List of monitored resource properties

source String

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

type String

Monitored resource type

credentialType string

Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * PLAINTEXT - The credential properties will have credentials in plain text format. * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent.

description string

The user-specified textual description of the credential.

keyId string

The master key OCID and applicable only for property value type ENCRYPTION. Key OCID is passed as input to Key management service decrypt API to retrieve the encrypted property value text.

name string

property name

properties GetMonitoredResourceCredentialProperty[]

List of monitored resource properties

source string

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

type string

Monitored resource type

credential_type str

Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * PLAINTEXT - The credential properties will have credentials in plain text format. * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent.

description str

The user-specified textual description of the credential.

key_id str

The master key OCID and applicable only for property value type ENCRYPTION. Key OCID is passed as input to Key management service decrypt API to retrieve the encrypted property value text.

name str

property name

properties GetMonitoredResourceCredentialProperty]

List of monitored resource properties

source str

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

type str

Monitored resource type

credentialType String

Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * PLAINTEXT - The credential properties will have credentials in plain text format. * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent.

description String

The user-specified textual description of the credential.

keyId String

The master key OCID and applicable only for property value type ENCRYPTION. Key OCID is passed as input to Key management service decrypt API to retrieve the encrypted property value text.

name String

property name

properties List<Property Map>

List of monitored resource properties

source String

The source type and source name combination,delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

type String

Monitored resource type

GetMonitoredResourceCredentialProperty

Name string

property name

Value string

property value

Name string

property name

Value string

property value

name String

property name

value String

property value

name string

property name

value string

property value

name str

property name

value str

property value

name String

property name

value String

property value

GetMonitoredResourceDatabaseConnectionDetail

ConnectorId string

Database connector Identifier

DbId string

dbId of the database

DbUniqueName string

UniqueName used for database connection requests.

Port int

Listener Port number used for connection requests.

Protocol string

Protocol used in DB connection string when connecting to external database service.

ServiceName string

Service name used for connection requests.

ConnectorId string

Database connector Identifier

DbId string

dbId of the database

DbUniqueName string

UniqueName used for database connection requests.

Port int

Listener Port number used for connection requests.

Protocol string

Protocol used in DB connection string when connecting to external database service.

ServiceName string

Service name used for connection requests.

connectorId String

Database connector Identifier

dbId String

dbId of the database

dbUniqueName String

UniqueName used for database connection requests.

port Integer

Listener Port number used for connection requests.

protocol String

Protocol used in DB connection string when connecting to external database service.

serviceName String

Service name used for connection requests.

connectorId string

Database connector Identifier

dbId string

dbId of the database

dbUniqueName string

UniqueName used for database connection requests.

port number

Listener Port number used for connection requests.

protocol string

Protocol used in DB connection string when connecting to external database service.

serviceName string

Service name used for connection requests.

connector_id str

Database connector Identifier

db_id str

dbId of the database

db_unique_name str

UniqueName used for database connection requests.

port int

Listener Port number used for connection requests.

protocol str

Protocol used in DB connection string when connecting to external database service.

service_name str

Service name used for connection requests.

connectorId String

Database connector Identifier

dbId String

dbId of the database

dbUniqueName String

UniqueName used for database connection requests.

port Number

Listener Port number used for connection requests.

protocol String

Protocol used in DB connection string when connecting to external database service.

serviceName String

Service name used for connection requests.

GetMonitoredResourceProperty

Name string

property name

Value string

property value

Name string

property name

Value string

property value

name String

property name

value String

property value

name string

property name

value string

property value

name str

property name

value str

property value

name String

property name

value String

property value

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.