Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getConfig

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

Gets the configuration item identified by the OCID.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testConfig = Oci.ApmConfig.GetConfig.Invoke(new()
    {
        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
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApmConfig.ApmConfigFunctions;
import com.pulumi.oci.ApmConfig.inputs.GetConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testConfig = ApmConfigFunctions.getConfig(GetConfigArgs.builder()
            .apmDomainId(oci_apm_apm_domain.test_apm_domain().id())
            .configId(oci_apm_config_config.test_config().id())
            .build());

    }
}

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,
});

variables:
  testConfig:
    Fn::Invoke:
      Function: oci:ApmConfig:getConfig
      Arguments:
        apmDomainId: ${oci_apm_apm_domain.test_apm_domain.id}
        configId: ${oci_apm_config_config.test_config.id}

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 configuration item.

ApmDomainId string: The APM Domain ID the request is intended for.
ConfigId string: The OCID of the configuration item.

apmDomainId String: The APM Domain ID the request is intended for.
configId String: The OCID of the configuration item.

apmDomainId string: The APM Domain ID the request is intended for.
configId string: The OCID of the configuration item.

apm_domain_id str: The APM Domain ID the request is intended for.
config_id str: The OCID of the configuration item.

apmDomainId String: The APM Domain ID the request is intended for.
configId String: The OCID of the configuration item.

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 the metric. This variable should not be used.
DisplayName string: The name by which a configuration entity is displayed to the end user.
FilterId string: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is 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"}
Group string: A string that specifies the group that an OPTIONS item belongs to.
Id string: The OCID of the configuration item. An OCID is generated when the item is created.
Metrics List<GetConfigMetric>: The list of metrics in this group.
Namespace string: The namespace to which the metrics are published. It must be one of several predefined namespaces.
OpcDryRun string
Options string: The options are stored here as JSON.
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 the metric. This variable should not be used.
DisplayName string: The name by which a configuration entity is displayed to the end user.
FilterId string: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is 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"}
Group string: A string that specifies the group that an OPTIONS item belongs to.
Id string: The OCID of the configuration item. An OCID is generated when the item is created.
Metrics []GetConfigMetric: The list of metrics in this group.
Namespace string: The namespace to which the metrics are published. It must be one of several predefined namespaces.
OpcDryRun string
Options string: The options are stored here as JSON.
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 the metric. This variable should not be used.
displayName String: The name by which a configuration entity is displayed to the end user.
filterId String: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is 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"}
group String: A string that specifies the group that an OPTIONS item belongs to.
id String: The OCID of the configuration item. An OCID is generated when the item is created.
metrics List<GetConfigMetric>: The list of metrics in this group.
namespace String: The namespace to which the metrics are published. It must be one of several predefined namespaces.
opcDryRun String
options String: The options are stored here as JSON.
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 the metric. This variable should not be used.
displayName string: The name by which a configuration entity is displayed to the end user.
filterId string: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is 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"}
group string: A string that specifies the group that an OPTIONS item belongs to.
id string: The OCID of the configuration item. An OCID is generated when the item is created.
metrics GetConfigMetric[]: The list of metrics in this group.
namespace string: The namespace to which the metrics are published. It must be one of several predefined namespaces.
opcDryRun string
options string: The options are stored here as JSON.
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 the metric. This variable should not be used.
display_name str: The name by which a configuration entity is displayed to the end user.
filter_id str: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is 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"}
group str: A string that specifies the group that an OPTIONS item belongs to.
id str: The OCID of the configuration item. An OCID is generated when the item is created.
metrics GetConfigMetric]: The list of metrics in this group.
namespace str: The namespace to which the metrics are published. It must be one of several predefined namespaces.
opc_dry_run str
options str: The options are stored here as JSON.
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 the metric. This variable should not be used.
displayName String: The name by which a configuration entity is displayed to the end user.
filterId String: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is 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"}
group String: A string that specifies the group that an OPTIONS item belongs to.
id String: The OCID of the configuration item. An OCID is generated when the item is created.
metrics List<Property Map>: The list of metrics in this group.
namespace String: The namespace to which the metrics are published. It must be one of several predefined namespaces.
opcDryRun String
options String: The options are stored here as JSON.
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. This must be a known metric name.
ValueSource string: This must not be set.

Name string: The name of the metric. This must be a known metric name.
ValueSource string: This must not be set.

name String: The name of the metric. This must be a known metric name.
valueSource String: This must not be set.

name string: The name of the metric. This must be a known metric name.
valueSource string: This must not be set.

name str: The name of the metric. This must be a known metric name.
value_source str: This must not be set.

name String: The name of the metric. This must be a known metric name.
valueSource String: This must not be set.

GetConfigMetric

Description string: A description of the metric.
Name string: The name of the metric. This must be a known metric name.
Unit string: The unit of the metric.
ValueSource string: This must not be set.

Description string: A description of the metric.
Name string: The name of the metric. This must be a known metric name.
Unit string: The unit of the metric.
ValueSource string: This must not be set.

description String: A description of the metric.
name String: The name of the metric. This must be a known metric name.
unit String: The unit of the metric.
valueSource String: This must not be set.

description string: A description of the metric.
name string: The name of the metric. This must be a known metric name.
unit string: The unit of the metric.
valueSource string: This must not be set.

description str: A description of the metric.
name str: The name of the metric. This must be a known metric name.
unit str: The unit of the metric.
value_source str: This must not be set.

description String: A description of the metric.
name String: The name of the metric. This must be a known metric name.
unit String: The unit of the metric.
valueSource String: This must not be set.

GetConfigRule

DisplayName string: The name by which a configuration entity is displayed to the end user.
FilterText string: The string that defines the Span Filter expression.
IsApplyToErrorSpans bool: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
IsEnabled bool: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. 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 is considered "satisfactory" for the end user.
ToleratingResponseTime int: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

DisplayName string: The name by which a configuration entity is displayed to the end user.
FilterText string: The string that defines the Span Filter expression.
IsApplyToErrorSpans bool: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
IsEnabled bool: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. 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 is considered "satisfactory" for the end user.
ToleratingResponseTime int: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

displayName String: The name by which a configuration entity is displayed to the end user.
filterText String: The string that defines the Span Filter expression.
isApplyToErrorSpans Boolean: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
isEnabled Boolean: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. 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 is considered "satisfactory" for the end user.
toleratingResponseTime Integer: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

displayName string: The name by which a configuration entity is displayed to the end user.
filterText string: The string that defines the Span Filter expression.
isApplyToErrorSpans boolean: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
isEnabled boolean: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. 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 is considered "satisfactory" for the end user.
toleratingResponseTime number: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

display_name str: The name by which a configuration entity is displayed to the end user.
filter_text str: The string that defines the Span Filter expression.
is_apply_to_error_spans bool: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
is_enabled bool: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. 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 is considered "satisfactory" for the end user.
tolerating_response_time int: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

displayName String: The name by which a configuration entity is displayed to the end user.
filterText String: The string that defines the Span Filter expression.
isApplyToErrorSpans Boolean: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
isEnabled Boolean: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. 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 is considered "satisfactory" for the end user.
toleratingResponseTime Number: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is 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.