1. Packages
  2. Dynatrace
  3. API Docs
  4. SpanCaptureRule
Dynatrace v0.27.0 published on Friday, Mar 21, 2025 by Pulumiverse

dynatrace.SpanCaptureRule

Explore with Pulumi AI

Create SpanCaptureRule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SpanCaptureRule(name: string, args: SpanCaptureRuleArgs, opts?: CustomResourceOptions);
@overload
def SpanCaptureRule(resource_name: str,
                    args: SpanCaptureRuleArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SpanCaptureRule(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    action: Optional[str] = None,
                    matches: Optional[SpanCaptureRuleMatchesArgs] = None,
                    insert_after: Optional[str] = None,
                    name: Optional[str] = None)
func NewSpanCaptureRule(ctx *Context, name string, args SpanCaptureRuleArgs, opts ...ResourceOption) (*SpanCaptureRule, error)
public SpanCaptureRule(string name, SpanCaptureRuleArgs args, CustomResourceOptions? opts = null)
public SpanCaptureRule(String name, SpanCaptureRuleArgs args)
public SpanCaptureRule(String name, SpanCaptureRuleArgs args, CustomResourceOptions options)
type: dynatrace:SpanCaptureRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SpanCaptureRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SpanCaptureRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SpanCaptureRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SpanCaptureRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SpanCaptureRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var spanCaptureRuleResource = new Dynatrace.SpanCaptureRule("spanCaptureRuleResource", new()
{
    Action = "string",
    Matches = new Dynatrace.Inputs.SpanCaptureRuleMatchesArgs
    {
        Matches = new[]
        {
            new Dynatrace.Inputs.SpanCaptureRuleMatchesMatchArgs
            {
                Comparison = "string",
                Source = "string",
                CaseSensitive = false,
                Key = "string",
                Value = "string",
            },
        },
    },
    InsertAfter = "string",
    Name = "string",
});
Copy
example, err := dynatrace.NewSpanCaptureRule(ctx, "spanCaptureRuleResource", &dynatrace.SpanCaptureRuleArgs{
	Action: pulumi.String("string"),
	Matches: &dynatrace.SpanCaptureRuleMatchesArgs{
		Matches: dynatrace.SpanCaptureRuleMatchesMatchArray{
			&dynatrace.SpanCaptureRuleMatchesMatchArgs{
				Comparison:    pulumi.String("string"),
				Source:        pulumi.String("string"),
				CaseSensitive: pulumi.Bool(false),
				Key:           pulumi.String("string"),
				Value:         pulumi.String("string"),
			},
		},
	},
	InsertAfter: pulumi.String("string"),
	Name:        pulumi.String("string"),
})
Copy
var spanCaptureRuleResource = new SpanCaptureRule("spanCaptureRuleResource", SpanCaptureRuleArgs.builder()
    .action("string")
    .matches(SpanCaptureRuleMatchesArgs.builder()
        .matches(SpanCaptureRuleMatchesMatchArgs.builder()
            .comparison("string")
            .source("string")
            .caseSensitive(false)
            .key("string")
            .value("string")
            .build())
        .build())
    .insertAfter("string")
    .name("string")
    .build());
Copy
span_capture_rule_resource = dynatrace.SpanCaptureRule("spanCaptureRuleResource",
    action="string",
    matches={
        "matches": [{
            "comparison": "string",
            "source": "string",
            "case_sensitive": False,
            "key": "string",
            "value": "string",
        }],
    },
    insert_after="string",
    name="string")
Copy
const spanCaptureRuleResource = new dynatrace.SpanCaptureRule("spanCaptureRuleResource", {
    action: "string",
    matches: {
        matches: [{
            comparison: "string",
            source: "string",
            caseSensitive: false,
            key: "string",
            value: "string",
        }],
    },
    insertAfter: "string",
    name: "string",
});
Copy
type: dynatrace:SpanCaptureRule
properties:
    action: string
    insertAfter: string
    matches:
        matches:
            - caseSensitive: false
              comparison: string
              key: string
              source: string
              value: string
    name: string
Copy

SpanCaptureRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SpanCaptureRule resource accepts the following input properties:

Action This property is required. string
Whether to create an entry point or not
Matches This property is required. Pulumiverse.Dynatrace.Inputs.SpanCaptureRuleMatches
Matching strategies for the Span
InsertAfter string
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
Name string
The name of the rule
Action This property is required. string
Whether to create an entry point or not
Matches This property is required. SpanCaptureRuleMatchesArgs
Matching strategies for the Span
InsertAfter string
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
Name string
The name of the rule
action This property is required. String
Whether to create an entry point or not
matches This property is required. SpanCaptureRuleMatches
Matching strategies for the Span
insertAfter String
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
name String
The name of the rule
action This property is required. string
Whether to create an entry point or not
matches This property is required. SpanCaptureRuleMatches
Matching strategies for the Span
insertAfter string
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
name string
The name of the rule
action This property is required. str
Whether to create an entry point or not
matches This property is required. SpanCaptureRuleMatchesArgs
Matching strategies for the Span
insert_after str
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
name str
The name of the rule
action This property is required. String
Whether to create an entry point or not
matches This property is required. Property Map
Matching strategies for the Span
insertAfter String
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
name String
The name of the rule

Outputs

All input properties are implicitly available as output properties. Additionally, the SpanCaptureRule resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing SpanCaptureRule Resource

Get an existing SpanCaptureRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SpanCaptureRuleState, opts?: CustomResourceOptions): SpanCaptureRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        insert_after: Optional[str] = None,
        matches: Optional[SpanCaptureRuleMatchesArgs] = None,
        name: Optional[str] = None) -> SpanCaptureRule
