Oracle Cloud Infrastructure v2.15.0 published on Thursday, Oct 31, 2024 by Pulumi
oci.ApmConfig.getConfig
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testConfig = oci.ApmConfig.getConfig({
apmDomainId: testApmDomain.id,
configId: testConfigOciApmConfigConfig.id,
});
import pulumi
import pulumi_oci as oci
test_config = oci.ApmConfig.get_config(apm_domain_id=test_apm_domain["id"],
config_id=test_config_oci_apm_config_config["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/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: testApmDomain.Id,
ConfigId: testConfigOciApmConfigConfig.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testConfig = Oci.ApmConfig.GetConfig.Invoke(new()
{
ApmDomainId = testApmDomain.Id,
ConfigId = testConfigOciApmConfigConfig.Id,
});
});
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(testApmDomain.id())
.configId(testConfigOciApmConfigConfig.id())
.build());
}
}
variables:
testConfig:
fn::invoke:
Function: oci:ApmConfig:getConfig
Arguments:
apmDomainId: ${testApmDomain.id}
configId: ${testConfigOciApmConfigConfig.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:
- Apm
Domain stringId - The APM Domain ID the request is intended for.
- Config
Id string - The OCID of the configuration item.
- Apm
Domain stringId - The APM Domain ID the request is intended for.
- Config
Id string - The OCID of the configuration item.
- apm
Domain StringId - The APM Domain ID the request is intended for.
- config
Id String - The OCID of the configuration item.
- apm
Domain stringId - The APM Domain ID the request is intended for.
- config
Id string - The OCID of the configuration item.
- apm_
domain_ strid - The APM Domain ID the request is intended for.
- config_
id str - The OCID of the configuration item.
- apm
Domain StringId - The APM Domain ID the request is intended for.
- config
Id String - The OCID of the configuration item.
getConfig Result
The following output properties are available:
- Apm
Domain stringId - Config
Id string - Config
Type string - The type of configuration item.
- Created
By string - The OCID of a user.
- Dictionary<string, string>
- 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<Get
Config Dimension> - A list of dimensions for the metric. This variable should not be used.
- Display
Name string - The name by which a configuration entity is displayed to the end user.
- Etag string
- For optimistic concurrency control. See
if-match
. - Filter
Id 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.
- Filter
Text string - The string that defines the Span Filter expression.
- Dictionary<string, string>
- 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.
- In
Use List<GetBies Config In Use By> - The list of configuration items that reference the span filter.
- Metrics
List<Get
Config Metric> - 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.
- Opc
Dry stringRun - Options string
- The options are stored here as JSON.
- Rules
List<Get
Config Rule> - Time
Created string - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Updated string - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- Updated
By string - The OCID of a user.
- Apm
Domain stringId - Config
Id string - Config
Type string - The type of configuration item.
- Created
By string - The OCID of a user.
- map[string]string
- 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
[]Get
Config Dimension - A list of dimensions for the metric. This variable should not be used.
- Display
Name string - The name by which a configuration entity is displayed to the end user.
- Etag string
- For optimistic concurrency control. See
if-match
. - Filter
Id 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.
- Filter
Text string - The string that defines the Span Filter expression.
- map[string]string
- 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.
- In
Use []GetBies Config In Use By - The list of configuration items that reference the span filter.
- Metrics
[]Get
Config Metric - 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.
- Opc
Dry stringRun - Options string
- The options are stored here as JSON.
- Rules
[]Get
Config Rule - Time
Created string - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Updated string - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- Updated
By string - The OCID of a user.
- apm
Domain StringId - config
Id String - config
Type String - The type of configuration item.
- created
By String - The OCID of a user.
- Map<String,String>
- 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<Get
Config Dimension> - A list of dimensions for the metric. This variable should not be used.
- display
Name String - The name by which a configuration entity is displayed to the end user.
- etag String
- For optimistic concurrency control. See
if-match
. - filter
Id 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.
- filter
Text String - The string that defines the Span Filter expression.
- Map<String,String>
- 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.
- in
Use List<GetBies Config In Use By> - The list of configuration items that reference the span filter.
- metrics
List<Get
Config Metric> - 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.
- opc
Dry StringRun - options String
- The options are stored here as JSON.
- rules
List<Get
Config Rule> - time
Created String - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated String - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- updated
By String - The OCID of a user.
- apm
Domain stringId - config
Id string - config
Type string - The type of configuration item.
- created
By string - The OCID of a user.
- {[key: string]: string}
- 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
Get
Config Dimension[] - A list of dimensions for the metric. This variable should not be used.
- display
Name string - The name by which a configuration entity is displayed to the end user.
- etag string
- For optimistic concurrency control. See
if-match
. - filter
Id 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.
- filter
Text string - The string that defines the Span Filter expression.
- {[key: string]: string}
- 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.
- in
Use GetBies Config In Use By[] - The list of configuration items that reference the span filter.
- metrics
Get
Config Metric[] - 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.
- opc
Dry stringRun - options string
- The options are stored here as JSON.
- rules
Get
Config Rule[] - time
Created string - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated string - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- updated
By string - The OCID of a user.
- apm_
domain_ strid - config_
id str - config_
type str - The type of configuration item.
- created_
by str - The OCID of a user.
- Mapping[str, str]
- 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
Sequence[apmconfig.
Get Config Dimension] - 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.
- etag str
- For optimistic concurrency control. See
if-match
. - 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.
- Mapping[str, str]
- 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.
- in_
use_ Sequence[apmconfig.bies Get Config In Use By] - The list of configuration items that reference the span filter.
- metrics
Sequence[apmconfig.
Get Config Metric] - 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_ strrun - options str
- The options are stored here as JSON.
- rules
Sequence[apmconfig.
Get Config Rule] - 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
- updated_
by str - The OCID of a user.
- apm
Domain StringId - config
Id String - config
Type String - The type of configuration item.
- created
By String - The OCID of a user.
- Map<String>
- 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.
- display
Name String - The name by which a configuration entity is displayed to the end user.
- etag String
- For optimistic concurrency control. See
if-match
. - filter
Id 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.
- filter
Text String - The string that defines the Span Filter expression.
- Map<String>
- 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.
- in
Use List<Property Map>Bies - The list of configuration items that reference the span filter.
- 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.
- opc
Dry StringRun - options String
- The options are stored here as JSON.
- rules List<Property Map>
- time
Created String - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated String - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- updated
By String - The OCID of a user.
Supporting Types
GetConfigDimension
- Name string
- The name of the metric. This must be a known metric name.
- Value
Source string - This must not be set.
- Name string
- The name of the metric. This must be a known metric name.
- Value
Source string - This must not be set.
- name String
- The name of the metric. This must be a known metric name.
- value
Source String - This must not be set.
- name string
- The name of the metric. This must be a known metric name.
- value
Source 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.
- value
Source String - This must not be set.
GetConfigInUseBy
- Config
Type string - The type of configuration item.
- Display
Name string - The name by which a configuration entity is displayed to the end user.
- Id string
- The OCID of the configuration item. An OCID is generated when the item is created.
- Options
Group string - A string that specifies the group that an OPTIONS item belongs to.
- Config
Type string - The type of configuration item.
- Display
Name string - The name by which a configuration entity is displayed to the end user.
- Id string
- The OCID of the configuration item. An OCID is generated when the item is created.
- Options
Group string - A string that specifies the group that an OPTIONS item belongs to.
- config
Type String - The type of configuration item.
- display
Name String - The name by which a configuration entity is displayed to the end user.
- id String
- The OCID of the configuration item. An OCID is generated when the item is created.
- options
Group String - A string that specifies the group that an OPTIONS item belongs to.
- config
Type string - The type of configuration item.
- display
Name string - The name by which a configuration entity is displayed to the end user.
- id string
- The OCID of the configuration item. An OCID is generated when the item is created.
- options
Group string - A string that specifies the group that an OPTIONS item belongs to.
- config_
type str - The type of configuration item.
- display_
name str - The name by which a configuration entity is displayed to the end user.
- id str
- The OCID of the configuration item. An OCID is generated when the item is created.
- options_
group str - A string that specifies the group that an OPTIONS item belongs to.
- config
Type String - The type of configuration item.
- display
Name String - The name by which a configuration entity is displayed to the end user.
- id String
- The OCID of the configuration item. An OCID is generated when the item is created.
- options
Group String - A string that specifies the group that an OPTIONS item belongs to.
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.
- Value
Source 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.
- Value
Source 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.
- value
Source 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.
- value
Source 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.
- value
Source String - This must not be set.
GetConfigRule
- Display
Name string - The name by which a configuration entity is displayed to the end user.
- Filter
Text string - The string that defines the Span Filter expression.
- Is
Apply boolTo Error Spans - 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 intTime - The maximum response time in milliseconds that is considered "satisfactory" for the end user.
- Tolerating
Response intTime - 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 string - The name by which a configuration entity is displayed to the end user.
- Filter
Text string - The string that defines the Span Filter expression.
- Is
Apply boolTo Error Spans - 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 intTime - The maximum response time in milliseconds that is considered "satisfactory" for the end user.
- Tolerating
Response intTime - 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 String - The name by which a configuration entity is displayed to the end user.
- filter
Text String - The string that defines the Span Filter expression.
- is
Apply BooleanTo Error Spans - 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 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.
- satisfied
Response IntegerTime - The maximum response time in milliseconds that is considered "satisfactory" for the end user.
- tolerating
Response IntegerTime - 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 string - The name by which a configuration entity is displayed to the end user.
- filter
Text string - The string that defines the Span Filter expression.
- is
Apply booleanTo Error Spans - 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 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.
- satisfied
Response numberTime - The maximum response time in milliseconds that is considered "satisfactory" for the end user.
- tolerating
Response numberTime - 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_ boolto_ error_ spans - 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_ inttime - The maximum response time in milliseconds that is considered "satisfactory" for the end user.
- tolerating_
response_ inttime - 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 String - The name by which a configuration entity is displayed to the end user.
- filter
Text String - The string that defines the Span Filter expression.
- is
Apply BooleanTo Error Spans - 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 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.
- satisfied
Response NumberTime - The maximum response time in milliseconds that is considered "satisfactory" for the end user.
- tolerating
Response NumberTime - 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
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.