Oracle Cloud Infrastructure
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:
- Apm
Domain stringId The APM Domain Id the request is intended for.
- Config
Id string The OCID of the ConfiguredItem.
- Apm
Domain stringId The APM Domain Id the request is intended for.
- Config
Id string The OCID of the ConfiguredItem.
- apm
Domain StringId The APM Domain Id the request is intended for.
- config
Id String The OCID of the ConfiguredItem.
- apm
Domain stringId The APM Domain Id the request is intended for.
- config
Id string The OCID of the ConfiguredItem.
- apm_
domain_ strid The APM Domain Id the request is intended for.
- config_
id str The OCID of the ConfiguredItem.
- apm
Domain StringId The APM Domain Id the request is intended for.
- config
Id String The OCID of the ConfiguredItem.
getConfig Result
The following output properties are available:
- Apm
Domain stringId - Config
Id string - Config
Type string The type of configuration item
- 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<Get
Config Dimension> A list of dimensions for this metric
- Display
Name string A user-friendly name that provides a short description this rule.
- Filter
Id 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.
- Filter
Text string The string that defines the Span Filter expression.
- 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<Get
Config Metric> - Namespace string
The namespace to write the metrics to
- Opc
Dry stringRun - 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
- Apm
Domain stringId - Config
Id string - Config
Type string The type of configuration item
- 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
[]Get
Config Dimension A list of dimensions for this metric
- Display
Name string A user-friendly name that provides a short description this rule.
- Filter
Id 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.
- Filter
Text string The string that defines the Span Filter expression.
- 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
[]Get
Config Metric - Namespace string
The namespace to write the metrics to
- Opc
Dry stringRun - 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
- apm
Domain StringId - config
Id String - config
Type String The type of configuration item
- 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<Get
Config Dimension> A list of dimensions for this metric
- display
Name String A user-friendly name that provides a short description this rule.
- filter
Id 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.
- filter
Text String The string that defines the Span Filter expression.
- 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<Get
Config Metric> - namespace String
The namespace to write the metrics to
- opc
Dry StringRun - 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
- apm
Domain stringId - config
Id string - config
Type string The type of configuration item
- {[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
Get
Config Dimension[] A list of dimensions for this metric
- display
Name string A user-friendly name that provides a short description this rule.
- filter
Id 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.
- filter
Text string The string that defines the Span Filter expression.
- {[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
Get
Config Metric[] - namespace string
The namespace to write the metrics to
- opc
Dry stringRun - 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
- apm_
domain_ strid - config_
id str - config_
type str The type of configuration item
- 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
Get
Config Dimension] 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.
- 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
Get
Config Metric] - namespace str
The namespace to write the metrics to
- opc_
dry_ strrun - rules
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
- apm
Domain StringId - config
Id String - config
Type String The type of configuration item
- 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
- display
Name String A user-friendly name that provides a short description this rule.
- filter
Id 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.
- filter
Text String The string that defines the Span Filter expression.
- 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
- opc
Dry StringRun - 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
Supporting Types
GetConfigDimension
- Name string
The name of the metric
- Value
Source string Must be NULL at the moment, and "name" must be a known metric.
- Name string
The name of the metric
- Value
Source string Must be NULL at the moment, and "name" must be a known metric.
- name String
The name of the metric
- value
Source String Must be NULL at the moment, and "name" must be a known metric.
- name string
The name of the metric
- value
Source 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
- value
Source 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
- Value
Source 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
- Value
Source 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
- value
Source 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
- value
Source 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
- value
Source String Must be NULL at the moment, and "name" must be a known metric.
GetConfigRule
- Display
Name string A user-friendly name that provides a short description this rule.
- Filter
Text string The string that defines the Span Filter expression.
- Is
Apply boolTo Error Spans 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 intTime The maximum response time in milliseconds that will be considered satisfactory for the end user.
- Tolerating
Response intTime 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 string A user-friendly name that provides a short description this rule.
- Filter
Text string The string that defines the Span Filter expression.
- Is
Apply boolTo Error Spans 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 intTime The maximum response time in milliseconds that will be considered satisfactory for the end user.
- Tolerating
Response intTime 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 String A user-friendly name that provides a short description this rule.
- filter
Text String The string that defines the Span Filter expression.
- is
Apply BooleanTo Error Spans 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 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.
- satisfied
Response IntegerTime The maximum response time in milliseconds that will be considered satisfactory for the end user.
- tolerating
Response IntegerTime 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 string A user-friendly name that provides a short description this rule.
- filter
Text string The string that defines the Span Filter expression.
- is
Apply booleanTo Error Spans 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 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.
- satisfied
Response numberTime The maximum response time in milliseconds that will be considered satisfactory for the end user.
- tolerating
Response numberTime 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_ boolto_ error_ spans 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_ inttime The maximum response time in milliseconds that will be considered satisfactory for the end user.
- tolerating_
response_ inttime 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 String A user-friendly name that provides a short description this rule.
- filter
Text String The string that defines the Span Filter expression.
- is
Apply BooleanTo Error Spans 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 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.
- satisfied
Response NumberTime The maximum response time in milliseconds that will be considered satisfactory for the end user.
- tolerating
Response NumberTime 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.