Skip to content

Commit 9c13ef5

Browse files
committed
doc: Update resource documentation
1 parent 6591359 commit 9c13ef5

File tree

48 files changed

+1779
-1680
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1779
-1680
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ If `DYNATRACE_HTTP_OAUTH_PREFERENCE` is not set or is not `true`, the provider w
122122
You can authenticate using a Platform Token by setting the environment variable:
123123

124124
```
125-
DYNATRACE_PLATFORM_TOKEN
125+
DYNATRACE_PLATFORM_TOKEN=<<PLATFORM_TOKEN>>
126126
```
127127

128128
Alternatively, you can use the `platform_token` attribute in the provider configuration.

docs/resources/attribute_masking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The full documentation of the export feature is available [here](https://dt-url.
2727
```terraform
2828
resource "dynatrace_attribute_masking" "#name#" {
2929
enabled = true
30-
key = "attribute.example"
30+
key = "attribute.#name#"
3131
masking = "MASK_ENTIRE_VALUE"
3232
}
3333
```
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: ""
3+
page_title: Resource - terraform-provider-dynatrace"
4+
subcategory: "Automation"
5+
description: |-
6+
The resource `dynatrace_automation_approval` covers configuration for automation workflow approval
7+
---
8+
9+
# dynatrace_automation_approval (Resource)
10+
11+
-> This resource requires the API token scopes **Read settings** (`settings.read`) and **Write settings** (`settings.write`)
12+
13+
## Dynatrace Documentation
14+
15+
- Dynatrace Workflows - https://www.dynatrace.com/support/help/platform-modules/cloud-automation/workflows
16+
17+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:automation.approval)
18+
19+
## Resource Example Usage
20+
21+
```terraform
22+
resource "dynatrace_automation_approval" "#name#" {
23+
workflow_app_access_approval_enabled = true
24+
}
25+
```
26+
27+
<!-- schema generated by tfplugindocs -->
28+
## Schema
29+
30+
### Required
31+
32+
- `workflow_app_access_approval_enabled` (Boolean) Allow on tenant level anyone with access to the app can respond to requests via an approval link.
33+
34+
### Read-Only
35+
36+
- `id` (String) The ID of this resource.

docs/resources/automation_workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ Optional:
229229

230230
Optional:
231231

