signalfx.aws.Integration
Explore with Pulumi AI
AWS CloudWatch integrations for Splunk Observability Cloud. For help with this integration see Monitoring Amazon Web Services.
This resource implements a part of a workflow. Use it with one of either signalfx.aws.ExternalIntegration
or signalfx.aws.TokenIntegration
.
NOTE When managing integrations, use a session token of an administrator to authenticate the Splunk Observability provider. See Operations that require a session token for an administrator.
Example
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as signalfx from "@pulumi/signalfx";
// This resource returns an account id in `external_id`…
const awsMyteamExternal = new signalfx.aws.ExternalIntegration("awsMyteamExternal", {});
// Make yourself an AWS IAM role here, use `signalfx_aws_external_integration.aws_myteam_external.external_id`
const awsSfxRole = new aws.iam.Role("awsSfxRole", {});
// Stuff here that uses the external and account ID
const awsMyteam = new signalfx.aws.Integration("awsMyteam", {
enabled: true,
integrationId: awsMyteamExternal.id,
externalId: awsMyteamExternal.externalId,
roleArn: awsSfxRole.arn,
regions: ["us-east-1"],
pollRate: 300,
importCloudWatch: true,
enableAwsUsage: true,
customNamespaceSyncRules: [{
defaultAction: "Exclude",
filterAction: "Include",
filterSource: "filter('code', '200')",
namespace: "my-custom-namespace",
}],
namespaceSyncRules: [{
defaultAction: "Exclude",
filterAction: "Include",
filterSource: "filter('code', '200')",
namespace: "AWS/EC2",
}],
metricStatsToSyncs: [{
namespace: "AWS/EC2",
metric: "NetworkPacketsIn",
stats: ["upper"],
}],
});
import pulumi
import pulumi_aws as aws
import pulumi_signalfx as signalfx
# This resource returns an account id in `external_id`…
aws_myteam_external = signalfx.aws.ExternalIntegration("awsMyteamExternal")
# Make yourself an AWS IAM role here, use `signalfx_aws_external_integration.aws_myteam_external.external_id`
aws_sfx_role = aws.iam.Role("awsSfxRole")
# Stuff here that uses the external and account ID
aws_myteam = signalfx.aws.Integration("awsMyteam",
enabled=True,
integration_id=aws_myteam_external.id,
external_id=aws_myteam_external.external_id,
role_arn=aws_sfx_role.arn,
regions=["us-east-1"],
poll_rate=300,
import_cloud_watch=True,
enable_aws_usage=True,
custom_namespace_sync_rules=[signalfx.aws.IntegrationCustomNamespaceSyncRuleArgs(
default_action="Exclude",
filter_action="Include",
filter_source="filter('code', '200')",
namespace="my-custom-namespace",
)],
namespace_sync_rules=[signalfx.aws.IntegrationNamespaceSyncRuleArgs(
default_action="Exclude",
filter_action="Include",
filter_source="filter('code', '200')",
namespace="AWS/EC2",
)],
metric_stats_to_syncs=[signalfx.aws.IntegrationMetricStatsToSyncArgs(
namespace="AWS/EC2",
metric="NetworkPacketsIn",
stats=["upper"],
)])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using SignalFx = Pulumi.SignalFx;
return await Deployment.RunAsync(() =>
{
// This resource returns an account id in `external_id`…
var awsMyteamExternal = new SignalFx.Aws.ExternalIntegration("awsMyteamExternal");
// Make yourself an AWS IAM role here, use `signalfx_aws_external_integration.aws_myteam_external.external_id`
var awsSfxRole = new Aws.Iam.Role("awsSfxRole");
// Stuff here that uses the external and account ID
var awsMyteam = new SignalFx.Aws.Integration("awsMyteam", new()
{
Enabled = true,
IntegrationId = awsMyteamExternal.Id,
ExternalId = awsMyteamExternal.ExternalId,
RoleArn = awsSfxRole.Arn,
Regions = new[]
{
"us-east-1",
},
PollRate = 300,
ImportCloudWatch = true,
EnableAwsUsage = true,
CustomNamespaceSyncRules = new[]
{
new SignalFx.Aws.Inputs.IntegrationCustomNamespaceSyncRuleArgs
{
DefaultAction = "Exclude",
FilterAction = "Include",
FilterSource = "filter('code', '200')",
Namespace = "my-custom-namespace",
},
},
NamespaceSyncRules = new[]
{
new SignalFx.Aws.Inputs.IntegrationNamespaceSyncRuleArgs
{
DefaultAction = "Exclude",
FilterAction = "Include",
FilterSource = "filter('code', '200')",
Namespace = "AWS/EC2",
},
},
MetricStatsToSyncs = new[]
{
new SignalFx.Aws.Inputs.IntegrationMetricStatsToSyncArgs
{
Namespace = "AWS/EC2",
Metric = "NetworkPacketsIn",
Stats = new[]
{
"upper",
},
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/iam"
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx/aws"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
awsMyteamExternal, err := aws.NewExternalIntegration(ctx, "awsMyteamExternal", nil)
if err != nil {
return err
}
awsSfxRole, err := iam.NewRole(ctx, "awsSfxRole", nil)
if err != nil {
return err
}
_, err = aws.NewIntegration(ctx, "awsMyteam", &aws.IntegrationArgs{
Enabled: pulumi.Bool(true),
IntegrationId: awsMyteamExternal.ID(),
ExternalId: awsMyteamExternal.ExternalId,
RoleArn: awsSfxRole.Arn,
Regions: pulumi.StringArray{
pulumi.String("us-east-1"),
},
PollRate: pulumi.Int(300),
ImportCloudWatch: pulumi.Bool(true),
EnableAwsUsage: pulumi.Bool(true),
CustomNamespaceSyncRules: aws.IntegrationCustomNamespaceSyncRuleArray{
&aws.IntegrationCustomNamespaceSyncRuleArgs{
DefaultAction: pulumi.String("Exclude"),
FilterAction: pulumi.String("Include"),
FilterSource: pulumi.String("filter('code', '200')"),
Namespace: pulumi.String("my-custom-namespace"),
},
},
NamespaceSyncRules: aws.IntegrationNamespaceSyncRuleArray{
&aws.IntegrationNamespaceSyncRuleArgs{
DefaultAction: pulumi.String("Exclude"),
FilterAction: pulumi.String("Include"),
FilterSource: pulumi.String("filter('code', '200')"),
Namespace: pulumi.String("AWS/EC2"),
},
},
MetricStatsToSyncs: aws.IntegrationMetricStatsToSyncArray{
&aws.IntegrationMetricStatsToSyncArgs{
Namespace: pulumi.String("AWS/EC2"),
Metric: pulumi.String("NetworkPacketsIn"),
Stats: pulumi.StringArray{
pulumi.String("upper"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.aws.ExternalIntegration;
import com.pulumi.aws.iam.Role;
import com.pulumi.signalfx.aws.Integration;
import com.pulumi.signalfx.aws.IntegrationArgs;
import com.pulumi.signalfx.aws.inputs.IntegrationCustomNamespaceSyncRuleArgs;
import com.pulumi.signalfx.aws.inputs.IntegrationNamespaceSyncRuleArgs;
import com.pulumi.signalfx.aws.inputs.IntegrationMetricStatsToSyncArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var awsMyteamExternal = new ExternalIntegration("awsMyteamExternal");
var awsSfxRole = new Role("awsSfxRole");
var awsMyteam = new Integration("awsMyteam", IntegrationArgs.builder()
.enabled(true)
.integrationId(awsMyteamExternal.id())
.externalId(awsMyteamExternal.externalId())
.roleArn(awsSfxRole.arn())
.regions("us-east-1")
.pollRate(300)
.importCloudWatch(true)
.enableAwsUsage(true)
.customNamespaceSyncRules(IntegrationCustomNamespaceSyncRuleArgs.builder()
.defaultAction("Exclude")
.filterAction("Include")
.filterSource("filter('code', '200')")
.namespace("my-custom-namespace")
.build())
.namespaceSyncRules(IntegrationNamespaceSyncRuleArgs.builder()
.defaultAction("Exclude")
.filterAction("Include")
.filterSource("filter('code', '200')")
.namespace("AWS/EC2")
.build())
.metricStatsToSyncs(IntegrationMetricStatsToSyncArgs.builder()
.namespace("AWS/EC2")
.metric("NetworkPacketsIn")
.stats("upper")
.build())
.build());
}
}
resources:
# This resource returns an account id in `external_id`…
awsMyteamExternal:
type: signalfx:aws:ExternalIntegration
# Make yourself an AWS IAM role here, use `signalfx_aws_external_integration.aws_myteam_external.external_id`
awsSfxRole:
type: aws:iam:Role
awsMyteam:
type: signalfx:aws:Integration
properties:
enabled: true
integrationId: ${awsMyteamExternal.id}
externalId: ${awsMyteamExternal.externalId}
roleArn: ${awsSfxRole.arn}
regions:
- us-east-1
pollRate: 300
importCloudWatch: true
enableAwsUsage: true
customNamespaceSyncRules:
- defaultAction: Exclude
filterAction: Include
filterSource: filter('code', '200')
namespace: my-custom-namespace
namespaceSyncRules:
- defaultAction: Exclude
filterAction: Include
filterSource: filter('code', '200')
namespace: AWS/EC2
metricStatsToSyncs:
- namespace: AWS/EC2
metric: NetworkPacketsIn
stats:
- upper
Arguments
enable_aws_usage
- (Optional) Flag that controls how Splunk Observability Cloud imports usage metrics from AWS to use with AWS Cost Optimizer. Iftrue
, Splunk Observability Cloud imports the metrics.enable_check_large_volume
- (Optional) Controls how Splunk Observability Cloud checks for large amounts of data for this AWS integration. Iftrue
, Splunk Observability Cloud monitors the amount of data coming in from the integration.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.enabled
- (Required) Whether the integration is enabled.external_id
- (Required) Theexternal_id
property from one of asignalfx.aws.ExternalIntegration
orsignalfx.aws.TokenIntegration
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.custom_namespace_sync_rule
- (Optional) Each element controls the data collected by Splunk Observability Cloud for the specified namespace. Conflicts with thecustom_cloudwatch_namespaces
property.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 thefilter_action
andfilter_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"
.filter_action
- (Optional) Controls how Splunk Observability Cloud processes data from a custom AWS namespace. The available actions are one of"Include"
or"Exclude"
.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 SignalFlowfilter()
function; it can be any valid SignalFlow filter expression.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.
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.integration_id
- (Required) The id of one of asignalfx.aws.ExternalIntegration
orsignalfx.aws.TokenIntegration
.key
- (Optional) If you specifyauth_method = \"SecurityToken\"
in your request to create an AWS integration object, use this property to specify the key (this is typically equivalent to theAWS_SECRET_ACCESS_KEY
environment variable).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.metric
- (Required) AWS metric that you want to pick statistics fornamespace
- (Required) An AWS namespace having AWS metric that you want to pick statistics forstats
- (Required) AWS statistics you want to collect
name
- (Required) Name of the integration.named_token
- (Optional) Name of the org token to be used for data ingestion. If not specified then default access token is used.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 theservices
property. If you don’t specify either property, Splunk Observability Cloud syncs all data in all AWS namespaces.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 thefilter_action
andfilter_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"
.filter_action
- (Optional) Controls how Splunk Observability Cloud processes data from a custom AWS namespace. The available actions are one of"Include"
or"Exclude"
.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 SignalFlowfilter()
function; it can be any valid SignalFlow filter expression.namespace
- (Required) An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability Cloud. Seeservices
field description below for additional information.
poll_rate
- (Optional) AWS poll rate (in seconds). Value between60
and600
. Default:300
.regions
- (Required) List of AWS regions that Splunk Observability Cloud should monitor. It cannot be empty.role_arn
- (Optional) Role ARN that you add to an existing AWS integration object. Note: Ensure you use thearn
property of your role, not the id!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 withnamespace_sync_rule
. See Amazon Web Services for a list of valid values.sync_custom_namespaces_only
- (Optional) Indicates that Splunk Observability Cloud should sync metrics and metadata from custom AWS namespaces only (see thecustom_namespace_sync_rule
above). Defaults tofalse
.token
- (Optional) If you specifyauth_method = \"SecurityToken\"
in your request to create an AWS integration object, use this property to specify the token (this is typically equivalent to theAWS_ACCESS_KEY_ID
environment variable).use_metric_streams_sync
- (Optional) Enable the use of Amazon Cloudwatch Metric Streams for ingesting metrics.
Note that this requires the inclusion of"cloudwatch:ListMetricStreams"
,"cloudwatch:GetMetricStream"
,"cloudwatch:PutMetricStream"
,"cloudwatch:DeleteMetricStream"
,"cloudwatch:StartMetricStreams"
,"cloudwatch:StopMetricStreams"
and"iam:PassRole"
permissions.
Note you need to deploy additional resources on your AWS account to enable CloudWatch metrics streaming. Select one of the CloudFormation templates to deploy all the required resources.
Create Integration Resource
new Integration(name: string, args: IntegrationArgs, opts?: CustomResourceOptions);
@overload
def Integration(resource_name: str,
opts: Optional[ResourceOptions] = None,
custom_cloudwatch_namespaces: Optional[Sequence[str]] = None,
custom_namespace_sync_rules: Optional[Sequence[IntegrationCustomNamespaceSyncRuleArgs]] = None,
enable_aws_usage: Optional[bool] = None,
enable_check_large_volume: Optional[bool] = None,
enable_logs_sync: Optional[bool] = None,
enabled: Optional[bool] = None,
external_id: Optional[str] = None,
import_cloud_watch: Optional[bool] = None,
integration_id: Optional[str] = None,
key: Optional[str] = None,
metric_stats_to_syncs: Optional[Sequence[IntegrationMetricStatsToSyncArgs]] = None,
named_token: Optional[str] = None,
namespace_sync_rules: Optional[Sequence[IntegrationNamespaceSyncRuleArgs]] = None,
poll_rate: Optional[int] = None,
regions: Optional[Sequence[str]] = None,
role_arn: Optional[str] = None,
services: Optional[Sequence[str]] = None,
sync_custom_namespaces_only: Optional[bool] = None,
token: Optional[str] = None,
use_metric_streams_sync: Optional[bool] = None)
@overload
def Integration(resource_name: str,
args: IntegrationArgs,
opts: Optional[ResourceOptions] = None)
func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)
public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)
type: signalfx:aws:Integration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Integration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Integration resource accepts the following input properties:
- Enabled bool
- Whether the integration is enabled or not
- Integration
Id string - The ID of this integration
- Regions List<string>
- List of AWS regions that Splunk Observability should monitor.
- Custom
Cloudwatch List<string>Namespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- Custom
Namespace List<Pulumi.Sync Rules Signal Fx. Aws. Inputs. Integration Custom Namespace Sync Rule> - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- Enable
Aws boolUsage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - Enable
Check boolLarge Volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- Enable
Logs boolSync - Enables AWS logs synchronization.
- External
Id string - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - Import
Cloud boolWatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- Key string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - Metric
Stats List<Pulumi.To Syncs Signal Fx. Aws. Inputs. Integration Metric Stats To Sync> - 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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- Named
Token string - A named token to use for ingest
- Namespace
Sync List<Pulumi.Rules Signal Fx. Aws. Inputs. Integration Namespace Sync Rule> - Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- Poll
Rate int - AWS poll rate (in seconds). Between
60
and600
. - Role
Arn string - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - Services List<string>
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- Sync
Custom boolNamespaces Only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - Token string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - Use
Metric boolStreams Sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
- Enabled bool
- Whether the integration is enabled or not
- Integration
Id string - The ID of this integration
- Regions []string
- List of AWS regions that Splunk Observability should monitor.
- Custom
Cloudwatch []stringNamespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- Custom
Namespace []IntegrationSync Rules Custom Namespace Sync Rule Args - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- Enable
Aws boolUsage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - Enable
Check boolLarge Volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- Enable
Logs boolSync - Enables AWS logs synchronization.
- External
Id string - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - Import
Cloud boolWatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- Key string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - Metric
Stats []IntegrationTo Syncs Metric Stats To Sync Args - 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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- Named
Token string - A named token to use for ingest
- Namespace
Sync []IntegrationRules Namespace Sync Rule Args - Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- Poll
Rate int - AWS poll rate (in seconds). Between
60
and600
. - Role
Arn string - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - Services []string
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- Sync
Custom boolNamespaces Only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - Token string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - Use
Metric boolStreams Sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
- enabled Boolean
- Whether the integration is enabled or not
- integration
Id String - The ID of this integration
- regions List<String>
- List of AWS regions that Splunk Observability should monitor.
- custom
Cloudwatch List<String>Namespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- custom
Namespace List<IntegrationSync Rules Custom Namespace Sync Rule> - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- enable
Aws BooleanUsage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - enable
Check BooleanLarge Volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- enable
Logs BooleanSync - Enables AWS logs synchronization.
- external
Id String - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - import
Cloud BooleanWatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- key String
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - metric
Stats List<IntegrationTo Syncs Metric Stats To Sync> - 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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- named
Token String - A named token to use for ingest
- namespace
Sync List<IntegrationRules Namespace Sync Rule> - Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- poll
Rate Integer - AWS poll rate (in seconds). Between
60
and600
. - role
Arn String - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - services List<String>
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- sync
Custom BooleanNamespaces Only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - token String
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - use
Metric BooleanStreams Sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
- enabled boolean
- Whether the integration is enabled or not
- integration
Id string - The ID of this integration
- regions string[]
- List of AWS regions that Splunk Observability should monitor.
- custom
Cloudwatch string[]Namespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- custom
Namespace IntegrationSync Rules Custom Namespace Sync Rule[] - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- enable
Aws booleanUsage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - enable
Check booleanLarge Volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- enable
Logs booleanSync - Enables AWS logs synchronization.
- external
Id string - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - import
Cloud booleanWatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- key string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - metric
Stats IntegrationTo Syncs Metric Stats To Sync[] - 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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- named
Token string - A named token to use for ingest
- namespace
Sync IntegrationRules Namespace Sync Rule[] - Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- poll
Rate number - AWS poll rate (in seconds). Between
60
and600
. - role
Arn string - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - services string[]
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- sync
Custom booleanNamespaces Only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - token string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - use
Metric booleanStreams Sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
- enabled bool
- Whether the integration is enabled or not
- integration_
id str - The ID of this integration
- regions Sequence[str]
- List of AWS regions that Splunk Observability should monitor.
- custom_
cloudwatch_ Sequence[str]namespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- custom_
namespace_ Sequence[Integrationsync_ rules Custom Namespace Sync Rule Args] - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- enable_
aws_ boolusage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - enable_
check_ boollarge_ volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- enable_
logs_ boolsync - Enables AWS logs synchronization.
- external_
id str - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - import_
cloud_ boolwatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- key str
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - metric_
stats_ Sequence[Integrationto_ syncs Metric Stats To Sync Args] - 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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- named_
token str - A named token to use for ingest
- namespace_
sync_ Sequence[Integrationrules Namespace Sync Rule Args] - Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- poll_
rate int - AWS poll rate (in seconds). Between
60
and600
. - role_
arn str - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - services Sequence[str]
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- sync_
custom_ boolnamespaces_ only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - token str
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - use_
metric_ boolstreams_ sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
- enabled Boolean
- Whether the integration is enabled or not
- integration
Id String - The ID of this integration
- regions List<String>
- List of AWS regions that Splunk Observability should monitor.
- custom
Cloudwatch List<String>Namespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- custom
Namespace List<Property Map>Sync Rules - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- enable
Aws BooleanUsage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - enable
Check BooleanLarge Volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- enable
Logs BooleanSync - Enables AWS logs synchronization.
- external
Id String - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - import
Cloud BooleanWatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- key String
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - metric
Stats List<Property Map>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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- named
Token String - A named token to use for ingest
- namespace
Sync List<Property Map>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 collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- poll
Rate Number - AWS poll rate (in seconds). Between
60
and600
. - role
Arn String - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - services List<String>
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- sync
Custom BooleanNamespaces Only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - token String
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - use
Metric BooleanStreams Sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
Outputs
All input properties are implicitly available as output properties. Additionally, the Integration resource produces the following output properties:
- Auth
Method string - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- Auth
Method string - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- auth
Method String - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - id String
- The provider-assigned unique ID for this managed resource.
- name String
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- auth
Method string - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - id string
- The provider-assigned unique ID for this managed resource.
- name string
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- auth_
method str - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - id str
- The provider-assigned unique ID for this managed resource.
- name str
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- auth
Method String - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - id String
- The provider-assigned unique ID for this managed resource.
- name String
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
Look up Existing Integration Resource
Get an existing Integration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: IntegrationState, opts?: CustomResourceOptions): Integration
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auth_method: Optional[str] = None,
custom_cloudwatch_namespaces: Optional[Sequence[str]] = None,
custom_namespace_sync_rules: Optional[Sequence[IntegrationCustomNamespaceSyncRuleArgs]] = None,
enable_aws_usage: Optional[bool] = None,
enable_check_large_volume: Optional[bool] = None,
enable_logs_sync: Optional[bool] = None,
enabled: Optional[bool] = None,
external_id: Optional[str] = None,
import_cloud_watch: Optional[bool] = None,
integration_id: Optional[str] = None,
key: Optional[str] = None,
metric_stats_to_syncs: Optional[Sequence[IntegrationMetricStatsToSyncArgs]] = None,
name: Optional[str] = None,
named_token: Optional[str] = None,
namespace_sync_rules: Optional[Sequence[IntegrationNamespaceSyncRuleArgs]] = None,
poll_rate: Optional[int] = None,
regions: Optional[Sequence[str]] = None,
role_arn: Optional[str] = None,
services: Optional[Sequence[str]] = None,
sync_custom_namespaces_only: Optional[bool] = None,
token: Optional[str] = None,
use_metric_streams_sync: Optional[bool] = None) -> Integration
func GetIntegration(ctx *Context, name string, id IDInput, state *IntegrationState, opts ...ResourceOption) (*Integration, error)
public static Integration Get(string name, Input<string> id, IntegrationState? state, CustomResourceOptions? opts = null)
public static Integration get(String name, Output<String> id, IntegrationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Auth
Method string - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - Custom
Cloudwatch List<string>Namespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- Custom
Namespace List<Pulumi.Sync Rules Signal Fx. Aws. Inputs. Integration Custom Namespace Sync Rule> - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- Enable
Aws boolUsage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - Enable
Check boolLarge Volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- Enable
Logs boolSync - Enables AWS logs synchronization.
- Enabled bool
- Whether the integration is enabled or not
- External
Id string - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - Import
Cloud boolWatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- Integration
Id string - The ID of this integration
- Key string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - Metric
Stats List<Pulumi.To Syncs Signal Fx. Aws. Inputs. Integration Metric Stats To Sync> - 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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- Name string
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- Named
Token string - A named token to use for ingest
- Namespace
Sync List<Pulumi.Rules Signal Fx. Aws. Inputs. Integration Namespace Sync Rule> - Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- Poll
Rate int - AWS poll rate (in seconds). Between
60
and600
. - Regions List<string>
- List of AWS regions that Splunk Observability should monitor.
- Role
Arn string - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - Services List<string>
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- Sync
Custom boolNamespaces Only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - Token string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - Use
Metric boolStreams Sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
- Auth
Method string - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - Custom
Cloudwatch []stringNamespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- Custom
Namespace []IntegrationSync Rules Custom Namespace Sync Rule Args - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- Enable
Aws boolUsage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - Enable
Check boolLarge Volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- Enable
Logs boolSync - Enables AWS logs synchronization.
- Enabled bool
- Whether the integration is enabled or not
- External
Id string - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - Import
Cloud boolWatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- Integration
Id string - The ID of this integration
- Key string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - Metric
Stats []IntegrationTo Syncs Metric Stats To Sync Args - 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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- Name string
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- Named
Token string - A named token to use for ingest
- Namespace
Sync []IntegrationRules Namespace Sync Rule Args - Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- Poll
Rate int - AWS poll rate (in seconds). Between
60
and600
. - Regions []string
- List of AWS regions that Splunk Observability should monitor.
- Role
Arn string - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - Services []string
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- Sync
Custom boolNamespaces Only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - Token string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - Use
Metric boolStreams Sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
- auth
Method String - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - custom
Cloudwatch List<String>Namespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- custom
Namespace List<IntegrationSync Rules Custom Namespace Sync Rule> - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- enable
Aws BooleanUsage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - enable
Check BooleanLarge Volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- enable
Logs BooleanSync - Enables AWS logs synchronization.
- enabled Boolean
- Whether the integration is enabled or not
- external
Id String - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - import
Cloud BooleanWatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- integration
Id String - The ID of this integration
- key String
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - metric
Stats List<IntegrationTo Syncs Metric Stats To Sync> - 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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- name String
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- named
Token String - A named token to use for ingest
- namespace
Sync List<IntegrationRules Namespace Sync Rule> - Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- poll
Rate Integer - AWS poll rate (in seconds). Between
60
and600
. - regions List<String>
- List of AWS regions that Splunk Observability should monitor.
- role
Arn String - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - services List<String>
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- sync
Custom BooleanNamespaces Only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - token String
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - use
Metric BooleanStreams Sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
- auth
Method string - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - custom
Cloudwatch string[]Namespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- custom
Namespace IntegrationSync Rules Custom Namespace Sync Rule[] - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- enable
Aws booleanUsage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - enable
Check booleanLarge Volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- enable
Logs booleanSync - Enables AWS logs synchronization.
- enabled boolean
- Whether the integration is enabled or not
- external
Id string - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - import
Cloud booleanWatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- integration
Id string - The ID of this integration
- key string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - metric
Stats IntegrationTo Syncs Metric Stats To Sync[] - 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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- name string
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- named
Token string - A named token to use for ingest
- namespace
Sync IntegrationRules Namespace Sync Rule[] - Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- poll
Rate number - AWS poll rate (in seconds). Between
60
and600
. - regions string[]
- List of AWS regions that Splunk Observability should monitor.
- role
Arn string - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - services string[]
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- sync
Custom booleanNamespaces Only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - token string
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - use
Metric booleanStreams Sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
- auth_
method str - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - custom_
cloudwatch_ Sequence[str]namespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- custom_
namespace_ Sequence[Integrationsync_ rules Custom Namespace Sync Rule Args] - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- enable_
aws_ boolusage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - enable_
check_ boollarge_ volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- enable_
logs_ boolsync - Enables AWS logs synchronization.
- enabled bool
- Whether the integration is enabled or not
- external_
id str - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - import_
cloud_ boolwatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- integration_
id str - The ID of this integration
- key str
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - metric_
stats_ Sequence[Integrationto_ syncs Metric Stats To Sync Args] - 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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- name str
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- named_
token str - A named token to use for ingest
- namespace_
sync_ Sequence[Integrationrules Namespace Sync Rule Args] - Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- poll_
rate int - AWS poll rate (in seconds). Between
60
and600
. - regions Sequence[str]
- List of AWS regions that Splunk Observability should monitor.
- role_
arn str - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - services Sequence[str]
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- sync_
custom_ boolnamespaces_ only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - token str
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - use_
metric_ boolstreams_ sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
- auth
Method String - The mechanism used to authenticate with AWS. Use one of
signalfx_aws_external_integration
orsignalfx_aws_token_integration
to define this - custom
Cloudwatch List<String>Namespaces - List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.
- custom
Namespace List<Property Map>Sync Rules - Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the "custom_cloudwatch_namespaces" property.
- enable
Aws BooleanUsage - Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If
true
, Splunk Observability imports the metrics. - enable
Check BooleanLarge Volume - Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.
- enable
Logs BooleanSync - Enables AWS logs synchronization.
- enabled Boolean
- Whether the integration is enabled or not
- external
Id String - Used with
signalfx_aws_external_integration
. Use this property to specify the external id. - import
Cloud BooleanWatch - Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
- integration
Id String - The ID of this integration
- key String
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - metric
Stats List<Property Map>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 collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.
- name String
- Name of the integration. Please specify the name in
signalfx_aws_external_integration
orsignalfx_aws_integration_token
- named
Token String - A named token to use for ingest
- namespace
Sync List<Property Map>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 collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model "services" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.
- poll
Rate Number - AWS poll rate (in seconds). Between
60
and600
. - regions List<String>
- List of AWS regions that Splunk Observability should monitor.
- role
Arn String - Used with
signalfx_aws_external_integration
. Use this property to specify the AIM role ARN. - services List<String>
- List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.
- sync
Custom BooleanNamespaces Only - Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the
custom_namespace_sync_rule
field for details). Defaults tofalse
. - token String
- Used with
signalfx_aws_token_integration
. Use this property to specify the token. - use
Metric BooleanStreams Sync - Enables the use of Cloudwatch Metric Streams for metrics synchronization.
Supporting Types
IntegrationCustomNamespaceSyncRule, IntegrationCustomNamespaceSyncRuleArgs
- Namespace string
- An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- Default
Action string - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - Filter
Action string - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- Filter
Source string - Expression that selects the data that Splunk Observability 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.
- Namespace string
- An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- Default
Action string - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - Filter
Action string - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- Filter
Source string - Expression that selects the data that Splunk Observability 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.
- namespace String
- An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- default
Action String - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - filter
Action String - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- filter
Source String - Expression that selects the data that Splunk Observability 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.
- namespace string
- An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- default
Action string - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - filter
Action string - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- filter
Source string - Expression that selects the data that Splunk Observability 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.
- namespace str
- An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- default_
action str - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - filter_
action str - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- filter_
source str - Expression that selects the data that Splunk Observability 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.
- namespace String
- An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- default
Action String - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - filter
Action String - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- filter
Source String - Expression that selects the data that Splunk Observability 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.
IntegrationMetricStatsToSync, IntegrationMetricStatsToSyncArgs
IntegrationNamespaceSyncRule, IntegrationNamespaceSyncRuleArgs
- Namespace string
- An AWS namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- Default
Action string - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - Filter
Action string - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- Filter
Source string - Expression that selects the data that Splunk Observability 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.
- Namespace string
- An AWS namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- Default
Action string - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - Filter
Action string - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- Filter
Source string - Expression that selects the data that Splunk Observability 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.
- namespace String
- An AWS namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- default
Action String - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - filter
Action String - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- filter
Source String - Expression that selects the data that Splunk Observability 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.
- namespace string
- An AWS namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- default
Action string - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - filter
Action string - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- filter
Source string - Expression that selects the data that Splunk Observability 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.
- namespace str
- An AWS namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- default_
action str - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - filter_
action str - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- filter_
source str - Expression that selects the data that Splunk Observability 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.
- namespace String
- An AWS namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
- default
Action String - Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the
filter_action
andfilter_source
properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude". - filter
Action String - Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
- filter
Source String - Expression that selects the data that Splunk Observability 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.
Package Details
- Repository
- SignalFx pulumi/pulumi-signalfx
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
signalfx
Terraform Provider.