pulumi-signalfx 7.2.0a1709367777__py3-none-any.whl → 7.6.0a1736835428__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pulumi_signalfx/__init__.py +9 -0
- pulumi_signalfx/_inputs.py +1976 -339
- pulumi_signalfx/_utilities.py +41 -5
- pulumi_signalfx/alert_muting_rule.py +110 -86
- pulumi_signalfx/aws/_inputs.py +85 -16
- pulumi_signalfx/aws/external_integration.py +20 -275
- pulumi_signalfx/aws/integration.py +222 -367
- pulumi_signalfx/aws/outputs.py +21 -16
- pulumi_signalfx/aws/token_integration.py +46 -65
- pulumi_signalfx/azure/_inputs.py +41 -4
- pulumi_signalfx/azure/integration.py +144 -259
- pulumi_signalfx/azure/outputs.py +15 -4
- pulumi_signalfx/config/__init__.pyi +22 -0
- pulumi_signalfx/config/vars.py +28 -0
- pulumi_signalfx/dashboard.py +171 -186
- pulumi_signalfx/dashboard_group.py +131 -198
- pulumi_signalfx/data_link.py +76 -141
- pulumi_signalfx/detector.py +264 -369
- pulumi_signalfx/event_feed_chart.py +51 -82
- pulumi_signalfx/gcp/_inputs.py +51 -0
- pulumi_signalfx/gcp/integration.py +224 -192
- pulumi_signalfx/gcp/outputs.py +44 -0
- pulumi_signalfx/get_dimension_values.py +47 -24
- pulumi_signalfx/heatmap_chart.py +165 -228
- pulumi_signalfx/jira/integration.py +70 -119
- pulumi_signalfx/list_chart.py +219 -315
- pulumi_signalfx/log/_inputs.py +33 -2
- pulumi_signalfx/log/outputs.py +7 -2
- pulumi_signalfx/log/timeline.py +64 -99
- pulumi_signalfx/log/view.py +134 -173
- pulumi_signalfx/metric_ruleset.py +217 -70
- pulumi_signalfx/opsgenie/integration.py +41 -60
- pulumi_signalfx/org_token.py +97 -128
- pulumi_signalfx/outputs.py +661 -339
- pulumi_signalfx/pagerduty/get_integration.py +22 -21
- pulumi_signalfx/pagerduty/integration.py +34 -49
- pulumi_signalfx/provider.py +99 -0
- pulumi_signalfx/pulumi-plugin.json +2 -1
- pulumi_signalfx/servicenow/integration.py +52 -107
- pulumi_signalfx/single_value_chart.py +113 -178
- pulumi_signalfx/slack/integration.py +30 -47
- pulumi_signalfx/slo.py +99 -197
- pulumi_signalfx/slo_chart.py +197 -0
- pulumi_signalfx/table_chart.py +50 -75
- pulumi_signalfx/team.py +74 -109
- pulumi_signalfx/text_chart.py +64 -89
- pulumi_signalfx/time_chart.py +271 -400
- pulumi_signalfx/victorops/integration.py +30 -47
- pulumi_signalfx/webhook_integration.py +154 -75
- {pulumi_signalfx-7.2.0a1709367777.dist-info → pulumi_signalfx-7.6.0a1736835428.dist-info}/METADATA +7 -6
- pulumi_signalfx-7.6.0a1736835428.dist-info/RECORD +65 -0
- {pulumi_signalfx-7.2.0a1709367777.dist-info → pulumi_signalfx-7.6.0a1736835428.dist-info}/WHEEL +1 -1
- pulumi_signalfx-7.2.0a1709367777.dist-info/RECORD +0 -64
- {pulumi_signalfx-7.2.0a1709367777.dist-info → pulumi_signalfx-7.6.0a1736835428.dist-info}/top_level.txt +0 -0
|
@@ -4,9 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
import copy
|
|
6
6
|
import warnings
|
|
7
|
+
import sys
|
|
7
8
|
import pulumi
|
|
8
9
|
import pulumi.runtime
|
|
9
10
|
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
10
15
|
from .. import _utilities
|
|
11
16
|
from . import outputs
|
|
12
17
|
from ._inputs import *
|
|
@@ -38,38 +43,28 @@ class IntegrationArgs:
|
|
|
38
43
|
use_metric_streams_sync: Optional[pulumi.Input[bool]] = None):
|
|
39
44
|
"""
|
|
40
45
|
The set of arguments for constructing a Integration resource.
|
|
41
|
-
:param pulumi.Input[bool] enabled: Whether the integration is enabled
|
|
42
|
-
:param pulumi.Input[str] integration_id: The
|
|
43
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] regions: List of AWS regions that Splunk Observability should monitor.
|
|
44
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] custom_cloudwatch_namespaces: List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS;
|
|
45
|
-
|
|
46
|
-
:param pulumi.Input[
|
|
47
|
-
|
|
48
|
-
:param pulumi.Input[bool]
|
|
49
|
-
|
|
50
|
-
:param pulumi.Input[bool]
|
|
51
|
-
|
|
52
|
-
:param pulumi.Input[
|
|
53
|
-
:param pulumi.Input[str]
|
|
54
|
-
:param pulumi.Input[
|
|
55
|
-
|
|
56
|
-
:param pulumi.Input[str]
|
|
57
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values
|
|
64
|
-
in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability
|
|
65
|
-
syncs all data in all AWS namespaces.
|
|
66
|
-
:param pulumi.Input[int] poll_rate: AWS poll rate (in seconds). Between `60` and `600`.
|
|
67
|
-
:param pulumi.Input[str] role_arn: Used with `signalfx_aws_external_integration`. Use this property to specify the AIM role ARN.
|
|
68
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] services: List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
|
|
69
|
-
:param pulumi.Input[bool] sync_custom_namespaces_only: Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
|
|
70
|
-
`custom_namespace_sync_rule` field for details). Defaults to `false`.
|
|
71
|
-
:param pulumi.Input[str] token: Used with `signalfx_aws_token_integration`. Use this property to specify the token.
|
|
72
|
-
:param pulumi.Input[bool] use_metric_streams_sync: Enables the use of Cloudwatch Metric Streams for metrics synchronization.
|
|
46
|
+
:param pulumi.Input[bool] enabled: Whether the integration is enabled.
|
|
47
|
+
:param pulumi.Input[str] integration_id: The id of one of a `aws.ExternalIntegration` or `aws.TokenIntegration`.
|
|
48
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] regions: List of AWS regions that Splunk Observability Cloud should monitor. It cannot be empty.
|
|
49
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] custom_cloudwatch_namespaces: List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability Cloud imports the metrics so you can monitor them.
|
|
50
|
+
:param pulumi.Input[Sequence[pulumi.Input['IntegrationCustomNamespaceSyncRuleArgs']]] custom_namespace_sync_rules: Each element controls the data collected by Splunk Observability Cloud for the specified namespace. Conflicts with the `custom_cloudwatch_namespaces` property.
|
|
51
|
+
:param pulumi.Input[bool] enable_aws_usage: Flag that controls how Splunk Observability Cloud imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, Splunk Observability Cloud imports the metrics.
|
|
52
|
+
:param pulumi.Input[bool] enable_check_large_volume: Controls how Splunk Observability Cloud checks for large amounts of data for this AWS integration. If `true`, Splunk Observability Cloud monitors the amount of data coming in from the integration.
|
|
53
|
+
:param pulumi.Input[bool] enable_logs_sync: Enable the AWS logs synchronization. Note that this requires the inclusion of `"logs:DescribeLogGroups"`, `"logs:DeleteSubscriptionFilter"`, `"logs:DescribeSubscriptionFilters"`, `"logs:PutSubscriptionFilter"`, and `"s3:GetBucketLogging"`, `"s3:GetBucketNotification"`, `"s3:PutBucketNotification"` permissions. Additional permissions may be required to capture logs from specific AWS services.
|
|
54
|
+
:param pulumi.Input[str] external_id: The `external_id` property from one of a `aws.ExternalIntegration` or `aws.TokenIntegration`
|
|
55
|
+
:param pulumi.Input[bool] import_cloud_watch: Flag that controls how Splunk Observability Cloud imports Cloud Watch metrics. If true, Splunk Observability Cloud imports Cloud Watch metrics from AWS.
|
|
56
|
+
:param pulumi.Input[str] key: If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the key (this is typically equivalent to the `AWS_SECRET_ACCESS_KEY` environment variable).
|
|
57
|
+
:param pulumi.Input[Sequence[pulumi.Input['IntegrationMetricStatsToSyncArgs']]] metric_stats_to_syncs: Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that Splunk Observability Cloud collects for this metric. If you specify this property, Splunk Observability Cloud retrieves only specified AWS statistics when AWS metric streams are not used. When AWS metric streams are used this property specifies additional extended statistics to collect (please note that AWS metric streams API supports percentile stats only; other stats are ignored). If you don't specify this property, Splunk Observability Cloud retrieves the AWS standard set of statistics.
|
|
58
|
+
:param pulumi.Input[str] named_token: Name of the org token to be used for data ingestion. If not specified then default access token is used.
|
|
59
|
+
:param pulumi.Input[Sequence[pulumi.Input['IntegrationNamespaceSyncRuleArgs']]] namespace_sync_rules: Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability Cloud collects for the namespace. Conflicts with the `services` property. If you don't specify either property, Splunk Observability Cloud syncs all data in all AWS namespaces.
|
|
60
|
+
:param pulumi.Input[int] poll_rate: AWS poll rate (in seconds). Value between `60` and `600`. Default: `300`.
|
|
61
|
+
:param pulumi.Input[str] role_arn: Role ARN that you add to an existing AWS integration object. **Note**: Ensure you use the `arn` property of your role, not the id!
|
|
62
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] services: List of AWS services that you want Splunk Observability Cloud to monitor. Each element is a string designating an AWS service. Can be an empty list to import data for all supported services. Conflicts with `namespace_sync_rule`. See [Amazon Web Services](https://docs.splunk.com/Observability/gdi/get-data-in/integrations.html#amazon-web-services) for a list of valid values.
|
|
63
|
+
:param pulumi.Input[bool] sync_custom_namespaces_only: Indicates that Splunk Observability Cloud should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` above). Defaults to `false`.
|
|
64
|
+
:param pulumi.Input[str] token: If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the token (this is typically equivalent to the `AWS_ACCESS_KEY_ID` environment variable).
|
|
65
|
+
:param pulumi.Input[bool] use_metric_streams_sync: Enable the use of Amazon Cloudwatch Metric Streams for ingesting metrics.<br>
|
|
66
|
+
Note that this requires the inclusion of `"cloudwatch:ListMetricStreams"`,`"cloudwatch:GetMetricStream"`, `"cloudwatch:PutMetricStream"`, `"cloudwatch:DeleteMetricStream"`, `"cloudwatch:StartMetricStreams"`, `"cloudwatch:StopMetricStreams"` and `"iam:PassRole"` permissions.<br>
|
|
67
|
+
Note you need to deploy additional resources on your AWS account to enable CloudWatch metrics streaming. Select one of the [CloudFormation templates](https://docs.splunk.com/Observability/gdi/get-data-in/connect/aws/aws-cloudformation.html) to deploy all the required resources.
|
|
73
68
|
"""
|
|
74
69
|
pulumi.set(__self__, "enabled", enabled)
|
|
75
70
|
pulumi.set(__self__, "integration_id", integration_id)
|
|
@@ -113,7 +108,7 @@ class IntegrationArgs:
|
|
|
113
108
|
@pulumi.getter
|
|
114
109
|
def enabled(self) -> pulumi.Input[bool]:
|
|
115
110
|
"""
|
|
116
|
-
Whether the integration is enabled
|
|
111
|
+
Whether the integration is enabled.
|
|
117
112
|
"""
|
|
118
113
|
return pulumi.get(self, "enabled")
|
|
119
114
|
|
|
@@ -125,7 +120,7 @@ class IntegrationArgs:
|
|
|
125
120
|
@pulumi.getter(name="integrationId")
|
|
126
121
|
def integration_id(self) -> pulumi.Input[str]:
|
|
127
122
|
"""
|
|
128
|
-
The
|
|
123
|
+
The id of one of a `aws.ExternalIntegration` or `aws.TokenIntegration`.
|
|
129
124
|
"""
|
|
130
125
|
return pulumi.get(self, "integration_id")
|
|
131
126
|
|
|
@@ -137,7 +132,7 @@ class IntegrationArgs:
|
|
|
137
132
|
@pulumi.getter
|
|
138
133
|
def regions(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
|
|
139
134
|
"""
|
|
140
|
-
List of AWS regions that Splunk Observability should monitor.
|
|
135
|
+
List of AWS regions that Splunk Observability Cloud should monitor. It cannot be empty.
|
|
141
136
|
"""
|
|
142
137
|
return pulumi.get(self, "regions")
|
|
143
138
|
|
|
@@ -149,8 +144,7 @@ class IntegrationArgs:
|
|
|
149
144
|
@pulumi.getter(name="customCloudwatchNamespaces")
|
|
150
145
|
def custom_cloudwatch_namespaces(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
151
146
|
"""
|
|
152
|
-
List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS;
|
|
153
|
-
Splunk Observability imports the metrics so you can monitor them.
|
|
147
|
+
List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability Cloud imports the metrics so you can monitor them.
|
|
154
148
|
"""
|
|
155
149
|
return pulumi.get(self, "custom_cloudwatch_namespaces")
|
|
156
150
|
|
|
@@ -162,8 +156,7 @@ class IntegrationArgs:
|
|
|
162
156
|
@pulumi.getter(name="customNamespaceSyncRules")
|
|
163
157
|
def custom_namespace_sync_rules(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['IntegrationCustomNamespaceSyncRuleArgs']]]]:
|
|
164
158
|
"""
|
|
165
|
-
Each element controls the data collected by Splunk Observability for the specified namespace.
|
|
166
|
-
property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
|
|
159
|
+
Each element controls the data collected by Splunk Observability Cloud for the specified namespace. Conflicts with the `custom_cloudwatch_namespaces` property.
|
|
167
160
|
"""
|
|
168
161
|
return pulumi.get(self, "custom_namespace_sync_rules")
|
|
169
162
|
|
|
@@ -175,8 +168,7 @@ class IntegrationArgs:
|
|
|
175
168
|
@pulumi.getter(name="enableAwsUsage")
|
|
176
169
|
def enable_aws_usage(self) -> Optional[pulumi.Input[bool]]:
|
|
177
170
|
"""
|
|
178
|
-
Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`,
|
|
179
|
-
Splunk Observability imports the metrics.
|
|
171
|
+
Flag that controls how Splunk Observability Cloud imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, Splunk Observability Cloud imports the metrics.
|
|
180
172
|
"""
|
|
181
173
|
return pulumi.get(self, "enable_aws_usage")
|
|
182
174
|
|
|
@@ -188,8 +180,7 @@ class IntegrationArgs:
|
|
|
188
180
|
@pulumi.getter(name="enableCheckLargeVolume")
|
|
189
181
|
def enable_check_large_volume(self) -> Optional[pulumi.Input[bool]]:
|
|
190
182
|
"""
|
|
191
|
-
Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true
|
|
192
|
-
Observability monitors the amount of data coming in from the integration.
|
|
183
|
+
Controls how Splunk Observability Cloud checks for large amounts of data for this AWS integration. If `true`, Splunk Observability Cloud monitors the amount of data coming in from the integration.
|
|
193
184
|
"""
|
|
194
185
|
return pulumi.get(self, "enable_check_large_volume")
|
|
195
186
|
|
|
@@ -201,7 +192,7 @@ class IntegrationArgs:
|
|
|
201
192
|
@pulumi.getter(name="enableLogsSync")
|
|
202
193
|
def enable_logs_sync(self) -> Optional[pulumi.Input[bool]]:
|
|
203
194
|
"""
|
|
204
|
-
|
|
195
|
+
Enable the AWS logs synchronization. Note that this requires the inclusion of `"logs:DescribeLogGroups"`, `"logs:DeleteSubscriptionFilter"`, `"logs:DescribeSubscriptionFilters"`, `"logs:PutSubscriptionFilter"`, and `"s3:GetBucketLogging"`, `"s3:GetBucketNotification"`, `"s3:PutBucketNotification"` permissions. Additional permissions may be required to capture logs from specific AWS services.
|
|
205
196
|
"""
|
|
206
197
|
return pulumi.get(self, "enable_logs_sync")
|
|
207
198
|
|
|
@@ -213,7 +204,7 @@ class IntegrationArgs:
|
|
|
213
204
|
@pulumi.getter(name="externalId")
|
|
214
205
|
def external_id(self) -> Optional[pulumi.Input[str]]:
|
|
215
206
|
"""
|
|
216
|
-
|
|
207
|
+
The `external_id` property from one of a `aws.ExternalIntegration` or `aws.TokenIntegration`
|
|
217
208
|
"""
|
|
218
209
|
return pulumi.get(self, "external_id")
|
|
219
210
|
|
|
@@ -225,8 +216,7 @@ class IntegrationArgs:
|
|
|
225
216
|
@pulumi.getter(name="importCloudWatch")
|
|
226
217
|
def import_cloud_watch(self) -> Optional[pulumi.Input[bool]]:
|
|
227
218
|
"""
|
|
228
|
-
Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud
|
|
229
|
-
Watch metrics from AWS.
|
|
219
|
+
Flag that controls how Splunk Observability Cloud imports Cloud Watch metrics. If true, Splunk Observability Cloud imports Cloud Watch metrics from AWS.
|
|
230
220
|
"""
|
|
231
221
|
return pulumi.get(self, "import_cloud_watch")
|
|
232
222
|
|
|
@@ -238,7 +228,7 @@ class IntegrationArgs:
|
|
|
238
228
|
@pulumi.getter
|
|
239
229
|
def key(self) -> Optional[pulumi.Input[str]]:
|
|
240
230
|
"""
|
|
241
|
-
|
|
231
|
+
If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the key (this is typically equivalent to the `AWS_SECRET_ACCESS_KEY` environment variable).
|
|
242
232
|
"""
|
|
243
233
|
return pulumi.get(self, "key")
|
|
244
234
|
|
|
@@ -250,10 +240,7 @@ class IntegrationArgs:
|
|
|
250
240
|
@pulumi.getter(name="metricStatsToSyncs")
|
|
251
241
|
def metric_stats_to_syncs(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['IntegrationMetricStatsToSyncArgs']]]]:
|
|
252
242
|
"""
|
|
253
|
-
Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics
|
|
254
|
-
that Splunk Observability collects for this metric. If you specify this property, Splunk Observability retrieves only
|
|
255
|
-
specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of
|
|
256
|
-
statistics.
|
|
243
|
+
Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that Splunk Observability Cloud collects for this metric. If you specify this property, Splunk Observability Cloud retrieves only specified AWS statistics when AWS metric streams are not used. When AWS metric streams are used this property specifies additional extended statistics to collect (please note that AWS metric streams API supports percentile stats only; other stats are ignored). If you don't specify this property, Splunk Observability Cloud retrieves the AWS standard set of statistics.
|
|
257
244
|
"""
|
|
258
245
|
return pulumi.get(self, "metric_stats_to_syncs")
|
|
259
246
|
|
|
@@ -265,7 +252,7 @@ class IntegrationArgs:
|
|
|
265
252
|
@pulumi.getter(name="namedToken")
|
|
266
253
|
def named_token(self) -> Optional[pulumi.Input[str]]:
|
|
267
254
|
"""
|
|
268
|
-
|
|
255
|
+
Name of the org token to be used for data ingestion. If not specified then default access token is used.
|
|
269
256
|
"""
|
|
270
257
|
return pulumi.get(self, "named_token")
|
|
271
258
|
|
|
@@ -277,10 +264,7 @@ class IntegrationArgs:
|
|
|
277
264
|
@pulumi.getter(name="namespaceSyncRules")
|
|
278
265
|
def namespace_sync_rules(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['IntegrationNamespaceSyncRuleArgs']]]]:
|
|
279
266
|
"""
|
|
280
|
-
Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that
|
|
281
|
-
Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values
|
|
282
|
-
in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability
|
|
283
|
-
syncs all data in all AWS namespaces.
|
|
267
|
+
Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability Cloud collects for the namespace. Conflicts with the `services` property. If you don't specify either property, Splunk Observability Cloud syncs all data in all AWS namespaces.
|
|
284
268
|
"""
|
|
285
269
|
return pulumi.get(self, "namespace_sync_rules")
|
|
286
270
|
|
|
@@ -292,7 +276,7 @@ class IntegrationArgs:
|
|
|
292
276
|
@pulumi.getter(name="pollRate")
|
|
293
277
|
def poll_rate(self) -> Optional[pulumi.Input[int]]:
|
|
294
278
|
"""
|
|
295
|
-
AWS poll rate (in seconds).
|
|
279
|
+
AWS poll rate (in seconds). Value between `60` and `600`. Default: `300`.
|
|
296
280
|
"""
|
|
297
281
|
return pulumi.get(self, "poll_rate")
|
|
298
282
|
|
|
@@ -304,7 +288,7 @@ class IntegrationArgs:
|
|
|
304
288
|
@pulumi.getter(name="roleArn")
|
|
305
289
|
def role_arn(self) -> Optional[pulumi.Input[str]]:
|
|
306
290
|
"""
|
|
307
|
-
|
|
291
|
+
Role ARN that you add to an existing AWS integration object. **Note**: Ensure you use the `arn` property of your role, not the id!
|
|
308
292
|
"""
|
|
309
293
|
return pulumi.get(self, "role_arn")
|
|
310
294
|
|
|
@@ -316,7 +300,7 @@ class IntegrationArgs:
|
|
|
316
300
|
@pulumi.getter
|
|
317
301
|
def services(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
318
302
|
"""
|
|
319
|
-
List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
|
|
303
|
+
List of AWS services that you want Splunk Observability Cloud to monitor. Each element is a string designating an AWS service. Can be an empty list to import data for all supported services. Conflicts with `namespace_sync_rule`. See [Amazon Web Services](https://docs.splunk.com/Observability/gdi/get-data-in/integrations.html#amazon-web-services) for a list of valid values.
|
|
320
304
|
"""
|
|
321
305
|
return pulumi.get(self, "services")
|
|
322
306
|
|
|
@@ -328,8 +312,7 @@ class IntegrationArgs:
|
|
|
328
312
|
@pulumi.getter(name="syncCustomNamespacesOnly")
|
|
329
313
|
def sync_custom_namespaces_only(self) -> Optional[pulumi.Input[bool]]:
|
|
330
314
|
"""
|
|
331
|
-
Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
|
|
332
|
-
`custom_namespace_sync_rule` field for details). Defaults to `false`.
|
|
315
|
+
Indicates that Splunk Observability Cloud should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` above). Defaults to `false`.
|
|
333
316
|
"""
|
|
334
317
|
return pulumi.get(self, "sync_custom_namespaces_only")
|
|
335
318
|
|
|
@@ -341,7 +324,7 @@ class IntegrationArgs:
|
|
|
341
324
|
@pulumi.getter
|
|
342
325
|
def token(self) -> Optional[pulumi.Input[str]]:
|
|
343
326
|
"""
|
|
344
|
-
|
|
327
|
+
If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the token (this is typically equivalent to the `AWS_ACCESS_KEY_ID` environment variable).
|
|
345
328
|
"""
|
|
346
329
|
return pulumi.get(self, "token")
|
|
347
330
|
|
|
@@ -353,7 +336,9 @@ class IntegrationArgs:
|
|
|
353
336
|
@pulumi.getter(name="useMetricStreamsSync")
|
|
354
337
|
def use_metric_streams_sync(self) -> Optional[pulumi.Input[bool]]:
|
|
355
338
|
"""
|
|
356
|
-
|
|
339
|
+
Enable the use of Amazon Cloudwatch Metric Streams for ingesting metrics.<br>
|
|
340
|
+
Note that this requires the inclusion of `"cloudwatch:ListMetricStreams"`,`"cloudwatch:GetMetricStream"`, `"cloudwatch:PutMetricStream"`, `"cloudwatch:DeleteMetricStream"`, `"cloudwatch:StartMetricStreams"`, `"cloudwatch:StopMetricStreams"` and `"iam:PassRole"` permissions.<br>
|
|
341
|
+
Note you need to deploy additional resources on your AWS account to enable CloudWatch metrics streaming. Select one of the [CloudFormation templates](https://docs.splunk.com/Observability/gdi/get-data-in/connect/aws/aws-cloudformation.html) to deploy all the required resources.
|
|
357
342
|
"""
|
|
358
343
|
return pulumi.get(self, "use_metric_streams_sync")
|
|
359
344
|
|
|
@@ -389,42 +374,31 @@ class _IntegrationState:
|
|
|
389
374
|
use_metric_streams_sync: Optional[pulumi.Input[bool]] = None):
|
|
390
375
|
"""
|
|
391
376
|
Input properties used for looking up and filtering Integration resources.
|
|
392
|
-
:param pulumi.Input[str] auth_method: The mechanism used to authenticate with AWS. Use one of `
|
|
393
|
-
|
|
394
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] custom_cloudwatch_namespaces: List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS;
|
|
395
|
-
|
|
396
|
-
:param pulumi.Input[
|
|
397
|
-
|
|
398
|
-
:param pulumi.Input[bool]
|
|
399
|
-
|
|
400
|
-
:param pulumi.Input[
|
|
401
|
-
|
|
402
|
-
:param pulumi.Input[
|
|
403
|
-
:param pulumi.Input[
|
|
404
|
-
:param pulumi.Input[
|
|
405
|
-
:param pulumi.Input[
|
|
406
|
-
|
|
407
|
-
:param pulumi.Input[
|
|
408
|
-
:param pulumi.Input[
|
|
409
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
:param pulumi.Input[str]
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values
|
|
418
|
-
in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability
|
|
419
|
-
syncs all data in all AWS namespaces.
|
|
420
|
-
:param pulumi.Input[int] poll_rate: AWS poll rate (in seconds). Between `60` and `600`.
|
|
421
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] regions: List of AWS regions that Splunk Observability should monitor.
|
|
422
|
-
:param pulumi.Input[str] role_arn: Used with `signalfx_aws_external_integration`. Use this property to specify the AIM role ARN.
|
|
423
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] services: List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
|
|
424
|
-
:param pulumi.Input[bool] sync_custom_namespaces_only: Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
|
|
425
|
-
`custom_namespace_sync_rule` field for details). Defaults to `false`.
|
|
426
|
-
:param pulumi.Input[str] token: Used with `signalfx_aws_token_integration`. Use this property to specify the token.
|
|
427
|
-
:param pulumi.Input[bool] use_metric_streams_sync: Enables the use of Cloudwatch Metric Streams for metrics synchronization.
|
|
377
|
+
:param pulumi.Input[str] auth_method: The mechanism used to authenticate with AWS. Use one of `aws.ExternalIntegration` or `aws.TokenIntegration` to define
|
|
378
|
+
this
|
|
379
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] custom_cloudwatch_namespaces: List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability Cloud imports the metrics so you can monitor them.
|
|
380
|
+
:param pulumi.Input[Sequence[pulumi.Input['IntegrationCustomNamespaceSyncRuleArgs']]] custom_namespace_sync_rules: Each element controls the data collected by Splunk Observability Cloud for the specified namespace. Conflicts with the `custom_cloudwatch_namespaces` property.
|
|
381
|
+
:param pulumi.Input[bool] enable_aws_usage: Flag that controls how Splunk Observability Cloud imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, Splunk Observability Cloud imports the metrics.
|
|
382
|
+
:param pulumi.Input[bool] enable_check_large_volume: Controls how Splunk Observability Cloud checks for large amounts of data for this AWS integration. If `true`, Splunk Observability Cloud monitors the amount of data coming in from the integration.
|
|
383
|
+
:param pulumi.Input[bool] enable_logs_sync: Enable the AWS logs synchronization. Note that this requires the inclusion of `"logs:DescribeLogGroups"`, `"logs:DeleteSubscriptionFilter"`, `"logs:DescribeSubscriptionFilters"`, `"logs:PutSubscriptionFilter"`, and `"s3:GetBucketLogging"`, `"s3:GetBucketNotification"`, `"s3:PutBucketNotification"` permissions. Additional permissions may be required to capture logs from specific AWS services.
|
|
384
|
+
:param pulumi.Input[bool] enabled: Whether the integration is enabled.
|
|
385
|
+
:param pulumi.Input[str] external_id: The `external_id` property from one of a `aws.ExternalIntegration` or `aws.TokenIntegration`
|
|
386
|
+
:param pulumi.Input[bool] import_cloud_watch: Flag that controls how Splunk Observability Cloud imports Cloud Watch metrics. If true, Splunk Observability Cloud imports Cloud Watch metrics from AWS.
|
|
387
|
+
:param pulumi.Input[str] integration_id: The id of one of a `aws.ExternalIntegration` or `aws.TokenIntegration`.
|
|
388
|
+
:param pulumi.Input[str] key: If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the key (this is typically equivalent to the `AWS_SECRET_ACCESS_KEY` environment variable).
|
|
389
|
+
:param pulumi.Input[Sequence[pulumi.Input['IntegrationMetricStatsToSyncArgs']]] metric_stats_to_syncs: Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that Splunk Observability Cloud collects for this metric. If you specify this property, Splunk Observability Cloud retrieves only specified AWS statistics when AWS metric streams are not used. When AWS metric streams are used this property specifies additional extended statistics to collect (please note that AWS metric streams API supports percentile stats only; other stats are ignored). If you don't specify this property, Splunk Observability Cloud retrieves the AWS standard set of statistics.
|
|
390
|
+
:param pulumi.Input[str] name: Name of the integration.
|
|
391
|
+
:param pulumi.Input[str] named_token: Name of the org token to be used for data ingestion. If not specified then default access token is used.
|
|
392
|
+
:param pulumi.Input[Sequence[pulumi.Input['IntegrationNamespaceSyncRuleArgs']]] namespace_sync_rules: Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability Cloud collects for the namespace. Conflicts with the `services` property. If you don't specify either property, Splunk Observability Cloud syncs all data in all AWS namespaces.
|
|
393
|
+
:param pulumi.Input[int] poll_rate: AWS poll rate (in seconds). Value between `60` and `600`. Default: `300`.
|
|
394
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] regions: List of AWS regions that Splunk Observability Cloud should monitor. It cannot be empty.
|
|
395
|
+
:param pulumi.Input[str] role_arn: Role ARN that you add to an existing AWS integration object. **Note**: Ensure you use the `arn` property of your role, not the id!
|
|
396
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] services: List of AWS services that you want Splunk Observability Cloud to monitor. Each element is a string designating an AWS service. Can be an empty list to import data for all supported services. Conflicts with `namespace_sync_rule`. See [Amazon Web Services](https://docs.splunk.com/Observability/gdi/get-data-in/integrations.html#amazon-web-services) for a list of valid values.
|
|
397
|
+
:param pulumi.Input[bool] sync_custom_namespaces_only: Indicates that Splunk Observability Cloud should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` above). Defaults to `false`.
|
|
398
|
+
:param pulumi.Input[str] token: If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the token (this is typically equivalent to the `AWS_ACCESS_KEY_ID` environment variable).
|
|
399
|
+
:param pulumi.Input[bool] use_metric_streams_sync: Enable the use of Amazon Cloudwatch Metric Streams for ingesting metrics.<br>
|
|
400
|
+
Note that this requires the inclusion of `"cloudwatch:ListMetricStreams"`,`"cloudwatch:GetMetricStream"`, `"cloudwatch:PutMetricStream"`, `"cloudwatch:DeleteMetricStream"`, `"cloudwatch:StartMetricStreams"`, `"cloudwatch:StopMetricStreams"` and `"iam:PassRole"` permissions.<br>
|
|
401
|
+
Note you need to deploy additional resources on your AWS account to enable CloudWatch metrics streaming. Select one of the [CloudFormation templates](https://docs.splunk.com/Observability/gdi/get-data-in/connect/aws/aws-cloudformation.html) to deploy all the required resources.
|
|
428
402
|
"""
|
|
429
403
|
if auth_method is not None:
|
|
430
404
|
pulumi.set(__self__, "auth_method", auth_method)
|
|
@@ -475,8 +449,8 @@ class _IntegrationState:
|
|
|
475
449
|
@pulumi.getter(name="authMethod")
|
|
476
450
|
def auth_method(self) -> Optional[pulumi.Input[str]]:
|
|
477
451
|
"""
|
|
478
|
-
The mechanism used to authenticate with AWS. Use one of `
|
|
479
|
-
|
|
452
|
+
The mechanism used to authenticate with AWS. Use one of `aws.ExternalIntegration` or `aws.TokenIntegration` to define
|
|
453
|
+
this
|
|
480
454
|
"""
|
|
481
455
|
return pulumi.get(self, "auth_method")
|
|
482
456
|
|
|
@@ -488,8 +462,7 @@ class _IntegrationState:
|
|
|
488
462
|
@pulumi.getter(name="customCloudwatchNamespaces")
|
|
489
463
|
def custom_cloudwatch_namespaces(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
490
464
|
"""
|
|
491
|
-
List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS;
|
|
492
|
-
Splunk Observability imports the metrics so you can monitor them.
|
|
465
|
+
List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability Cloud imports the metrics so you can monitor them.
|
|
493
466
|
"""
|
|
494
467
|
return pulumi.get(self, "custom_cloudwatch_namespaces")
|
|
495
468
|
|
|
@@ -501,8 +474,7 @@ class _IntegrationState:
|
|
|
501
474
|
@pulumi.getter(name="customNamespaceSyncRules")
|
|
502
475
|
def custom_namespace_sync_rules(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['IntegrationCustomNamespaceSyncRuleArgs']]]]:
|
|
503
476
|
"""
|
|
504
|
-
Each element controls the data collected by Splunk Observability for the specified namespace.
|
|
505
|
-
property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
|
|
477
|
+
Each element controls the data collected by Splunk Observability Cloud for the specified namespace. Conflicts with the `custom_cloudwatch_namespaces` property.
|
|
506
478
|
"""
|
|
507
479
|
return pulumi.get(self, "custom_namespace_sync_rules")
|
|
508
480
|
|
|
@@ -514,8 +486,7 @@ class _IntegrationState:
|
|
|
514
486
|
@pulumi.getter(name="enableAwsUsage")
|
|
515
487
|
def enable_aws_usage(self) -> Optional[pulumi.Input[bool]]:
|
|
516
488
|
"""
|
|
517
|
-
Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`,
|
|
518
|
-
Splunk Observability imports the metrics.
|
|
489
|
+
Flag that controls how Splunk Observability Cloud imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, Splunk Observability Cloud imports the metrics.
|
|
519
490
|
"""
|
|
520
491
|
return pulumi.get(self, "enable_aws_usage")
|
|
521
492
|
|
|
@@ -527,8 +498,7 @@ class _IntegrationState:
|
|
|
527
498
|
@pulumi.getter(name="enableCheckLargeVolume")
|
|
528
499
|
def enable_check_large_volume(self) -> Optional[pulumi.Input[bool]]:
|
|
529
500
|
"""
|
|
530
|
-
Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true
|
|
531
|
-
Observability monitors the amount of data coming in from the integration.
|
|
501
|
+
Controls how Splunk Observability Cloud checks for large amounts of data for this AWS integration. If `true`, Splunk Observability Cloud monitors the amount of data coming in from the integration.
|
|
532
502
|
"""
|
|
533
503
|
return pulumi.get(self, "enable_check_large_volume")
|
|
534
504
|
|
|
@@ -540,7 +510,7 @@ class _IntegrationState:
|
|
|
540
510
|
@pulumi.getter(name="enableLogsSync")
|
|
541
511
|
def enable_logs_sync(self) -> Optional[pulumi.Input[bool]]:
|
|
542
512
|
"""
|
|
543
|
-
|
|
513
|
+
Enable the AWS logs synchronization. Note that this requires the inclusion of `"logs:DescribeLogGroups"`, `"logs:DeleteSubscriptionFilter"`, `"logs:DescribeSubscriptionFilters"`, `"logs:PutSubscriptionFilter"`, and `"s3:GetBucketLogging"`, `"s3:GetBucketNotification"`, `"s3:PutBucketNotification"` permissions. Additional permissions may be required to capture logs from specific AWS services.
|
|
544
514
|
"""
|
|
545
515
|
return pulumi.get(self, "enable_logs_sync")
|
|
546
516
|
|
|
@@ -552,7 +522,7 @@ class _IntegrationState:
|
|
|
552
522
|
@pulumi.getter
|
|
553
523
|
def enabled(self) -> Optional[pulumi.Input[bool]]:
|
|
554
524
|
"""
|
|
555
|
-
Whether the integration is enabled
|
|
525
|
+
Whether the integration is enabled.
|
|
556
526
|
"""
|
|
557
527
|
return pulumi.get(self, "enabled")
|
|
558
528
|
|
|
@@ -564,7 +534,7 @@ class _IntegrationState:
|
|
|
564
534
|
@pulumi.getter(name="externalId")
|
|
565
535
|
def external_id(self) -> Optional[pulumi.Input[str]]:
|
|
566
536
|
"""
|
|
567
|
-
|
|
537
|
+
The `external_id` property from one of a `aws.ExternalIntegration` or `aws.TokenIntegration`
|
|
568
538
|
"""
|
|
569
539
|
return pulumi.get(self, "external_id")
|
|
570
540
|
|
|
@@ -576,8 +546,7 @@ class _IntegrationState:
|
|
|
576
546
|
@pulumi.getter(name="importCloudWatch")
|
|
577
547
|
def import_cloud_watch(self) -> Optional[pulumi.Input[bool]]:
|
|
578
548
|
"""
|
|
579
|
-
Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud
|
|
580
|
-
Watch metrics from AWS.
|
|
549
|
+
Flag that controls how Splunk Observability Cloud imports Cloud Watch metrics. If true, Splunk Observability Cloud imports Cloud Watch metrics from AWS.
|
|
581
550
|
"""
|
|
582
551
|
return pulumi.get(self, "import_cloud_watch")
|
|
583
552
|
|
|
@@ -589,7 +558,7 @@ class _IntegrationState:
|
|
|
589
558
|
@pulumi.getter(name="integrationId")
|
|
590
559
|
def integration_id(self) -> Optional[pulumi.Input[str]]:
|
|
591
560
|
"""
|
|
592
|
-
The
|
|
561
|
+
The id of one of a `aws.ExternalIntegration` or `aws.TokenIntegration`.
|
|
593
562
|
"""
|
|
594
563
|
return pulumi.get(self, "integration_id")
|
|
595
564
|
|
|
@@ -601,7 +570,7 @@ class _IntegrationState:
|
|
|
601
570
|
@pulumi.getter
|
|
602
571
|
def key(self) -> Optional[pulumi.Input[str]]:
|
|
603
572
|
"""
|
|
604
|
-
|
|
573
|
+
If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the key (this is typically equivalent to the `AWS_SECRET_ACCESS_KEY` environment variable).
|
|
605
574
|
"""
|
|
606
575
|
return pulumi.get(self, "key")
|
|
607
576
|
|
|
@@ -613,10 +582,7 @@ class _IntegrationState:
|
|
|
613
582
|
@pulumi.getter(name="metricStatsToSyncs")
|
|
614
583
|
def metric_stats_to_syncs(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['IntegrationMetricStatsToSyncArgs']]]]:
|
|
615
584
|
"""
|
|
616
|
-
Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics
|
|
617
|
-
that Splunk Observability collects for this metric. If you specify this property, Splunk Observability retrieves only
|
|
618
|
-
specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of
|
|
619
|
-
statistics.
|
|
585
|
+
Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that Splunk Observability Cloud collects for this metric. If you specify this property, Splunk Observability Cloud retrieves only specified AWS statistics when AWS metric streams are not used. When AWS metric streams are used this property specifies additional extended statistics to collect (please note that AWS metric streams API supports percentile stats only; other stats are ignored). If you don't specify this property, Splunk Observability Cloud retrieves the AWS standard set of statistics.
|
|
620
586
|
"""
|
|
621
587
|
return pulumi.get(self, "metric_stats_to_syncs")
|
|
622
588
|
|
|
@@ -628,8 +594,7 @@ class _IntegrationState:
|
|
|
628
594
|
@pulumi.getter
|
|
629
595
|
def name(self) -> Optional[pulumi.Input[str]]:
|
|
630
596
|
"""
|
|
631
|
-
Name of the integration.
|
|
632
|
-
`signalfx_aws_integration_token`
|
|
597
|
+
Name of the integration.
|
|
633
598
|
"""
|
|
634
599
|
return pulumi.get(self, "name")
|
|
635
600
|
|
|
@@ -641,7 +606,7 @@ class _IntegrationState:
|
|
|
641
606
|
@pulumi.getter(name="namedToken")
|
|
642
607
|
def named_token(self) -> Optional[pulumi.Input[str]]:
|
|
643
608
|
"""
|
|
644
|
-
|
|
609
|
+
Name of the org token to be used for data ingestion. If not specified then default access token is used.
|
|
645
610
|
"""
|
|
646
611
|
return pulumi.get(self, "named_token")
|
|
647
612
|
|
|
@@ -653,10 +618,7 @@ class _IntegrationState:
|
|
|
653
618
|
@pulumi.getter(name="namespaceSyncRules")
|
|
654
619
|
def namespace_sync_rules(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['IntegrationNamespaceSyncRuleArgs']]]]:
|
|
655
620
|
"""
|
|
656
|
-
Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that
|
|
657
|
-
Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values
|
|
658
|
-
in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability
|
|
659
|
-
syncs all data in all AWS namespaces.
|
|
621
|
+
Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability Cloud collects for the namespace. Conflicts with the `services` property. If you don't specify either property, Splunk Observability Cloud syncs all data in all AWS namespaces.
|
|
660
622
|
"""
|
|
661
623
|
return pulumi.get(self, "namespace_sync_rules")
|
|
662
624
|
|
|
@@ -668,7 +630,7 @@ class _IntegrationState:
|
|
|
668
630
|
@pulumi.getter(name="pollRate")
|
|
669
631
|
def poll_rate(self) -> Optional[pulumi.Input[int]]:
|
|
670
632
|
"""
|
|
671
|
-
AWS poll rate (in seconds).
|
|
633
|
+
AWS poll rate (in seconds). Value between `60` and `600`. Default: `300`.
|
|
672
634
|
"""
|
|
673
635
|
return pulumi.get(self, "poll_rate")
|
|
674
636
|
|
|
@@ -680,7 +642,7 @@ class _IntegrationState:
|
|
|
680
642
|
@pulumi.getter
|
|
681
643
|
def regions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
682
644
|
"""
|
|
683
|
-
List of AWS regions that Splunk Observability should monitor.
|
|
645
|
+
List of AWS regions that Splunk Observability Cloud should monitor. It cannot be empty.
|
|
684
646
|
"""
|
|
685
647
|
return pulumi.get(self, "regions")
|
|
686
648
|
|
|
@@ -692,7 +654,7 @@ class _IntegrationState:
|
|
|
692
654
|
@pulumi.getter(name="roleArn")
|
|
693
655
|
def role_arn(self) -> Optional[pulumi.Input[str]]:
|
|
694
656
|
"""
|
|
695
|
-
|
|
657
|
+
Role ARN that you add to an existing AWS integration object. **Note**: Ensure you use the `arn` property of your role, not the id!
|
|
696
658
|
"""
|
|
697
659
|
return pulumi.get(self, "role_arn")
|
|
698
660
|
|
|
@@ -704,7 +666,7 @@ class _IntegrationState:
|
|
|
704
666
|
@pulumi.getter
|
|
705
667
|
def services(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
706
668
|
"""
|
|
707
|
-
List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
|
|
669
|
+
List of AWS services that you want Splunk Observability Cloud to monitor. Each element is a string designating an AWS service. Can be an empty list to import data for all supported services. Conflicts with `namespace_sync_rule`. See [Amazon Web Services](https://docs.splunk.com/Observability/gdi/get-data-in/integrations.html#amazon-web-services) for a list of valid values.
|
|
708
670
|
"""
|
|
709
671
|
return pulumi.get(self, "services")
|
|
710
672
|
|
|
@@ -716,8 +678,7 @@ class _IntegrationState:
|
|
|
716
678
|
@pulumi.getter(name="syncCustomNamespacesOnly")
|
|
717
679
|
def sync_custom_namespaces_only(self) -> Optional[pulumi.Input[bool]]:
|
|
718
680
|
"""
|
|
719
|
-
Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
|
|
720
|
-
`custom_namespace_sync_rule` field for details). Defaults to `false`.
|
|
681
|
+
Indicates that Splunk Observability Cloud should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` above). Defaults to `false`.
|
|
721
682
|
"""
|
|
722
683
|
return pulumi.get(self, "sync_custom_namespaces_only")
|
|
723
684
|
|
|
@@ -729,7 +690,7 @@ class _IntegrationState:
|
|
|
729
690
|
@pulumi.getter
|
|
730
691
|
def token(self) -> Optional[pulumi.Input[str]]:
|
|
731
692
|
"""
|
|
732
|
-
|
|
693
|
+
If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the token (this is typically equivalent to the `AWS_ACCESS_KEY_ID` environment variable).
|
|
733
694
|
"""
|
|
734
695
|
return pulumi.get(self, "token")
|
|
735
696
|
|
|
@@ -741,7 +702,9 @@ class _IntegrationState:
|
|
|
741
702
|
@pulumi.getter(name="useMetricStreamsSync")
|
|
742
703
|
def use_metric_streams_sync(self) -> Optional[pulumi.Input[bool]]:
|
|
743
704
|
"""
|
|
744
|
-
|
|
705
|
+
Enable the use of Amazon Cloudwatch Metric Streams for ingesting metrics.<br>
|
|
706
|
+
Note that this requires the inclusion of `"cloudwatch:ListMetricStreams"`,`"cloudwatch:GetMetricStream"`, `"cloudwatch:PutMetricStream"`, `"cloudwatch:DeleteMetricStream"`, `"cloudwatch:StartMetricStreams"`, `"cloudwatch:StopMetricStreams"` and `"iam:PassRole"` permissions.<br>
|
|
707
|
+
Note you need to deploy additional resources on your AWS account to enable CloudWatch metrics streaming. Select one of the [CloudFormation templates](https://docs.splunk.com/Observability/gdi/get-data-in/connect/aws/aws-cloudformation.html) to deploy all the required resources.
|
|
745
708
|
"""
|
|
746
709
|
return pulumi.get(self, "use_metric_streams_sync")
|
|
747
710
|
|
|
@@ -756,7 +719,7 @@ class Integration(pulumi.CustomResource):
|
|
|
756
719
|
resource_name: str,
|
|
757
720
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
758
721
|
custom_cloudwatch_namespaces: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
759
|
-
custom_namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
722
|
+
custom_namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['IntegrationCustomNamespaceSyncRuleArgs', 'IntegrationCustomNamespaceSyncRuleArgsDict']]]]] = None,
|
|
760
723
|
enable_aws_usage: Optional[pulumi.Input[bool]] = None,
|
|
761
724
|
enable_check_large_volume: Optional[pulumi.Input[bool]] = None,
|
|
762
725
|
enable_logs_sync: Optional[pulumi.Input[bool]] = None,
|
|
@@ -765,9 +728,9 @@ class Integration(pulumi.CustomResource):
|
|
|
765
728
|
import_cloud_watch: Optional[pulumi.Input[bool]] = None,
|
|
766
729
|
integration_id: Optional[pulumi.Input[str]] = None,
|
|
767
730
|
key: Optional[pulumi.Input[str]] = None,
|
|
768
|
-
metric_stats_to_syncs: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
731
|
+
metric_stats_to_syncs: Optional[pulumi.Input[Sequence[pulumi.Input[Union['IntegrationMetricStatsToSyncArgs', 'IntegrationMetricStatsToSyncArgsDict']]]]] = None,
|
|
769
732
|
named_token: Optional[pulumi.Input[str]] = None,
|
|
770
|
-
namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
733
|
+
namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['IntegrationNamespaceSyncRuleArgs', 'IntegrationNamespaceSyncRuleArgsDict']]]]] = None,
|
|
771
734
|
poll_rate: Optional[pulumi.Input[int]] = None,
|
|
772
735
|
regions: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
773
736
|
role_arn: Optional[pulumi.Input[str]] = None,
|
|
@@ -791,109 +754,61 @@ class Integration(pulumi.CustomResource):
|
|
|
791
754
|
import pulumi_signalfx as signalfx
|
|
792
755
|
|
|
793
756
|
# This resource returns an account id in `external_id`…
|
|
794
|
-
aws_myteam_external = signalfx.aws.ExternalIntegration("
|
|
757
|
+
aws_myteam_external = signalfx.aws.ExternalIntegration("aws_myteam_external", name="My AWS integration")
|
|
795
758
|
# Make yourself an AWS IAM role here, use `signalfx_aws_external_integration.aws_myteam_external.external_id`
|
|
796
|
-
aws_sfx_role = aws.
|
|
797
|
-
|
|
798
|
-
aws_myteam = signalfx.aws.Integration("awsMyteam",
|
|
759
|
+
aws_sfx_role = aws.index.IamRole("aws_sfx_role")
|
|
760
|
+
aws_myteam = signalfx.aws.Integration("aws_myteam",
|
|
799
761
|
enabled=True,
|
|
800
762
|
integration_id=aws_myteam_external.id,
|
|
801
763
|
external_id=aws_myteam_external.external_id,
|
|
802
|
-
role_arn=aws_sfx_role
|
|
764
|
+
role_arn=aws_sfx_role["arn"],
|
|
803
765
|
regions=["us-east-1"],
|
|
804
766
|
poll_rate=300,
|
|
805
767
|
import_cloud_watch=True,
|
|
806
768
|
enable_aws_usage=True,
|
|
807
|
-
custom_namespace_sync_rules=[
|
|
808
|
-
default_action
|
|
809
|
-
filter_action
|
|
810
|
-
filter_source
|
|
811
|
-
namespace
|
|
812
|
-
|
|
813
|
-
namespace_sync_rules=[
|
|
814
|
-
default_action
|
|
815
|
-
filter_action
|
|
816
|
-
filter_source
|
|
817
|
-
namespace
|
|
818
|
-
|
|
819
|
-
metric_stats_to_syncs=[
|
|
820
|
-
namespace
|
|
821
|
-
metric
|
|
822
|
-
stats
|
|
823
|
-
|
|
769
|
+
custom_namespace_sync_rules=[{
|
|
770
|
+
"default_action": "Exclude",
|
|
771
|
+
"filter_action": "Include",
|
|
772
|
+
"filter_source": "filter('code', '200')",
|
|
773
|
+
"namespace": "my-custom-namespace",
|
|
774
|
+
}],
|
|
775
|
+
namespace_sync_rules=[{
|
|
776
|
+
"default_action": "Exclude",
|
|
777
|
+
"filter_action": "Include",
|
|
778
|
+
"filter_source": "filter('code', '200')",
|
|
779
|
+
"namespace": "AWS/EC2",
|
|
780
|
+
}],
|
|
781
|
+
metric_stats_to_syncs=[{
|
|
782
|
+
"namespace": "AWS/EC2",
|
|
783
|
+
"metric": "NetworkPacketsIn",
|
|
784
|
+
"stats": ["upper"],
|
|
785
|
+
}])
|
|
824
786
|
```
|
|
825
787
|
|
|
826
|
-
## Arguments
|
|
827
|
-
|
|
828
|
-
* `enable_aws_usage` - (Optional) Flag that controls how Splunk Observability Cloud imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, Splunk Observability Cloud imports the metrics.
|
|
829
|
-
* `enable_check_large_volume` - (Optional) Controls how Splunk Observability Cloud checks for large amounts of data for this AWS integration. If `true`, Splunk Observability Cloud monitors the amount of data coming in from the integration.
|
|
830
|
-
* `enable_logs_sync` - (Optional) Enable the AWS logs synchronization. Note that this requires the inclusion of `"logs:DescribeLogGroups"`, `"logs:DeleteSubscriptionFilter"`, `"logs:DescribeSubscriptionFilters"`, `"logs:PutSubscriptionFilter"`, and `"s3:GetBucketLogging"`, `"s3:GetBucketNotification"`, `"s3:PutBucketNotification"` permissions. Additional permissions may be required to capture logs from specific AWS services.
|
|
831
|
-
* `enabled` - (Required) Whether the integration is enabled.
|
|
832
|
-
* `external_id` - (Required) The `external_id` property from one of a `aws.ExternalIntegration` or `aws.TokenIntegration`
|
|
833
|
-
* `custom_cloudwatch_namespaces` - (Optional) List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability Cloud imports the metrics so you can monitor them.
|
|
834
|
-
* `custom_namespace_sync_rule` - (Optional) Each element controls the data collected by Splunk Observability Cloud for the specified namespace. Conflicts with the `custom_cloudwatch_namespaces` property.
|
|
835
|
-
* `default_action` - (Optional) Controls the Splunk Observability Cloud default behavior for processing data from an AWS namespace. Splunk Observability Cloud ignores this property unless you specify the `filter_action` and `filter_source` properties. If you do specify them, use this property to control how Splunk Observability Cloud treats data that doesn't match the filter. The available actions are one of `"Include"` or `"Exclude"`.
|
|
836
|
-
* `filter_action` - (Optional) Controls how Splunk Observability Cloud processes data from a custom AWS namespace. The available actions are one of `"Include"` or `"Exclude"`.
|
|
837
|
-
* `filter_source` - (Optional) Expression that selects the data that Splunk Observability Cloud should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.
|
|
838
|
-
* `namespace` - (Required) An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability Cloud. See the AWS documentation on publishing metrics for more information.
|
|
839
|
-
* `import_cloud_watch` - (Optional) Flag that controls how Splunk Observability Cloud imports Cloud Watch metrics. If true, Splunk Observability Cloud imports Cloud Watch metrics from AWS.
|
|
840
|
-
* `integration_id` - (Required) The id of one of a `aws.ExternalIntegration` or `aws.TokenIntegration`.
|
|
841
|
-
* `key` - (Optional) If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the key (this is typically equivalent to the `AWS_SECRET_ACCESS_KEY` environment variable).
|
|
842
|
-
* `metric_stats_to_sync` - (Optional) Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that Splunk Observability Cloud collects for this metric. If you specify this property, Splunk Observability Cloud retrieves only specified AWS statistics when AWS metric streams are not used. When AWS metric streams are used this property specifies additional extended statistics to collect (please note that AWS metric streams API supports percentile stats only; other stats are ignored). If you don't specify this property, Splunk Observability Cloud retrieves the AWS standard set of statistics.
|
|
843
|
-
* `metric` - (Required) AWS metric that you want to pick statistics for
|
|
844
|
-
* `namespace` - (Required) An AWS namespace having AWS metric that you want to pick statistics for
|
|
845
|
-
* `stats` - (Required) AWS statistics you want to collect
|
|
846
|
-
* `name` - (Required) Name of the integration.
|
|
847
|
-
* `named_token` - (Optional) Name of the org token to be used for data ingestion. If not specified then default access token is used.
|
|
848
|
-
* `namespace_sync_rule` - (Optional) Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability Cloud collects for the namespace. Conflicts with the `services` property. If you don't specify either property, Splunk Observability Cloud syncs all data in all AWS namespaces.
|
|
849
|
-
* `default_action` - (Optional) Controls the Splunk Observability Cloud default behavior for processing data from an AWS namespace. Splunk Observability Cloud ignores this property unless you specify the `filter_action` and `filter_source` properties. If you do specify them, use this property to control how Splunk Observability Cloud treats data that doesn't match the filter. The available actions are one of `"Include"` or `"Exclude"`.
|
|
850
|
-
* `filter_action` - (Optional) Controls how Splunk Observability Cloud processes data from a custom AWS namespace. The available actions are one of `"Include"` or `"Exclude"`.
|
|
851
|
-
* `filter_source` - (Optional) Expression that selects the data that Splunk Observability Cloud should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.
|
|
852
|
-
* `namespace` - (Required) An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability Cloud. See `services` field description below for additional information.
|
|
853
|
-
* `poll_rate` - (Optional) AWS poll rate (in seconds). Value between `60` and `600`. Default: `300`.
|
|
854
|
-
* `regions` - (Required) List of AWS regions that Splunk Observability Cloud should monitor. It cannot be empty.
|
|
855
|
-
* `role_arn` - (Optional) Role ARN that you add to an existing AWS integration object. **Note**: Ensure you use the `arn` property of your role, not the id!
|
|
856
|
-
* `services` - (Optional) List of AWS services that you want Splunk Observability Cloud to monitor. Each element is a string designating an AWS service. Can be an empty list to import data for all supported services. Conflicts with `namespace_sync_rule`. See [Amazon Web Services](https://docs.splunk.com/Observability/gdi/get-data-in/integrations.html#amazon-web-services) for a list of valid values.
|
|
857
|
-
* `sync_custom_namespaces_only` - (Optional) Indicates that Splunk Observability Cloud should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` above). Defaults to `false`.
|
|
858
|
-
* `token` - (Optional) If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the token (this is typically equivalent to the `AWS_ACCESS_KEY_ID` environment variable).
|
|
859
|
-
* `use_metric_streams_sync` - (Optional) Enable the use of Amazon Cloudwatch Metric Streams for ingesting metrics.<br>
|
|
860
|
-
Note that this requires the inclusion of `"cloudwatch:ListMetricStreams"`,`"cloudwatch:GetMetricStream"`, `"cloudwatch:PutMetricStream"`, `"cloudwatch:DeleteMetricStream"`, `"cloudwatch:StartMetricStreams"`, `"cloudwatch:StopMetricStreams"` and `"iam:PassRole"` permissions.<br>
|
|
861
|
-
Note you need to deploy additional resources on your AWS account to enable CloudWatch metrics streaming. Select one of the [CloudFormation templates](https://docs.splunk.com/Observability/gdi/get-data-in/connect/aws/aws-cloudformation.html) to deploy all the required resources.
|
|
862
|
-
|
|
863
788
|
:param str resource_name: The name of the resource.
|
|
864
789
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
865
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] custom_cloudwatch_namespaces: List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS;
|
|
866
|
-
|
|
867
|
-
:param pulumi.Input[
|
|
868
|
-
|
|
869
|
-
:param pulumi.Input[bool]
|
|
870
|
-
|
|
871
|
-
:param pulumi.Input[
|
|
872
|
-
|
|
873
|
-
:param pulumi.Input[
|
|
874
|
-
:param pulumi.Input[
|
|
875
|
-
:param pulumi.Input[
|
|
876
|
-
:param pulumi.Input[
|
|
877
|
-
|
|
878
|
-
:param pulumi.Input[
|
|
879
|
-
:param pulumi.Input[str]
|
|
880
|
-
:param pulumi.Input[
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
:param pulumi.Input[
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability
|
|
888
|
-
syncs all data in all AWS namespaces.
|
|
889
|
-
:param pulumi.Input[int] poll_rate: AWS poll rate (in seconds). Between `60` and `600`.
|
|
890
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] regions: List of AWS regions that Splunk Observability should monitor.
|
|
891
|
-
:param pulumi.Input[str] role_arn: Used with `signalfx_aws_external_integration`. Use this property to specify the AIM role ARN.
|
|
892
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] services: List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
|
|
893
|
-
:param pulumi.Input[bool] sync_custom_namespaces_only: Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
|
|
894
|
-
`custom_namespace_sync_rule` field for details). Defaults to `false`.
|
|
895
|
-
:param pulumi.Input[str] token: Used with `signalfx_aws_token_integration`. Use this property to specify the token.
|
|
896
|
-
:param pulumi.Input[bool] use_metric_streams_sync: Enables the use of Cloudwatch Metric Streams for metrics synchronization.
|
|
790
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] custom_cloudwatch_namespaces: List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability Cloud imports the metrics so you can monitor them.
|
|
791
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['IntegrationCustomNamespaceSyncRuleArgs', 'IntegrationCustomNamespaceSyncRuleArgsDict']]]] custom_namespace_sync_rules: Each element controls the data collected by Splunk Observability Cloud for the specified namespace. Conflicts with the `custom_cloudwatch_namespaces` property.
|
|
792
|
+
:param pulumi.Input[bool] enable_aws_usage: Flag that controls how Splunk Observability Cloud imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, Splunk Observability Cloud imports the metrics.
|
|
793
|
+
:param pulumi.Input[bool] enable_check_large_volume: Controls how Splunk Observability Cloud checks for large amounts of data for this AWS integration. If `true`, Splunk Observability Cloud monitors the amount of data coming in from the integration.
|
|
794
|
+
:param pulumi.Input[bool] enable_logs_sync: Enable the AWS logs synchronization. Note that this requires the inclusion of `"logs:DescribeLogGroups"`, `"logs:DeleteSubscriptionFilter"`, `"logs:DescribeSubscriptionFilters"`, `"logs:PutSubscriptionFilter"`, and `"s3:GetBucketLogging"`, `"s3:GetBucketNotification"`, `"s3:PutBucketNotification"` permissions. Additional permissions may be required to capture logs from specific AWS services.
|
|
795
|
+
:param pulumi.Input[bool] enabled: Whether the integration is enabled.
|
|
796
|
+
:param pulumi.Input[str] external_id: The `external_id` property from one of a `aws.ExternalIntegration` or `aws.TokenIntegration`
|
|
797
|
+
:param pulumi.Input[bool] import_cloud_watch: Flag that controls how Splunk Observability Cloud imports Cloud Watch metrics. If true, Splunk Observability Cloud imports Cloud Watch metrics from AWS.
|
|
798
|
+
:param pulumi.Input[str] integration_id: The id of one of a `aws.ExternalIntegration` or `aws.TokenIntegration`.
|
|
799
|
+
:param pulumi.Input[str] key: If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the key (this is typically equivalent to the `AWS_SECRET_ACCESS_KEY` environment variable).
|
|
800
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['IntegrationMetricStatsToSyncArgs', 'IntegrationMetricStatsToSyncArgsDict']]]] metric_stats_to_syncs: Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that Splunk Observability Cloud collects for this metric. If you specify this property, Splunk Observability Cloud retrieves only specified AWS statistics when AWS metric streams are not used. When AWS metric streams are used this property specifies additional extended statistics to collect (please note that AWS metric streams API supports percentile stats only; other stats are ignored). If you don't specify this property, Splunk Observability Cloud retrieves the AWS standard set of statistics.
|
|
801
|
+
:param pulumi.Input[str] named_token: Name of the org token to be used for data ingestion. If not specified then default access token is used.
|
|
802
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['IntegrationNamespaceSyncRuleArgs', 'IntegrationNamespaceSyncRuleArgsDict']]]] namespace_sync_rules: Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability Cloud collects for the namespace. Conflicts with the `services` property. If you don't specify either property, Splunk Observability Cloud syncs all data in all AWS namespaces.
|
|
803
|
+
:param pulumi.Input[int] poll_rate: AWS poll rate (in seconds). Value between `60` and `600`. Default: `300`.
|
|
804
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] regions: List of AWS regions that Splunk Observability Cloud should monitor. It cannot be empty.
|
|
805
|
+
:param pulumi.Input[str] role_arn: Role ARN that you add to an existing AWS integration object. **Note**: Ensure you use the `arn` property of your role, not the id!
|
|
806
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] services: List of AWS services that you want Splunk Observability Cloud to monitor. Each element is a string designating an AWS service. Can be an empty list to import data for all supported services. Conflicts with `namespace_sync_rule`. See [Amazon Web Services](https://docs.splunk.com/Observability/gdi/get-data-in/integrations.html#amazon-web-services) for a list of valid values.
|
|
807
|
+
:param pulumi.Input[bool] sync_custom_namespaces_only: Indicates that Splunk Observability Cloud should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` above). Defaults to `false`.
|
|
808
|
+
:param pulumi.Input[str] token: If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the token (this is typically equivalent to the `AWS_ACCESS_KEY_ID` environment variable).
|
|
809
|
+
:param pulumi.Input[bool] use_metric_streams_sync: Enable the use of Amazon Cloudwatch Metric Streams for ingesting metrics.<br>
|
|
810
|
+
Note that this requires the inclusion of `"cloudwatch:ListMetricStreams"`,`"cloudwatch:GetMetricStream"`, `"cloudwatch:PutMetricStream"`, `"cloudwatch:DeleteMetricStream"`, `"cloudwatch:StartMetricStreams"`, `"cloudwatch:StopMetricStreams"` and `"iam:PassRole"` permissions.<br>
|
|
811
|
+
Note you need to deploy additional resources on your AWS account to enable CloudWatch metrics streaming. Select one of the [CloudFormation templates](https://docs.splunk.com/Observability/gdi/get-data-in/connect/aws/aws-cloudformation.html) to deploy all the required resources.
|
|
897
812
|
"""
|
|
898
813
|
...
|
|
899
814
|
@overload
|
|
@@ -916,75 +831,37 @@ class Integration(pulumi.CustomResource):
|
|
|
916
831
|
import pulumi_signalfx as signalfx
|
|
917
832
|
|
|
918
833
|
# This resource returns an account id in `external_id`…
|
|
919
|
-
aws_myteam_external = signalfx.aws.ExternalIntegration("
|
|
834
|
+
aws_myteam_external = signalfx.aws.ExternalIntegration("aws_myteam_external", name="My AWS integration")
|
|
920
835
|
# Make yourself an AWS IAM role here, use `signalfx_aws_external_integration.aws_myteam_external.external_id`
|
|
921
|
-
aws_sfx_role = aws.
|
|
922
|
-
|
|
923
|
-
aws_myteam = signalfx.aws.Integration("awsMyteam",
|
|
836
|
+
aws_sfx_role = aws.index.IamRole("aws_sfx_role")
|
|
837
|
+
aws_myteam = signalfx.aws.Integration("aws_myteam",
|
|
924
838
|
enabled=True,
|
|
925
839
|
integration_id=aws_myteam_external.id,
|
|
926
840
|
external_id=aws_myteam_external.external_id,
|
|
927
|
-
role_arn=aws_sfx_role
|
|
841
|
+
role_arn=aws_sfx_role["arn"],
|
|
928
842
|
regions=["us-east-1"],
|
|
929
843
|
poll_rate=300,
|
|
930
844
|
import_cloud_watch=True,
|
|
931
845
|
enable_aws_usage=True,
|
|
932
|
-
custom_namespace_sync_rules=[
|
|
933
|
-
default_action
|
|
934
|
-
filter_action
|
|
935
|
-
filter_source
|
|
936
|
-
namespace
|
|
937
|
-
|
|
938
|
-
namespace_sync_rules=[
|
|
939
|
-
default_action
|
|
940
|
-
filter_action
|
|
941
|
-
filter_source
|
|
942
|
-
namespace
|
|
943
|
-
|
|
944
|
-
metric_stats_to_syncs=[
|
|
945
|
-
namespace
|
|
946
|
-
metric
|
|
947
|
-
stats
|
|
948
|
-
|
|
846
|
+
custom_namespace_sync_rules=[{
|
|
847
|
+
"default_action": "Exclude",
|
|
848
|
+
"filter_action": "Include",
|
|
849
|
+
"filter_source": "filter('code', '200')",
|
|
850
|
+
"namespace": "my-custom-namespace",
|
|
851
|
+
}],
|
|
852
|
+
namespace_sync_rules=[{
|
|
853
|
+
"default_action": "Exclude",
|
|
854
|
+
"filter_action": "Include",
|
|
855
|
+
"filter_source": "filter('code', '200')",
|
|
856
|
+
"namespace": "AWS/EC2",
|
|
857
|
+
}],
|
|
858
|
+
metric_stats_to_syncs=[{
|
|
859
|
+
"namespace": "AWS/EC2",
|
|
860
|
+
"metric": "NetworkPacketsIn",
|
|
861
|
+
"stats": ["upper"],
|
|
862
|
+
}])
|
|
949
863
|
```
|
|
950
864
|
|
|
951
|
-
## Arguments
|
|
952
|
-
|
|
953
|
-
* `enable_aws_usage` - (Optional) Flag that controls how Splunk Observability Cloud imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, Splunk Observability Cloud imports the metrics.
|
|
954
|
-
* `enable_check_large_volume` - (Optional) Controls how Splunk Observability Cloud checks for large amounts of data for this AWS integration. If `true`, Splunk Observability Cloud monitors the amount of data coming in from the integration.
|
|
955
|
-
* `enable_logs_sync` - (Optional) Enable the AWS logs synchronization. Note that this requires the inclusion of `"logs:DescribeLogGroups"`, `"logs:DeleteSubscriptionFilter"`, `"logs:DescribeSubscriptionFilters"`, `"logs:PutSubscriptionFilter"`, and `"s3:GetBucketLogging"`, `"s3:GetBucketNotification"`, `"s3:PutBucketNotification"` permissions. Additional permissions may be required to capture logs from specific AWS services.
|
|
956
|
-
* `enabled` - (Required) Whether the integration is enabled.
|
|
957
|
-
* `external_id` - (Required) The `external_id` property from one of a `aws.ExternalIntegration` or `aws.TokenIntegration`
|
|
958
|
-
* `custom_cloudwatch_namespaces` - (Optional) List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability Cloud imports the metrics so you can monitor them.
|
|
959
|
-
* `custom_namespace_sync_rule` - (Optional) Each element controls the data collected by Splunk Observability Cloud for the specified namespace. Conflicts with the `custom_cloudwatch_namespaces` property.
|
|
960
|
-
* `default_action` - (Optional) Controls the Splunk Observability Cloud default behavior for processing data from an AWS namespace. Splunk Observability Cloud ignores this property unless you specify the `filter_action` and `filter_source` properties. If you do specify them, use this property to control how Splunk Observability Cloud treats data that doesn't match the filter. The available actions are one of `"Include"` or `"Exclude"`.
|
|
961
|
-
* `filter_action` - (Optional) Controls how Splunk Observability Cloud processes data from a custom AWS namespace. The available actions are one of `"Include"` or `"Exclude"`.
|
|
962
|
-
* `filter_source` - (Optional) Expression that selects the data that Splunk Observability Cloud should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.
|
|
963
|
-
* `namespace` - (Required) An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability Cloud. See the AWS documentation on publishing metrics for more information.
|
|
964
|
-
* `import_cloud_watch` - (Optional) Flag that controls how Splunk Observability Cloud imports Cloud Watch metrics. If true, Splunk Observability Cloud imports Cloud Watch metrics from AWS.
|
|
965
|
-
* `integration_id` - (Required) The id of one of a `aws.ExternalIntegration` or `aws.TokenIntegration`.
|
|
966
|
-
* `key` - (Optional) If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the key (this is typically equivalent to the `AWS_SECRET_ACCESS_KEY` environment variable).
|
|
967
|
-
* `metric_stats_to_sync` - (Optional) Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that Splunk Observability Cloud collects for this metric. If you specify this property, Splunk Observability Cloud retrieves only specified AWS statistics when AWS metric streams are not used. When AWS metric streams are used this property specifies additional extended statistics to collect (please note that AWS metric streams API supports percentile stats only; other stats are ignored). If you don't specify this property, Splunk Observability Cloud retrieves the AWS standard set of statistics.
|
|
968
|
-
* `metric` - (Required) AWS metric that you want to pick statistics for
|
|
969
|
-
* `namespace` - (Required) An AWS namespace having AWS metric that you want to pick statistics for
|
|
970
|
-
* `stats` - (Required) AWS statistics you want to collect
|
|
971
|
-
* `name` - (Required) Name of the integration.
|
|
972
|
-
* `named_token` - (Optional) Name of the org token to be used for data ingestion. If not specified then default access token is used.
|
|
973
|
-
* `namespace_sync_rule` - (Optional) Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability Cloud collects for the namespace. Conflicts with the `services` property. If you don't specify either property, Splunk Observability Cloud syncs all data in all AWS namespaces.
|
|
974
|
-
* `default_action` - (Optional) Controls the Splunk Observability Cloud default behavior for processing data from an AWS namespace. Splunk Observability Cloud ignores this property unless you specify the `filter_action` and `filter_source` properties. If you do specify them, use this property to control how Splunk Observability Cloud treats data that doesn't match the filter. The available actions are one of `"Include"` or `"Exclude"`.
|
|
975
|
-
* `filter_action` - (Optional) Controls how Splunk Observability Cloud processes data from a custom AWS namespace. The available actions are one of `"Include"` or `"Exclude"`.
|
|
976
|
-
* `filter_source` - (Optional) Expression that selects the data that Splunk Observability Cloud should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.
|
|
977
|
-
* `namespace` - (Required) An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability Cloud. See `services` field description below for additional information.
|
|
978
|
-
* `poll_rate` - (Optional) AWS poll rate (in seconds). Value between `60` and `600`. Default: `300`.
|
|
979
|
-
* `regions` - (Required) List of AWS regions that Splunk Observability Cloud should monitor. It cannot be empty.
|
|
980
|
-
* `role_arn` - (Optional) Role ARN that you add to an existing AWS integration object. **Note**: Ensure you use the `arn` property of your role, not the id!
|
|
981
|
-
* `services` - (Optional) List of AWS services that you want Splunk Observability Cloud to monitor. Each element is a string designating an AWS service. Can be an empty list to import data for all supported services. Conflicts with `namespace_sync_rule`. See [Amazon Web Services](https://docs.splunk.com/Observability/gdi/get-data-in/integrations.html#amazon-web-services) for a list of valid values.
|
|
982
|
-
* `sync_custom_namespaces_only` - (Optional) Indicates that Splunk Observability Cloud should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` above). Defaults to `false`.
|
|
983
|
-
* `token` - (Optional) If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the token (this is typically equivalent to the `AWS_ACCESS_KEY_ID` environment variable).
|
|
984
|
-
* `use_metric_streams_sync` - (Optional) Enable the use of Amazon Cloudwatch Metric Streams for ingesting metrics.<br>
|
|
985
|
-
Note that this requires the inclusion of `"cloudwatch:ListMetricStreams"`,`"cloudwatch:GetMetricStream"`, `"cloudwatch:PutMetricStream"`, `"cloudwatch:DeleteMetricStream"`, `"cloudwatch:StartMetricStreams"`, `"cloudwatch:StopMetricStreams"` and `"iam:PassRole"` permissions.<br>
|
|
986
|
-
Note you need to deploy additional resources on your AWS account to enable CloudWatch metrics streaming. Select one of the [CloudFormation templates](https://docs.splunk.com/Observability/gdi/get-data-in/connect/aws/aws-cloudformation.html) to deploy all the required resources.
|
|
987
|
-
|
|
988
865
|
:param str resource_name: The name of the resource.
|
|
989
866
|
:param IntegrationArgs args: The arguments to use to populate this resource's properties.
|
|
990
867
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
@@ -1001,7 +878,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1001
878
|
resource_name: str,
|
|
1002
879
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
1003
880
|
custom_cloudwatch_namespaces: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1004
|
-
custom_namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
881
|
+
custom_namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['IntegrationCustomNamespaceSyncRuleArgs', 'IntegrationCustomNamespaceSyncRuleArgsDict']]]]] = None,
|
|
1005
882
|
enable_aws_usage: Optional[pulumi.Input[bool]] = None,
|
|
1006
883
|
enable_check_large_volume: Optional[pulumi.Input[bool]] = None,
|
|
1007
884
|
enable_logs_sync: Optional[pulumi.Input[bool]] = None,
|
|
@@ -1010,9 +887,9 @@ class Integration(pulumi.CustomResource):
|
|
|
1010
887
|
import_cloud_watch: Optional[pulumi.Input[bool]] = None,
|
|
1011
888
|
integration_id: Optional[pulumi.Input[str]] = None,
|
|
1012
889
|
key: Optional[pulumi.Input[str]] = None,
|
|
1013
|
-
metric_stats_to_syncs: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
890
|
+
metric_stats_to_syncs: Optional[pulumi.Input[Sequence[pulumi.Input[Union['IntegrationMetricStatsToSyncArgs', 'IntegrationMetricStatsToSyncArgsDict']]]]] = None,
|
|
1014
891
|
named_token: Optional[pulumi.Input[str]] = None,
|
|
1015
|
-
namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
892
|
+
namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['IntegrationNamespaceSyncRuleArgs', 'IntegrationNamespaceSyncRuleArgsDict']]]]] = None,
|
|
1016
893
|
poll_rate: Optional[pulumi.Input[int]] = None,
|
|
1017
894
|
regions: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1018
895
|
role_arn: Optional[pulumi.Input[str]] = None,
|
|
@@ -1071,7 +948,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1071
948
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
1072
949
|
auth_method: Optional[pulumi.Input[str]] = None,
|
|
1073
950
|
custom_cloudwatch_namespaces: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1074
|
-
custom_namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
951
|
+
custom_namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['IntegrationCustomNamespaceSyncRuleArgs', 'IntegrationCustomNamespaceSyncRuleArgsDict']]]]] = None,
|
|
1075
952
|
enable_aws_usage: Optional[pulumi.Input[bool]] = None,
|
|
1076
953
|
enable_check_large_volume: Optional[pulumi.Input[bool]] = None,
|
|
1077
954
|
enable_logs_sync: Optional[pulumi.Input[bool]] = None,
|
|
@@ -1080,10 +957,10 @@ class Integration(pulumi.CustomResource):
|
|
|
1080
957
|
import_cloud_watch: Optional[pulumi.Input[bool]] = None,
|
|
1081
958
|
integration_id: Optional[pulumi.Input[str]] = None,
|
|
1082
959
|
key: Optional[pulumi.Input[str]] = None,
|
|
1083
|
-
metric_stats_to_syncs: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
960
|
+
metric_stats_to_syncs: Optional[pulumi.Input[Sequence[pulumi.Input[Union['IntegrationMetricStatsToSyncArgs', 'IntegrationMetricStatsToSyncArgsDict']]]]] = None,
|
|
1084
961
|
name: Optional[pulumi.Input[str]] = None,
|
|
1085
962
|
named_token: Optional[pulumi.Input[str]] = None,
|
|
1086
|
-
namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
963
|
+
namespace_sync_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['IntegrationNamespaceSyncRuleArgs', 'IntegrationNamespaceSyncRuleArgsDict']]]]] = None,
|
|
1087
964
|
poll_rate: Optional[pulumi.Input[int]] = None,
|
|
1088
965
|
regions: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1089
966
|
role_arn: Optional[pulumi.Input[str]] = None,
|
|
@@ -1098,42 +975,31 @@ class Integration(pulumi.CustomResource):
|
|
|
1098
975
|
:param str resource_name: The unique name of the resulting resource.
|
|
1099
976
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
1100
977
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
1101
|
-
:param pulumi.Input[str] auth_method: The mechanism used to authenticate with AWS. Use one of `
|
|
1102
|
-
|
|
1103
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] custom_cloudwatch_namespaces: List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS;
|
|
1104
|
-
|
|
1105
|
-
:param pulumi.Input[
|
|
1106
|
-
|
|
1107
|
-
:param pulumi.Input[bool]
|
|
1108
|
-
|
|
1109
|
-
:param pulumi.Input[
|
|
1110
|
-
|
|
1111
|
-
:param pulumi.Input[
|
|
1112
|
-
:param pulumi.Input[
|
|
1113
|
-
:param pulumi.Input[
|
|
1114
|
-
:param pulumi.Input[
|
|
1115
|
-
|
|
1116
|
-
:param pulumi.Input[
|
|
1117
|
-
:param pulumi.Input[
|
|
1118
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
:param pulumi.Input[str]
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values
|
|
1127
|
-
in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability
|
|
1128
|
-
syncs all data in all AWS namespaces.
|
|
1129
|
-
:param pulumi.Input[int] poll_rate: AWS poll rate (in seconds). Between `60` and `600`.
|
|
1130
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] regions: List of AWS regions that Splunk Observability should monitor.
|
|
1131
|
-
:param pulumi.Input[str] role_arn: Used with `signalfx_aws_external_integration`. Use this property to specify the AIM role ARN.
|
|
1132
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] services: List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
|
|
1133
|
-
:param pulumi.Input[bool] sync_custom_namespaces_only: Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
|
|
1134
|
-
`custom_namespace_sync_rule` field for details). Defaults to `false`.
|
|
1135
|
-
:param pulumi.Input[str] token: Used with `signalfx_aws_token_integration`. Use this property to specify the token.
|
|
1136
|
-
:param pulumi.Input[bool] use_metric_streams_sync: Enables the use of Cloudwatch Metric Streams for metrics synchronization.
|
|
978
|
+
:param pulumi.Input[str] auth_method: The mechanism used to authenticate with AWS. Use one of `aws.ExternalIntegration` or `aws.TokenIntegration` to define
|
|
979
|
+
this
|
|
980
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] custom_cloudwatch_namespaces: List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability Cloud imports the metrics so you can monitor them.
|
|
981
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['IntegrationCustomNamespaceSyncRuleArgs', 'IntegrationCustomNamespaceSyncRuleArgsDict']]]] custom_namespace_sync_rules: Each element controls the data collected by Splunk Observability Cloud for the specified namespace. Conflicts with the `custom_cloudwatch_namespaces` property.
|
|
982
|
+
:param pulumi.Input[bool] enable_aws_usage: Flag that controls how Splunk Observability Cloud imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, Splunk Observability Cloud imports the metrics.
|
|
983
|
+
:param pulumi.Input[bool] enable_check_large_volume: Controls how Splunk Observability Cloud checks for large amounts of data for this AWS integration. If `true`, Splunk Observability Cloud monitors the amount of data coming in from the integration.
|
|
984
|
+
:param pulumi.Input[bool] enable_logs_sync: Enable the AWS logs synchronization. Note that this requires the inclusion of `"logs:DescribeLogGroups"`, `"logs:DeleteSubscriptionFilter"`, `"logs:DescribeSubscriptionFilters"`, `"logs:PutSubscriptionFilter"`, and `"s3:GetBucketLogging"`, `"s3:GetBucketNotification"`, `"s3:PutBucketNotification"` permissions. Additional permissions may be required to capture logs from specific AWS services.
|
|
985
|
+
:param pulumi.Input[bool] enabled: Whether the integration is enabled.
|
|
986
|
+
:param pulumi.Input[str] external_id: The `external_id` property from one of a `aws.ExternalIntegration` or `aws.TokenIntegration`
|
|
987
|
+
:param pulumi.Input[bool] import_cloud_watch: Flag that controls how Splunk Observability Cloud imports Cloud Watch metrics. If true, Splunk Observability Cloud imports Cloud Watch metrics from AWS.
|
|
988
|
+
:param pulumi.Input[str] integration_id: The id of one of a `aws.ExternalIntegration` or `aws.TokenIntegration`.
|
|
989
|
+
:param pulumi.Input[str] key: If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the key (this is typically equivalent to the `AWS_SECRET_ACCESS_KEY` environment variable).
|
|
990
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['IntegrationMetricStatsToSyncArgs', 'IntegrationMetricStatsToSyncArgsDict']]]] metric_stats_to_syncs: Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that Splunk Observability Cloud collects for this metric. If you specify this property, Splunk Observability Cloud retrieves only specified AWS statistics when AWS metric streams are not used. When AWS metric streams are used this property specifies additional extended statistics to collect (please note that AWS metric streams API supports percentile stats only; other stats are ignored). If you don't specify this property, Splunk Observability Cloud retrieves the AWS standard set of statistics.
|
|
991
|
+
:param pulumi.Input[str] name: Name of the integration.
|
|
992
|
+
:param pulumi.Input[str] named_token: Name of the org token to be used for data ingestion. If not specified then default access token is used.
|
|
993
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['IntegrationNamespaceSyncRuleArgs', 'IntegrationNamespaceSyncRuleArgsDict']]]] namespace_sync_rules: Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability Cloud collects for the namespace. Conflicts with the `services` property. If you don't specify either property, Splunk Observability Cloud syncs all data in all AWS namespaces.
|
|
994
|
+
:param pulumi.Input[int] poll_rate: AWS poll rate (in seconds). Value between `60` and `600`. Default: `300`.
|
|
995
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] regions: List of AWS regions that Splunk Observability Cloud should monitor. It cannot be empty.
|
|
996
|
+
:param pulumi.Input[str] role_arn: Role ARN that you add to an existing AWS integration object. **Note**: Ensure you use the `arn` property of your role, not the id!
|
|
997
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] services: List of AWS services that you want Splunk Observability Cloud to monitor. Each element is a string designating an AWS service. Can be an empty list to import data for all supported services. Conflicts with `namespace_sync_rule`. See [Amazon Web Services](https://docs.splunk.com/Observability/gdi/get-data-in/integrations.html#amazon-web-services) for a list of valid values.
|
|
998
|
+
:param pulumi.Input[bool] sync_custom_namespaces_only: Indicates that Splunk Observability Cloud should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` above). Defaults to `false`.
|
|
999
|
+
:param pulumi.Input[str] token: If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the token (this is typically equivalent to the `AWS_ACCESS_KEY_ID` environment variable).
|
|
1000
|
+
:param pulumi.Input[bool] use_metric_streams_sync: Enable the use of Amazon Cloudwatch Metric Streams for ingesting metrics.<br>
|
|
1001
|
+
Note that this requires the inclusion of `"cloudwatch:ListMetricStreams"`,`"cloudwatch:GetMetricStream"`, `"cloudwatch:PutMetricStream"`, `"cloudwatch:DeleteMetricStream"`, `"cloudwatch:StartMetricStreams"`, `"cloudwatch:StopMetricStreams"` and `"iam:PassRole"` permissions.<br>
|
|
1002
|
+
Note you need to deploy additional resources on your AWS account to enable CloudWatch metrics streaming. Select one of the [CloudFormation templates](https://docs.splunk.com/Observability/gdi/get-data-in/connect/aws/aws-cloudformation.html) to deploy all the required resources.
|
|
1137
1003
|
"""
|
|
1138
1004
|
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
1139
1005
|
|
|
@@ -1167,8 +1033,8 @@ class Integration(pulumi.CustomResource):
|
|
|
1167
1033
|
@pulumi.getter(name="authMethod")
|
|
1168
1034
|
def auth_method(self) -> pulumi.Output[str]:
|
|
1169
1035
|
"""
|
|
1170
|
-
The mechanism used to authenticate with AWS. Use one of `
|
|
1171
|
-
|
|
1036
|
+
The mechanism used to authenticate with AWS. Use one of `aws.ExternalIntegration` or `aws.TokenIntegration` to define
|
|
1037
|
+
this
|
|
1172
1038
|
"""
|
|
1173
1039
|
return pulumi.get(self, "auth_method")
|
|
1174
1040
|
|
|
@@ -1176,8 +1042,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1176
1042
|
@pulumi.getter(name="customCloudwatchNamespaces")
|
|
1177
1043
|
def custom_cloudwatch_namespaces(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
|
1178
1044
|
"""
|
|
1179
|
-
List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS;
|
|
1180
|
-
Splunk Observability imports the metrics so you can monitor them.
|
|
1045
|
+
List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability Cloud imports the metrics so you can monitor them.
|
|
1181
1046
|
"""
|
|
1182
1047
|
return pulumi.get(self, "custom_cloudwatch_namespaces")
|
|
1183
1048
|
|
|
@@ -1185,8 +1050,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1185
1050
|
@pulumi.getter(name="customNamespaceSyncRules")
|
|
1186
1051
|
def custom_namespace_sync_rules(self) -> pulumi.Output[Optional[Sequence['outputs.IntegrationCustomNamespaceSyncRule']]]:
|
|
1187
1052
|
"""
|
|
1188
|
-
Each element controls the data collected by Splunk Observability for the specified namespace.
|
|
1189
|
-
property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
|
|
1053
|
+
Each element controls the data collected by Splunk Observability Cloud for the specified namespace. Conflicts with the `custom_cloudwatch_namespaces` property.
|
|
1190
1054
|
"""
|
|
1191
1055
|
return pulumi.get(self, "custom_namespace_sync_rules")
|
|
1192
1056
|
|
|
@@ -1194,8 +1058,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1194
1058
|
@pulumi.getter(name="enableAwsUsage")
|
|
1195
1059
|
def enable_aws_usage(self) -> pulumi.Output[Optional[bool]]:
|
|
1196
1060
|
"""
|
|
1197
|
-
Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`,
|
|
1198
|
-
Splunk Observability imports the metrics.
|
|
1061
|
+
Flag that controls how Splunk Observability Cloud imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, Splunk Observability Cloud imports the metrics.
|
|
1199
1062
|
"""
|
|
1200
1063
|
return pulumi.get(self, "enable_aws_usage")
|
|
1201
1064
|
|
|
@@ -1203,8 +1066,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1203
1066
|
@pulumi.getter(name="enableCheckLargeVolume")
|
|
1204
1067
|
def enable_check_large_volume(self) -> pulumi.Output[Optional[bool]]:
|
|
1205
1068
|
"""
|
|
1206
|
-
Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true
|
|
1207
|
-
Observability monitors the amount of data coming in from the integration.
|
|
1069
|
+
Controls how Splunk Observability Cloud checks for large amounts of data for this AWS integration. If `true`, Splunk Observability Cloud monitors the amount of data coming in from the integration.
|
|
1208
1070
|
"""
|
|
1209
1071
|
return pulumi.get(self, "enable_check_large_volume")
|
|
1210
1072
|
|
|
@@ -1212,7 +1074,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1212
1074
|
@pulumi.getter(name="enableLogsSync")
|
|
1213
1075
|
def enable_logs_sync(self) -> pulumi.Output[bool]:
|
|
1214
1076
|
"""
|
|
1215
|
-
|
|
1077
|
+
Enable the AWS logs synchronization. Note that this requires the inclusion of `"logs:DescribeLogGroups"`, `"logs:DeleteSubscriptionFilter"`, `"logs:DescribeSubscriptionFilters"`, `"logs:PutSubscriptionFilter"`, and `"s3:GetBucketLogging"`, `"s3:GetBucketNotification"`, `"s3:PutBucketNotification"` permissions. Additional permissions may be required to capture logs from specific AWS services.
|
|
1216
1078
|
"""
|
|
1217
1079
|
return pulumi.get(self, "enable_logs_sync")
|
|
1218
1080
|
|
|
@@ -1220,7 +1082,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1220
1082
|
@pulumi.getter
|
|
1221
1083
|
def enabled(self) -> pulumi.Output[bool]:
|
|
1222
1084
|
"""
|
|
1223
|
-
Whether the integration is enabled
|
|
1085
|
+
Whether the integration is enabled.
|
|
1224
1086
|
"""
|
|
1225
1087
|
return pulumi.get(self, "enabled")
|
|
1226
1088
|
|
|
@@ -1228,7 +1090,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1228
1090
|
@pulumi.getter(name="externalId")
|
|
1229
1091
|
def external_id(self) -> pulumi.Output[Optional[str]]:
|
|
1230
1092
|
"""
|
|
1231
|
-
|
|
1093
|
+
The `external_id` property from one of a `aws.ExternalIntegration` or `aws.TokenIntegration`
|
|
1232
1094
|
"""
|
|
1233
1095
|
return pulumi.get(self, "external_id")
|
|
1234
1096
|
|
|
@@ -1236,8 +1098,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1236
1098
|
@pulumi.getter(name="importCloudWatch")
|
|
1237
1099
|
def import_cloud_watch(self) -> pulumi.Output[Optional[bool]]:
|
|
1238
1100
|
"""
|
|
1239
|
-
Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud
|
|
1240
|
-
Watch metrics from AWS.
|
|
1101
|
+
Flag that controls how Splunk Observability Cloud imports Cloud Watch metrics. If true, Splunk Observability Cloud imports Cloud Watch metrics from AWS.
|
|
1241
1102
|
"""
|
|
1242
1103
|
return pulumi.get(self, "import_cloud_watch")
|
|
1243
1104
|
|
|
@@ -1245,7 +1106,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1245
1106
|
@pulumi.getter(name="integrationId")
|
|
1246
1107
|
def integration_id(self) -> pulumi.Output[str]:
|
|
1247
1108
|
"""
|
|
1248
|
-
The
|
|
1109
|
+
The id of one of a `aws.ExternalIntegration` or `aws.TokenIntegration`.
|
|
1249
1110
|
"""
|
|
1250
1111
|
return pulumi.get(self, "integration_id")
|
|
1251
1112
|
|
|
@@ -1253,7 +1114,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1253
1114
|
@pulumi.getter
|
|
1254
1115
|
def key(self) -> pulumi.Output[Optional[str]]:
|
|
1255
1116
|
"""
|
|
1256
|
-
|
|
1117
|
+
If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the key (this is typically equivalent to the `AWS_SECRET_ACCESS_KEY` environment variable).
|
|
1257
1118
|
"""
|
|
1258
1119
|
return pulumi.get(self, "key")
|
|
1259
1120
|
|
|
@@ -1261,10 +1122,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1261
1122
|
@pulumi.getter(name="metricStatsToSyncs")
|
|
1262
1123
|
def metric_stats_to_syncs(self) -> pulumi.Output[Optional[Sequence['outputs.IntegrationMetricStatsToSync']]]:
|
|
1263
1124
|
"""
|
|
1264
|
-
Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics
|
|
1265
|
-
that Splunk Observability collects for this metric. If you specify this property, Splunk Observability retrieves only
|
|
1266
|
-
specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of
|
|
1267
|
-
statistics.
|
|
1125
|
+
Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that Splunk Observability Cloud collects for this metric. If you specify this property, Splunk Observability Cloud retrieves only specified AWS statistics when AWS metric streams are not used. When AWS metric streams are used this property specifies additional extended statistics to collect (please note that AWS metric streams API supports percentile stats only; other stats are ignored). If you don't specify this property, Splunk Observability Cloud retrieves the AWS standard set of statistics.
|
|
1268
1126
|
"""
|
|
1269
1127
|
return pulumi.get(self, "metric_stats_to_syncs")
|
|
1270
1128
|
|
|
@@ -1272,8 +1130,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1272
1130
|
@pulumi.getter
|
|
1273
1131
|
def name(self) -> pulumi.Output[str]:
|
|
1274
1132
|
"""
|
|
1275
|
-
Name of the integration.
|
|
1276
|
-
`signalfx_aws_integration_token`
|
|
1133
|
+
Name of the integration.
|
|
1277
1134
|
"""
|
|
1278
1135
|
return pulumi.get(self, "name")
|
|
1279
1136
|
|
|
@@ -1281,7 +1138,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1281
1138
|
@pulumi.getter(name="namedToken")
|
|
1282
1139
|
def named_token(self) -> pulumi.Output[Optional[str]]:
|
|
1283
1140
|
"""
|
|
1284
|
-
|
|
1141
|
+
Name of the org token to be used for data ingestion. If not specified then default access token is used.
|
|
1285
1142
|
"""
|
|
1286
1143
|
return pulumi.get(self, "named_token")
|
|
1287
1144
|
|
|
@@ -1289,10 +1146,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1289
1146
|
@pulumi.getter(name="namespaceSyncRules")
|
|
1290
1147
|
def namespace_sync_rules(self) -> pulumi.Output[Optional[Sequence['outputs.IntegrationNamespaceSyncRule']]]:
|
|
1291
1148
|
"""
|
|
1292
|
-
Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that
|
|
1293
|
-
Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values
|
|
1294
|
-
in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability
|
|
1295
|
-
syncs all data in all AWS namespaces.
|
|
1149
|
+
Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability Cloud collects for the namespace. Conflicts with the `services` property. If you don't specify either property, Splunk Observability Cloud syncs all data in all AWS namespaces.
|
|
1296
1150
|
"""
|
|
1297
1151
|
return pulumi.get(self, "namespace_sync_rules")
|
|
1298
1152
|
|
|
@@ -1300,7 +1154,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1300
1154
|
@pulumi.getter(name="pollRate")
|
|
1301
1155
|
def poll_rate(self) -> pulumi.Output[Optional[int]]:
|
|
1302
1156
|
"""
|
|
1303
|
-
AWS poll rate (in seconds).
|
|
1157
|
+
AWS poll rate (in seconds). Value between `60` and `600`. Default: `300`.
|
|
1304
1158
|
"""
|
|
1305
1159
|
return pulumi.get(self, "poll_rate")
|
|
1306
1160
|
|
|
@@ -1308,7 +1162,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1308
1162
|
@pulumi.getter
|
|
1309
1163
|
def regions(self) -> pulumi.Output[Sequence[str]]:
|
|
1310
1164
|
"""
|
|
1311
|
-
List of AWS regions that Splunk Observability should monitor.
|
|
1165
|
+
List of AWS regions that Splunk Observability Cloud should monitor. It cannot be empty.
|
|
1312
1166
|
"""
|
|
1313
1167
|
return pulumi.get(self, "regions")
|
|
1314
1168
|
|
|
@@ -1316,7 +1170,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1316
1170
|
@pulumi.getter(name="roleArn")
|
|
1317
1171
|
def role_arn(self) -> pulumi.Output[Optional[str]]:
|
|
1318
1172
|
"""
|
|
1319
|
-
|
|
1173
|
+
Role ARN that you add to an existing AWS integration object. **Note**: Ensure you use the `arn` property of your role, not the id!
|
|
1320
1174
|
"""
|
|
1321
1175
|
return pulumi.get(self, "role_arn")
|
|
1322
1176
|
|
|
@@ -1324,7 +1178,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1324
1178
|
@pulumi.getter
|
|
1325
1179
|
def services(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
|
1326
1180
|
"""
|
|
1327
|
-
List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
|
|
1181
|
+
List of AWS services that you want Splunk Observability Cloud to monitor. Each element is a string designating an AWS service. Can be an empty list to import data for all supported services. Conflicts with `namespace_sync_rule`. See [Amazon Web Services](https://docs.splunk.com/Observability/gdi/get-data-in/integrations.html#amazon-web-services) for a list of valid values.
|
|
1328
1182
|
"""
|
|
1329
1183
|
return pulumi.get(self, "services")
|
|
1330
1184
|
|
|
@@ -1332,8 +1186,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1332
1186
|
@pulumi.getter(name="syncCustomNamespacesOnly")
|
|
1333
1187
|
def sync_custom_namespaces_only(self) -> pulumi.Output[Optional[bool]]:
|
|
1334
1188
|
"""
|
|
1335
|
-
Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
|
|
1336
|
-
`custom_namespace_sync_rule` field for details). Defaults to `false`.
|
|
1189
|
+
Indicates that Splunk Observability Cloud should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` above). Defaults to `false`.
|
|
1337
1190
|
"""
|
|
1338
1191
|
return pulumi.get(self, "sync_custom_namespaces_only")
|
|
1339
1192
|
|
|
@@ -1341,7 +1194,7 @@ class Integration(pulumi.CustomResource):
|
|
|
1341
1194
|
@pulumi.getter
|
|
1342
1195
|
def token(self) -> pulumi.Output[Optional[str]]:
|
|
1343
1196
|
"""
|
|
1344
|
-
|
|
1197
|
+
If you specify `auth_method = \\"SecurityToken\\"` in your request to create an AWS integration object, use this property to specify the token (this is typically equivalent to the `AWS_ACCESS_KEY_ID` environment variable).
|
|
1345
1198
|
"""
|
|
1346
1199
|
return pulumi.get(self, "token")
|
|
1347
1200
|
|
|
@@ -1349,7 +1202,9 @@ class Integration(pulumi.CustomResource):
|
|
|
1349
1202
|
@pulumi.getter(name="useMetricStreamsSync")
|
|
1350
1203
|
def use_metric_streams_sync(self) -> pulumi.Output[bool]:
|
|
1351
1204
|
"""
|
|
1352
|
-
|
|
1205
|
+
Enable the use of Amazon Cloudwatch Metric Streams for ingesting metrics.<br>
|
|
1206
|
+
Note that this requires the inclusion of `"cloudwatch:ListMetricStreams"`,`"cloudwatch:GetMetricStream"`, `"cloudwatch:PutMetricStream"`, `"cloudwatch:DeleteMetricStream"`, `"cloudwatch:StartMetricStreams"`, `"cloudwatch:StopMetricStreams"` and `"iam:PassRole"` permissions.<br>
|
|
1207
|
+
Note you need to deploy additional resources on your AWS account to enable CloudWatch metrics streaming. Select one of the [CloudFormation templates](https://docs.splunk.com/Observability/gdi/get-data-in/connect/aws/aws-cloudformation.html) to deploy all the required resources.
|
|
1353
1208
|
"""
|
|
1354
1209
|
return pulumi.get(self, "use_metric_streams_sync")
|
|
1355
1210
|
|