← All packages

Oracle Cloud Infrastructure

Pulumi Official

Package maintained by Pulumi

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

Source code

getConfig

This data source provides details about a specific Config resource in Oracle Cloud Infrastructure Apm Config service.

Get the configuration of the item identified by the OCID.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testConfig = Output.Create(Oci.ApmConfig.GetConfig.InvokeAsync(new Oci.ApmConfig.GetConfigArgs
        {
            ApmDomainId = oci_apm_apm_domain.Test_apm_domain.Id,
            ConfigId = oci_apm_config_config.Test_config.Id,
        }));
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ApmConfig.GetConfig(ctx, &apmconfig.GetConfigArgs{
			ApmDomainId: oci_apm_apm_domain.Test_apm_domain.Id,
			ConfigId:    oci_apm_config_config.Test_config.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_config = oci.ApmConfig.get_config(apm_domain_id=oci_apm_apm_domain["test_apm_domain"]["id"],
    config_id=oci_apm_config_config["test_config"]["id"])

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testConfig = oci.ApmConfig.getConfig({
    apmDomainId: oci_apm_apm_domain.test_apm_domain.id,
    configId: oci_apm_config_config.test_config.id,
});

Coming soon!

Using getConfig

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 getConfig(args: GetConfigArgs, opts?: InvokeOptions): Promise<GetConfigResult>
function getConfigOutput(args: GetConfigOutputArgs, opts?: InvokeOptions): Output<GetConfigResult>

def get_config(apm_domain_id: Optional[str] = None,
               config_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetConfigResult
def get_config_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
               config_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetConfigResult]

func GetConfig(ctx *Context, args *GetConfigArgs, opts ...InvokeOption) (*GetConfigResult, error)
func GetConfigOutput(ctx *Context, args *GetConfigOutputArgs, opts ...InvokeOption) GetConfigResultOutput

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

public static class GetConfig 
{
    public static Task<GetConfigResult> InvokeAsync(GetConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigResult> Invoke(GetConfigInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: oci:ApmConfig/getConfig:getConfig
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ApmDomainId string: The APM Domain Id the request is intended for.
ConfigId string: The OCID of the ConfiguredItem.

ApmDomainId string: The APM Domain Id the request is intended for.
ConfigId string: The OCID of the ConfiguredItem.

apmDomainId String: The APM Domain Id the request is intended for.
configId String: The OCID of the ConfiguredItem.

apmDomainId string: The APM Domain Id the request is intended for.
configId string: The OCID of the ConfiguredItem.

apm_domain_id str: The APM Domain Id the request is intended for.
config_id str: The OCID of the ConfiguredItem.

apmDomainId String: The APM Domain Id the request is intended for.
configId String: The OCID of the ConfiguredItem.

getConfig Result

The following output properties are available:

ApmDomainId string
ConfigId string
ConfigType string: The type of configuration item
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: A description of the metric
Dimensions List<GetConfigDimension>: A list of dimensions for this metric
DisplayName string: A user-friendly name that provides a short description this rule.
FilterId string: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId will be generated when a Span Filter is created.
FilterText string: The string that defines the Span Filter expression.
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"}
Id string: The OCID of the configuration item. An OCID will be generated when the item is created.
Metrics List<GetConfigMetric>
Namespace string: The namespace to write the metrics to
OpcDryRun string
Rules List<GetConfigRule>
TimeCreated string: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
TimeUpdated string: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

ApmDomainId string
ConfigId string
ConfigType string: The type of configuration item
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: A description of the metric
Dimensions []GetConfigDimension: A list of dimensions for this metric
DisplayName string: A user-friendly name that provides a short description this rule.
FilterId string: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId will be generated when a Span Filter is created.
FilterText string: The string that defines the Span Filter expression.
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"}
Id string: The OCID of the configuration item. An OCID will be generated when the item is created.
Metrics []GetConfigMetric
Namespace string: The namespace to write the metrics to
OpcDryRun string
Rules []GetConfigRule
TimeCreated string: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
TimeUpdated string: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

apmDomainId String
configId String
configType String: The type of configuration item
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: A description of the metric
dimensions List<GetConfigDimension>: A list of dimensions for this metric
displayName String: A user-friendly name that provides a short description this rule.
filterId String: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId will be generated when a Span Filter is created.
filterText String: The string that defines the Span Filter expression.
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"}
id String: The OCID of the configuration item. An OCID will be generated when the item is created.
metrics List<GetConfigMetric>
namespace String: The namespace to write the metrics to
opcDryRun String
rules List<GetConfigRule>
timeCreated String: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeUpdated String: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

apmDomainId string
configId string
configType string: The type of configuration item
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string: A description of the metric
dimensions GetConfigDimension[]: A list of dimensions for this metric
displayName string: A user-friendly name that provides a short description this rule.
filterId string: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId will be generated when a Span Filter is created.
filterText string: The string that defines the Span Filter expression.
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"}
id string: The OCID of the configuration item. An OCID will be generated when the item is created.
metrics GetConfigMetric[]
namespace string: The namespace to write the metrics to
opcDryRun string
rules GetConfigRule[]
timeCreated string: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeUpdated string: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

apm_domain_id str
config_id str
config_type str: The type of configuration item
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"}
description str: A description of the metric
dimensions GetConfigDimension]: A list of dimensions for this metric
display_name str: A user-friendly name that provides a short description this rule.
filter_id str: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId will be generated when a Span Filter is created.
filter_text str: The string that defines the Span Filter expression.
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"}
id str: The OCID of the configuration item. An OCID will be generated when the item is created.
metrics GetConfigMetric]
namespace str: The namespace to write the metrics to
opc_dry_run str
rules GetConfigRule]
time_created str: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
time_updated str: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

apmDomainId String
configId String
configType String: The type of configuration item
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: A description of the metric
dimensions List<Property Map>: A list of dimensions for this metric
displayName String: A user-friendly name that provides a short description this rule.
filterId String: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId will be generated when a Span Filter is created.
filterText String: The string that defines the Span Filter expression.
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"}
id String: The OCID of the configuration item. An OCID will be generated when the item is created.
metrics List<Property Map>
namespace String: The namespace to write the metrics to
opcDryRun String
rules List<Property Map>
timeCreated String: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeUpdated String: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

Supporting Types

GetConfigDimension

Name string: The name of the metric
ValueSource string: Must be NULL at the moment, and "name" must be a known metric.

Name string: The name of the metric
ValueSource string: Must be NULL at the moment, and "name" must be a known metric.

name String: The name of the metric
valueSource String: Must be NULL at the moment, and "name" must be a known metric.

name string: The name of the metric
valueSource string: Must be NULL at the moment, and "name" must be a known metric.

name str: The name of the metric
value_source str: Must be NULL at the moment, and "name" must be a known metric.

name String: The name of the metric
valueSource String: Must be NULL at the moment, and "name" must be a known metric.

GetConfigMetric

Description string: A description of the metric
Name string: The name of the metric
Unit string: The unit of the metric
ValueSource string: Must be NULL at the moment, and "name" must be a known metric.

Description string: A description of the metric
Name string: The name of the metric
Unit string: The unit of the metric
ValueSource string: Must be NULL at the moment, and "name" must be a known metric.

description String: A description of the metric
name String: The name of the metric
unit String: The unit of the metric
valueSource String: Must be NULL at the moment, and "name" must be a known metric.

description string: A description of the metric
name string: The name of the metric
unit string: The unit of the metric
valueSource string: Must be NULL at the moment, and "name" must be a known metric.

description str: A description of the metric
name str: The name of the metric
unit str: The unit of the metric
value_source str: Must be NULL at the moment, and "name" must be a known metric.

description String: A description of the metric
name String: The name of the metric
unit String: The unit of the metric
valueSource String: Must be NULL at the moment, and "name" must be a known metric.

GetConfigRule

DisplayName string: A user-friendly name that provides a short description this rule.
FilterText string: The string that defines the Span Filter expression.
IsApplyToErrorSpans bool: If true, the rule will compute the actual Apdex score for spans that have been marked as errors. If false, the rule will always set the Apdex for error spans to frustrating, regardless of the configured thresholds. Default is false.
IsEnabled bool: Specifies if the Apdex rule will be computed for spans matching the rule. Can be used to make sure certain spans don't get an Apdex score. The default is "true".
Priority int: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
SatisfiedResponseTime int: The maximum response time in milliseconds that will be considered satisfactory for the end user.
ToleratingResponseTime int: The maximum response time in milliseconds that will be considered tolerable for the end user. Response times beyond this threshold will be considered frustrating. This value cannot be lower than "satisfiedResponseTime".

DisplayName string: A user-friendly name that provides a short description this rule.
FilterText string: The string that defines the Span Filter expression.
IsApplyToErrorSpans bool: If true, the rule will compute the actual Apdex score for spans that have been marked as errors. If false, the rule will always set the Apdex for error spans to frustrating, regardless of the configured thresholds. Default is false.
IsEnabled bool: Specifies if the Apdex rule will be computed for spans matching the rule. Can be used to make sure certain spans don't get an Apdex score. The default is "true".
Priority int: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
SatisfiedResponseTime int: The maximum response time in milliseconds that will be considered satisfactory for the end user.
ToleratingResponseTime int: The maximum response time in milliseconds that will be considered tolerable for the end user. Response times beyond this threshold will be considered frustrating. This value cannot be lower than "satisfiedResponseTime".

displayName String: A user-friendly name that provides a short description this rule.
filterText String: The string that defines the Span Filter expression.
isApplyToErrorSpans Boolean: If true, the rule will compute the actual Apdex score for spans that have been marked as errors. If false, the rule will always set the Apdex for error spans to frustrating, regardless of the configured thresholds. Default is false.
isEnabled Boolean: Specifies if the Apdex rule will be computed for spans matching the rule. Can be used to make sure certain spans don't get an Apdex score. The default is "true".
priority Integer: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
satisfiedResponseTime Integer: The maximum response time in milliseconds that will be considered satisfactory for the end user.
toleratingResponseTime Integer: The maximum response time in milliseconds that will be considered tolerable for the end user. Response times beyond this threshold will be considered frustrating. This value cannot be lower than "satisfiedResponseTime".

displayName string: A user-friendly name that provides a short description this rule.
filterText string: The string that defines the Span Filter expression.
isApplyToErrorSpans boolean: If true, the rule will compute the actual Apdex score for spans that have been marked as errors. If false, the rule will always set the Apdex for error spans to frustrating, regardless of the configured thresholds. Default is false.
isEnabled boolean: Specifies if the Apdex rule will be computed for spans matching the rule. Can be used to make sure certain spans don't get an Apdex score. The default is "true".
priority number: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
satisfiedResponseTime number: The maximum response time in milliseconds that will be considered satisfactory for the end user.
toleratingResponseTime number: The maximum response time in milliseconds that will be considered tolerable for the end user. Response times beyond this threshold will be considered frustrating. This value cannot be lower than "satisfiedResponseTime".

display_name str: A user-friendly name that provides a short description this rule.
filter_text str: The string that defines the Span Filter expression.
is_apply_to_error_spans bool: If true, the rule will compute the actual Apdex score for spans that have been marked as errors. If false, the rule will always set the Apdex for error spans to frustrating, regardless of the configured thresholds. Default is false.
is_enabled bool: Specifies if the Apdex rule will be computed for spans matching the rule. Can be used to make sure certain spans don't get an Apdex score. The default is "true".
priority int: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
satisfied_response_time int: The maximum response time in milliseconds that will be considered satisfactory for the end user.
tolerating_response_time int: The maximum response time in milliseconds that will be considered tolerable for the end user. Response times beyond this threshold will be considered frustrating. This value cannot be lower than "satisfiedResponseTime".

displayName String: A user-friendly name that provides a short description this rule.
filterText String: The string that defines the Span Filter expression.
isApplyToErrorSpans Boolean: If true, the rule will compute the actual Apdex score for spans that have been marked as errors. If false, the rule will always set the Apdex for error spans to frustrating, regardless of the configured thresholds. Default is false.
isEnabled Boolean: Specifies if the Apdex rule will be computed for spans matching the rule. Can be used to make sure certain spans don't get an Apdex score. The default is "true".
priority Number: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
satisfiedResponseTime Number: The maximum response time in milliseconds that will be considered satisfactory for the end user.
toleratingResponseTime Number: The maximum response time in milliseconds that will be considered tolerable for the end user. Response times beyond this threshold will be considered frustrating. This value cannot be lower than "satisfiedResponseTime".

Package Details

Repository: https://github.com/pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.