232-
- `entity_tags` (Map of String) key/value pairs for entity tags to match for. For tags that don't require a value, just specify an empty string as value. Omit this attribute if all entities should match
232+
- `entity_tags` (Map of String) key/value pairs for entity tags to match for. For tags that don't require a value, just specify an empty string as value. Multiple values can be provided separated by whitespace (e.g. "val1 val2") and will be parsed as multiple tag values. Omit this attribute if all entities should match
233233
- `entity_tags_match` (String) Specifies whether all or just any of the configured entity tags need to match. Possible values: `all` and `any`. Omit this attribute if all entities should match
234234
- `names` (Block List, Max: 1) The Davis Events to match on (see [below for nested schema](#nestedblock--trigger--event--config--davis_event--names))
235235
- `on_problem_close` (Boolean) If set to `true` closing a problem also is considered an event that triggers the execution
@@ -263,7 +263,7 @@ Required:
263263
Optional:
264264

265265
- `custom_filter` (String)
266-
- `entity_tags` (Map of String) key/value pairs for entity tags to match for. For tags that don't require a value, just specify an empty string as value. Omit this attribute if all entities should match
266+
- `entity_tags` (Map of String) key/value pairs for entity tags to match for. For tags that don't require a value, just specify an empty string as value. Multiple values can be provided separated by whitespace (e.g. "val1 val2") and will be parsed as multiple tag values. Omit this attribute if all entities should match
267267
- `entity_tags_match` (String) Specifies whether all or just any of the configured entity tags need to match. Possible values: `all` and `any`. Omit this attribute if all entities should match
268268
- `on_problem_close` (Boolean) If set to `true` closing a problem also is considered an event that triggers the execution
269269

docs/resources/aws_service.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,15 @@ description: |-
1616

1717
- Amazon Web Services - https://www.dynatrace.com/support/help/setup-and-configuration/setup-on-cloud-platforms/amazon-web-services/amazon-web-services-integrations/aws-service-metrics
1818

19+
- The dimensions and statistics for metrics for individual services - https://docs.dynatrace.com/docs/ingest-from/amazon-web-services/integrate-with-aws/aws-all-services
20+
1921
- AWS credentials API - https://www.dynatrace.com/support/help/dynatrace-api/configuration-api/aws-credentials-api
2022

2123
## Resource Example Usage
2224

2325
This example utilizes the data source `dynatrace_aws_supported_services` in order to query for a full list of all supported services.
2426
The `for_each` loop within the resource `dynatrace_aws_service` configures each of these services to get utilized with the default metrics recommended by Dynatrace (`use_recommended_metrics`).
2527

26-
If you want to configure a different set of metrics for a specific service, a separate resource `dynatrace_aws_service` will be necessary for that. That allows you to configure the `metric` blocks according to your wishes.
27-
Just be aware of the fact, that Dynatrace enforces for most services a recommended set of metrics. All of them need to be part of your configuration in order to end up with a non-empty plan.
28-
2928
```terraform
3029
resource "dynatrace_aws_credentials" "TERRAFORM_SAMPLE" {
3130
label = "TERRAFORM-TEST-001"
@@ -49,12 +48,42 @@ resource "dynatrace_aws_service" "TERRAFORM_SAMPLE_services" {
4948
}
5049
```
5150

51+
If you want to configure a different set of metrics for a specific service, a separate resource `dynatrace_aws_service` will be necessary for that. That allows you to configure the `metric` blocks according to your wishes.
52+
Just be aware of the fact, that Dynatrace enforces for most services a recommended set of metrics. All of them need to be part of your configuration in order to end up with a non-empty plan.
53+
54+
```terraform
55+
resource "dynatrace_aws_credentials" "Example" {
56+
label = "#name#"
57+
partition_type = "AWS_DEFAULT"
58+
tagged_only = false
59+
authentication_data {
60+
account_id = "123456789"
61+
iam_role = "aws-monitoring-role"
62+
}
63+
}
64+
65+
resource "dynatrace_aws_service" "ElastiCache" {
66+
name = "ElastiCache"
67+
credentials_id = dynatrace_aws_credentials.Example.id
68+
metric {
69+
name = "NetworkBandwidthOutAllowanceExceeded"
70+
dimensions = [ "CacheClusterId" ]
71+
statistic = "SUM"
72+
}
73+
metric {
74+
name = "CPUUtilization"
75+
dimensions = [ "CacheClusterId" ]
76+
statistic = "AVG_MIN_MAX"
77+
}
78+
}
79+
```
80+
5281
<!-- schema generated by tfplugindocs -->
5382
## Schema
5483

5584
### Required
5685

57-
- `credentials_id` (String) the ID of the azure credentials this supported service belongs to
86+
- `credentials_id` (String) the ID of the AWS credentials this supported service belongs to
5887

5988
### Optional
6089

@@ -73,10 +102,10 @@ resource "dynatrace_aws_service" "TERRAFORM_SAMPLE_services" {
73102

74103
Required:
75104

105+
- `dimensions` (List of String) a list of metric's dimensions names
76106
- `name` (String) the name of the metric of the supporting service
77107

78108
Optional:
79109

80-
- `dimensions` (List of String) a list of metric's dimensions names
81110
- `statistic` (String) Possible values are `AVERAGE`, `AVG_MIN_MAX`, `MAXIMUM`, `MINIMUM`, `SAMPLE_COUNT` and `SUM`
82111

docs/resources/azure_service.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,15 @@ description: |-
1616

1717
- Microsoft Azure monitoring - https://www.dynatrace.com/support/help/how-to-use-dynatrace/infrastructure-monitoring/cloud-platform-monitoring/microsoft-azure-services-monitoring
1818

19+
- The dimensions for metrics for individual services - https://docs.dynatrace.com/docs/ingest-from/microsoft-azure-services/azure-integrations/azure-cloud-services-metrics
20+
1921
- Azure credentials API - https://www.dynatrace.com/support/help/dynatrace-api/configuration-api/azure-credentials-api
2022

2123
## Resource Example Usage
2224

2325
This example utilizes the data source `dynatrace_azure_supported_services` in order to query for a full list of all supported services.
2426
The `for_each` loop within the resource `dynatrace_azure_service` configures each of these services to get utilized with the default metrics recommended by Dynatrace (`use_recommended_metrics`).
2527

26-
If you want to configure a different set of metrics for a specific service, a separate resource `dynatrace_azure_service` will be necessary for that. That allows you to configure the `metric` blocks according to your wishes.
27-
Just be aware of the fact, that Dynatrace enforces for most services a recommended set of metrics. All of them need to be part of your configuration in order to end up with a non-empty plan.
28-
2928
```terraform
3029
resource "dynatrace_azure_credentials" "TERRAFORM_SAMPLE" {
3130
active = false
@@ -54,12 +53,45 @@ resource "dynatrace_azure_service" "TERRAFORM_SAMPLE_services" {
5453
}
5554
```
5655

56+
If you want to configure a different set of metrics for a specific service, a separate resource `dynatrace_azure_service` will be necessary for that. That allows you to configure the `metric` blocks according to your wishes.
57+
Just be aware of the fact, that Dynatrace enforces for most services a recommended set of metrics. All of them need to be part of your configuration in order to end up with a non-empty plan.
58+
59+
```terraform
60+
resource "dynatrace_azure_credentials" "Example" {
61+
active = true
62+
app_id = "123456789"
63+
auto_tagging = true
64+
directory_id = "123456789"
65+
key = "123456789"
66+
label = "#name#"
67+
monitor_only_tagged_entities = false
68+
}
69+
70+
71+
resource "dynatrace_azure_service" "ContainerService" {
72+
name = "cloud:azure:containerservice:managedcluster"
73+
credentials_id = dynatrace_azure_credentials.Example.id
74+
metric {
75+
name = "kube_pod_status_ready"
76+
dimensions = []
77+
}
78+
metric {
79+
name = "kube_node_status_condition"
80+
dimensions = [ "condition", "status", "node" ]
81+
}
82+
metric {
83+
name = "kube_pod_status_phase"
84+
dimensions = [ "phase", "namespace" ]
85+
}
86+
}
87+
```
88+
5789
<!-- schema generated by tfplugindocs -->
5890
## Schema
5991

6092
### Required
6193

62-
- `credentials_id` (String) the ID of the azure credentials this supported service belongs to
94+
- `credentials_id` (String) the ID of the Azure credentials this supported service belongs to
6395

6496
### Optional
6597

docs/resources/document.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ description: |-
2424
resource "dynatrace_document" "this" {
2525
type = "dashboard"
2626
name = "Example Dashboard"
27+
custom_id = "#name#"
2728
content = jsonencode(
2829
{
2930
"version" : 13,
@@ -177,11 +178,11 @@ resource "dynatrace_document" "this" {
177178

178179
### Optional
179180

180-
- `actor` (String) The user context the executions of the document will happen with
181-
- `owner` (String) The ID of the owner of this document
181+
- `custom_id` (String) If provided, this will be the id of the document. If not provided, a system-generated id is used.
182182
- `private` (Boolean) Specifies whether the document is private or readable by everybody
183183

184184
### Read-Only
185185

186186
- `id` (String) The ID of this resource.
187+
- `owner` (String) The ID of the owner of this document
187188
- `version` (Number) The version of the document

docs/resources/hub_subscriptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The full documentation of the export feature is available [here](https://dt-url.
2828
resource "dynatrace_hub_subscriptions" "#name#" {
2929
token_subscriptions {
3030
token_subscription {
31-
name = "#name"
31+
name = "#name#"
3232
description = "Description"
3333
enabled = true
3434
token = "123456789012345678901234567890123456"

docs/resources/openpipeline_v2_bizevents_ingestsources.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ Required:
158158
- `description` (String) no documentation available
159159
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
160160
- `id` (String) Processor identifier
161-
- `type` (String) Possible Values: `AzureLogForwarding`, `Bizevent`, `BucketAssignment`, `CostAllocation`, `CounterMetric`, `Davis`, `Dql`, `Drop`, `FieldsAdd`, `FieldsRemove`, `FieldsRename`, `HistogramMetric`, `NoStorage`, `ProductAllocation`, `SamplingAwareCounterMetric`, `SamplingAwareValueMetric`, `SecurityContext`, `SecurityEvent`, `Technology`, `ValueMetric`
161+
- `type` (String) Processor type. Possible Values: `azureLogForwarding`, `bizevent`, `bucketAssignment`, `costAllocation`, `counterMetric`, `davis`, `dql`, `drop`, `fieldsAdd`, `fieldsRemove`, `fieldsRename`, `histogramMetric`, `noStorage`, `productAllocation`, `samplingAwareCounterMetric`, `samplingAwareValueMetric`, `securityContext`, `securityEvent`, `technology`, `valueMetric`.
162162

163163
Optional:
164164

@@ -196,7 +196,7 @@ Required:
196196

197197
Required:
198198

199-
- `type` (String) Possible Values: `Exclude`, `Include`, `IncludeAll`
199+
- `type` (String) Fields Extraction type. Possible Values: `exclude`, `include`, `includeAll`.
200200

201201
Optional:
202202

@@ -243,7 +243,7 @@ Optional:
243243

244244
Required:
245245

246-
- `type` (String) Possible Values: `Constant`, `Field`, `MultiValueConstant`
246+
- `type` (String) Type of value assignment. Possible Values: `constant`, `field`, `multiValueConstant`.
247247

248248
Optional:
249249

@@ -269,7 +269,7 @@ Optional:
269269

270270
Required:
271271

272-
- `type` (String) Possible Values: `Exclude`, `Include`, `IncludeAll`
272+
- `type` (String) Fields Extraction type. Possible Values: `exclude`, `include`, `includeAll`.
273273

274274
Optional:
275275

@@ -303,7 +303,7 @@ Optional:
303303

304304
Required:
305305

306-
- `type` (String) Possible Values: `Constant`, `Field`, `MultiValueConstant`
306+
- `type` (String) Type of value assignment. Possible Values: `constant`, `field`, `multiValueConstant`.
307307

308308
Optional:
309309

@@ -345,7 +345,7 @@ Required:
345345

346346
Required:
347347

348-
- `type` (String) Possible Values: `Constant`, `Field`, `MultiValueConstant`
348+
- `type` (String) Type of value assignment. Possible Values: `constant`, `field`, `multiValueConstant`.
349349

350350
Optional:
351351

@@ -537,7 +537,7 @@ Required:
537537

538538
Required:
539539

540-
- `type` (String) Possible Values: `Constant`, `Field`, `MultiValueConstant`
540+
- `type` (String) Type of value assignment. Possible Values: `constant`, `field`, `multiValueConstant`.
541541

542542
Optional:
543543

@@ -568,9 +568,9 @@ Required:
568568

569569
Optional:
570570

571-
- `aggregation` (String) Possible Values: `Disabled`, `Enabled`
571+
- `aggregation` (String) Possible Values: `disabled`, `enabled`.
572572
- `dimensions` (Block List, Max: 1) List of dimensions (see [below for nested schema](#nestedblock--processing--processors--processor--sampling_aware_counter_metric--dimensions))
573-
- `sampling` (String) Possible Values: `Disabled`, `Enabled`
573+
- `sampling` (String) Possible Values: `disabled`, `enabled`.
574574

575575
<a id="nestedblock--processing--processors--processor--sampling_aware_counter_metric--dimensions"></a>
576576
### Nested Schema for `processing.processors.processor.sampling_aware_counter_metric.dimensions`
@@ -599,16 +599,16 @@ Optional:
599599

600600
Required:
601601

602-
- `measurement` (String) Possible Values: `Duration`, `Field`
602+
- `measurement` (String) Possible Values: `duration`, `field`.
603603
- `metric_key` (String) Metric key
604604

605605
Optional:
606606

607-
- `aggregation` (String) Possible Values: `Disabled`, `Enabled`
607+
- `aggregation` (String) Possible Values: `disabled`, `enabled`.
608608
- `default_value` (String) Default value with metric value
609609
- `dimensions` (Block List, Max: 1) List of dimensions (see [below for nested schema](#nestedblock--processing--processors--processor--sampling_aware_value_metric--dimensions))
610610
- `field` (String) Field with metric value
611-
- `sampling` (String) Possible Values: `Disabled`, `Enabled`
611+
- `sampling` (String) Possible Values: `disabled`, `enabled`.
612612

613613
<a id="nestedblock--processing--processors--processor--sampling_aware_value_metric--dimensions"></a>
614614
### Nested Schema for `processing.processors.processor.sampling_aware_value_metric.dimensions`
@@ -644,7 +644,7 @@ Required:
644644

645645
Required:
646646

647-
- `type` (String) Possible Values: `Constant`, `Field`, `MultiValueConstant`
647+
- `type` (String) Type of value assignment. Possible Values: `constant`, `field`, `multiValueConstant`.
648648

649649
Optional:
650650

@@ -678,7 +678,7 @@ Required:
678678

679679
Required:
680680

681-
- `type` (String) Possible Values: `Exclude`, `Include`, `IncludeAll`
681+
- `type` (String) Fields Extraction type. Possible Values: `exclude`, `include`, `includeAll`.
682682

683683
Optional:
684684

@@ -763,7 +763,7 @@ Optional:
763763

764764
Required:
765765

766-
- `pipeline_type` (String) Possible Values: `Builtin`, `Custom`
766+
- `pipeline_type` (String) Pipeline Type. Possible Values: `builtin`, `custom`.
767767

768768
Optional:
769769

0 commit comments

Comments
 (0)