Oracle Cloud Infrastructure

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

getConfigs

This data source provides the list of Configs in Oracle Cloud Infrastructure Apm Config service.

Returns all configured items optionally filtered by configuration type

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testConfigs = Output.Create(Oci.ApmConfig.GetConfigs.InvokeAsync(new Oci.ApmConfig.GetConfigsArgs
        {
            ApmDomainId = oci_apm_apm_domain.Test_apm_domain.Id,
            ConfigType = @var.Config_config_type,
            DisplayName = @var.Config_display_name,
        }));
    }

}
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.GetConfigs(ctx, &apmconfig.GetConfigsArgs{
			ApmDomainId: oci_apm_apm_domain.Test_apm_domain.Id,
			ConfigType:  pulumi.StringRef(_var.Config_config_type),
			DisplayName: pulumi.StringRef(_var.Config_display_name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_configs = oci.ApmConfig.get_configs(apm_domain_id=oci_apm_apm_domain["test_apm_domain"]["id"],
    config_type=var["config_config_type"],
    display_name=var["config_display_name"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testConfigs = oci.ApmConfig.getConfigs({
    apmDomainId: oci_apm_apm_domain.test_apm_domain.id,
    configType: _var.config_config_type,
    displayName: _var.config_display_name,
});

Coming soon!

Using getConfigs

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 getConfigs(args: GetConfigsArgs, opts?: InvokeOptions): Promise<GetConfigsResult>
function getConfigsOutput(args: GetConfigsOutputArgs, opts?: InvokeOptions): Output<GetConfigsResult>
def get_configs(apm_domain_id: Optional[str] = None,
                config_type: Optional[str] = None,
                display_name: Optional[str] = None,
                filters: Optional[Sequence[_apmconfig.GetConfigsFilter]] = None,
                opts: Optional[InvokeOptions] = None) -> GetConfigsResult
def get_configs_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
                config_type: Optional[pulumi.Input[str]] = None,
                display_name: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_apmconfig.GetConfigsFilterArgs]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetConfigsResult]
func GetConfigs(ctx *Context, args *GetConfigsArgs, opts ...InvokeOption) (*GetConfigsResult, error)
func GetConfigsOutput(ctx *Context, args *GetConfigsOutputArgs, opts ...InvokeOption) GetConfigsResultOutput

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

public static class GetConfigs 
{
    public static Task<GetConfigsResult> InvokeAsync(GetConfigsArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigsResult> Invoke(GetConfigsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetConfigsResult> getConfigs(GetConfigsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:ApmConfig/getConfigs:getConfigs
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ApmDomainId string

The APM Domain Id the request is intended for.

ConfigType string

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

DisplayName string

A filter to return only resources that match the entire display name given.

Filters List<GetConfigsFilter>
ApmDomainId string

The APM Domain Id the request is intended for.

ConfigType string

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

DisplayName string

A filter to return only resources that match the entire display name given.

Filters []GetConfigsFilter
apmDomainId String

The APM Domain Id the request is intended for.

configType String

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

displayName String

A filter to return only resources that match the entire display name given.

filters List<GetConfigsFilter>
apmDomainId string

The APM Domain Id the request is intended for.

configType string

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

displayName string

A filter to return only resources that match the entire display name given.

filters GetConfigsFilter[]
apm_domain_id str

The APM Domain Id the request is intended for.

config_type str

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

display_name str

A filter to return only resources that match the entire display name given.

filters GetConfigsFilter]
apmDomainId String

The APM Domain Id the request is intended for.

configType String

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

displayName String

A filter to return only resources that match the entire display name given.

filters List<Property Map>

getConfigs Result

The following output properties are available:

ApmDomainId string
ConfigCollections List<GetConfigsConfigCollection>

The list of config_collection.

Id string

The provider-assigned unique ID for this managed resource.

ConfigType string

The type of configuration item

DisplayName string

A user-friendly name that provides a short description this rule.

Filters List<GetConfigsFilter>
ApmDomainId string
ConfigCollections []GetConfigsConfigCollection

The list of config_collection.

Id string

The provider-assigned unique ID for this managed resource.

ConfigType string

The type of configuration item

DisplayName string

A user-friendly name that provides a short description this rule.

Filters []GetConfigsFilter
apmDomainId String
configCollections List<GetConfigsConfigCollection>

The list of config_collection.

id String

The provider-assigned unique ID for this managed resource.

configType String

The type of configuration item

displayName String

A user-friendly name that provides a short description this rule.

filters List<GetConfigsFilter>
apmDomainId string
configCollections GetConfigsConfigCollection[]

The list of config_collection.

id string

The provider-assigned unique ID for this managed resource.

configType string

The type of configuration item

displayName string

A user-friendly name that provides a short description this rule.

filters GetConfigsFilter[]
apm_domain_id str
config_collections GetConfigsConfigCollection]

The list of config_collection.

id str

The provider-assigned unique ID for this managed resource.

config_type str

The type of configuration item

display_name str

A user-friendly name that provides a short description this rule.

filters GetConfigsFilter]
apmDomainId String
configCollections List<Property Map>

The list of config_collection.

id String

The provider-assigned unique ID for this managed resource.

configType String

The type of configuration item

displayName String

A user-friendly name that provides a short description this rule.

filters List<Property Map>

Supporting Types

GetConfigsConfigCollection

GetConfigsConfigCollectionItem

ApmDomainId string

The APM Domain Id the request is intended for.

ConfigType string

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

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<GetConfigsConfigCollectionItemDimension>

A list of dimensions for this metric

DisplayName string

A filter to return only resources that match the entire display name given.

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<GetConfigsConfigCollectionItemMetric>
Namespace string

The namespace to write the metrics to

OpcDryRun string
Rules List<GetConfigsConfigCollectionItemRule>
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

The APM Domain Id the request is intended for.

ConfigType string

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

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 []GetConfigsConfigCollectionItemDimension

A list of dimensions for this metric

DisplayName string

A filter to return only resources that match the entire display name given.

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 []GetConfigsConfigCollectionItemMetric
Namespace string

The namespace to write the metrics to

OpcDryRun string
Rules []GetConfigsConfigCollectionItemRule
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

The APM Domain Id the request is intended for.

configType String

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

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<GetConfigsConfigCollectionItemDimension>

A list of dimensions for this metric

displayName String

A filter to return only resources that match the entire display name given.

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<GetConfigsConfigCollectionItemMetric>
namespace String

The namespace to write the metrics to

opcDryRun String
rules List<GetConfigsConfigCollectionItemRule>
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

The APM Domain Id the request is intended for.

configType string

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

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 GetConfigsConfigCollectionItemDimension[]

A list of dimensions for this metric

displayName string

A filter to return only resources that match the entire display name given.

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 GetConfigsConfigCollectionItemMetric[]
namespace string

The namespace to write the metrics to

opcDryRun string
rules GetConfigsConfigCollectionItemRule[]
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

The APM Domain Id the request is intended for.

config_type str

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

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 GetConfigsConfigCollectionItemDimension]

A list of dimensions for this metric

display_name str

A filter to return only resources that match the entire display name given.

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 GetConfigsConfigCollectionItemMetric]
namespace str

The namespace to write the metrics to

opc_dry_run str
rules GetConfigsConfigCollectionItemRule]
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

The APM Domain Id the request is intended for.

configType String

A filter to match only configuration items of the given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

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 filter to return only resources that match the entire display name given.

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

GetConfigsConfigCollectionItemDimension

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.

GetConfigsConfigCollectionItemMetric

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.

GetConfigsConfigCollectionItemRule

DisplayName string

A filter to return only resources that match the entire display name given.

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 filter to return only resources that match the entire display name given.

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 filter to return only resources that match the entire display name given.

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 filter to return only resources that match the entire display name given.

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 filter to return only resources that match the entire display name given.

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 filter to return only resources that match the entire display name given.

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".

GetConfigsFilter

Name string

The name of the metric

Values List<string>
Regex bool
Name string

The name of the metric

Values []string
Regex bool
name String

The name of the metric

values List<String>
regex Boolean
name string

The name of the metric

values string[]
regex boolean
name str

The name of the metric

values Sequence[str]
regex bool
name String

The name of the metric

values List<String>
regex Boolean

Package Details

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

This Pulumi package is based on the oci Terraform Provider.