func GetSpanCaptureRule(ctx *Context, name string, id IDInput, state *SpanCaptureRuleState, opts ...ResourceOption) (*SpanCaptureRule, error)
public static SpanCaptureRule Get(string name, Input<string> id, SpanCaptureRuleState? state, CustomResourceOptions? opts = null)
public static SpanCaptureRule get(String name, Output<String> id, SpanCaptureRuleState state, CustomResourceOptions options)
resources:  _:    type: dynatrace:SpanCaptureRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Action string
Whether to create an entry point or not
InsertAfter string
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
Matches Pulumiverse.Dynatrace.Inputs.SpanCaptureRuleMatches
Matching strategies for the Span
Name string
The name of the rule
Action string
Whether to create an entry point or not
InsertAfter string
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
Matches SpanCaptureRuleMatchesArgs
Matching strategies for the Span
Name string
The name of the rule
action String
Whether to create an entry point or not
insertAfter String
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
matches SpanCaptureRuleMatches
Matching strategies for the Span
name String
The name of the rule
action string
Whether to create an entry point or not
insertAfter string
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
matches SpanCaptureRuleMatches
Matching strategies for the Span
name string
The name of the rule
action str
Whether to create an entry point or not
insert_after str
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
matches SpanCaptureRuleMatchesArgs
Matching strategies for the Span
name str
The name of the rule
action String
Whether to create an entry point or not
insertAfter String
Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
matches Property Map
Matching strategies for the Span
name String
The name of the rule

Supporting Types

SpanCaptureRuleMatches
, SpanCaptureRuleMatchesArgs

Matches This property is required. List<Pulumiverse.Dynatrace.Inputs.SpanCaptureRuleMatchesMatch>
Matching strategies for the Span
Matches This property is required. []SpanCaptureRuleMatchesMatch
Matching strategies for the Span
matches This property is required. List<SpanCaptureRuleMatchesMatch>
Matching strategies for the Span
matches This property is required. SpanCaptureRuleMatchesMatch[]
Matching strategies for the Span
matches This property is required. Sequence[SpanCaptureRuleMatchesMatch]
Matching strategies for the Span
matches This property is required. List<Property Map>
Matching strategies for the Span

SpanCaptureRuleMatchesMatch
, SpanCaptureRuleMatchesMatchArgs

Comparison This property is required. string
Possible values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, DOES_NOT_EQUAL, DOES_NOT_CONTAIN, DOES_NOT_START_WITH and DOES_NOT_END_WITH.
Source This property is required. string
What to match against. Possible values are SPAN_NAME, SPAN_KIND, ATTRIBUTE, INSTRUMENTATION_LIBRARY_NAME and INSTRUMENTATION_LIBRARY_VERSION
CaseSensitive bool
Whether to match strings case sensitively or not
Key string
The name of the attribute if source is ATTRIBUTE
Value string
The value to compare against. When source is SPAN_KIND the only allowed values are INTERNAL, SERVER, CLIENT, PRODUCER and CONSUMER
Comparison This property is required. string
Possible values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, DOES_NOT_EQUAL, DOES_NOT_CONTAIN, DOES_NOT_START_WITH and DOES_NOT_END_WITH.
Source This property is required. string
What to match against. Possible values are SPAN_NAME, SPAN_KIND, ATTRIBUTE, INSTRUMENTATION_LIBRARY_NAME and INSTRUMENTATION_LIBRARY_VERSION
CaseSensitive bool
Whether to match strings case sensitively or not
Key string
The name of the attribute if source is ATTRIBUTE
Value string
The value to compare against. When source is SPAN_KIND the only allowed values are INTERNAL, SERVER, CLIENT, PRODUCER and CONSUMER
comparison This property is required. String
Possible values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, DOES_NOT_EQUAL, DOES_NOT_CONTAIN, DOES_NOT_START_WITH and DOES_NOT_END_WITH.
source This property is required. String
What to match against. Possible values are SPAN_NAME, SPAN_KIND, ATTRIBUTE, INSTRUMENTATION_LIBRARY_NAME and INSTRUMENTATION_LIBRARY_VERSION
caseSensitive Boolean
Whether to match strings case sensitively or not
key String
The name of the attribute if source is ATTRIBUTE
value String
The value to compare against. When source is SPAN_KIND the only allowed values are INTERNAL, SERVER, CLIENT, PRODUCER and CONSUMER
comparison This property is required. string
Possible values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, DOES_NOT_EQUAL, DOES_NOT_CONTAIN, DOES_NOT_START_WITH and DOES_NOT_END_WITH.
source This property is required. string
What to match against. Possible values are SPAN_NAME, SPAN_KIND, ATTRIBUTE, INSTRUMENTATION_LIBRARY_NAME and INSTRUMENTATION_LIBRARY_VERSION
caseSensitive boolean
Whether to match strings case sensitively or not
key string
The name of the attribute if source is ATTRIBUTE
value string
The value to compare against. When source is SPAN_KIND the only allowed values are INTERNAL, SERVER, CLIENT, PRODUCER and CONSUMER
comparison This property is required. str
Possible values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, DOES_NOT_EQUAL, DOES_NOT_CONTAIN, DOES_NOT_START_WITH and DOES_NOT_END_WITH.
source This property is required. str
What to match against. Possible values are SPAN_NAME, SPAN_KIND, ATTRIBUTE, INSTRUMENTATION_LIBRARY_NAME and INSTRUMENTATION_LIBRARY_VERSION
case_sensitive bool
Whether to match strings case sensitively or not
key str
The name of the attribute if source is ATTRIBUTE
value str
The value to compare against. When source is SPAN_KIND the only allowed values are INTERNAL, SERVER, CLIENT, PRODUCER and CONSUMER
comparison This property is required. String
Possible values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, DOES_NOT_EQUAL, DOES_NOT_CONTAIN, DOES_NOT_START_WITH and DOES_NOT_END_WITH.
source This property is required. String
What to match against. Possible values are SPAN_NAME, SPAN_KIND, ATTRIBUTE, INSTRUMENTATION_LIBRARY_NAME and INSTRUMENTATION_LIBRARY_VERSION
caseSensitive Boolean
Whether to match strings case sensitively or not
key String
The name of the attribute if source is ATTRIBUTE
value String
The value to compare against. When source is SPAN_KIND the only allowed values are INTERNAL, SERVER, CLIENT, PRODUCER and CONSUMER

Package Details

Repository
dynatrace pulumiverse/pulumi-dynatrace
License
Apache-2.0
Notes
This Pulumi package is based on the dynatrace Terraform Provider.