1. Packages
  2. SignalFx
  3. API Docs
  4. aws
  5. Integration
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi

signalfx.aws.Integration

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi

    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. If true, 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. If true, 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) The external_id property from one of a signalfx.aws.ExternalIntegration or signalfx.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 the custom_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 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".
      • 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 SignalFlow filter() 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 a signalfx.aws.ExternalIntegration or signalfx.aws.TokenIntegration.
    • 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).
    • 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 for
      • namespace - (Required) An AWS namespace having AWS metric that you want to pick statistics for
      • stats - (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 the services 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 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".
      • 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 SignalFlow filter() 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 services field description below for additional information.
    • poll_rate - (Optional) AWS poll rate (in seconds). Value between 60 and 600. 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 the arn 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 with namespace_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 the custom_namespace_sync_rule above). Defaults to false.
    • 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).
    • 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
    IntegrationId string
    The ID of this integration
    Regions List<string>
    List of AWS regions that Splunk Observability should monitor.
    CustomCloudwatchNamespaces List<string>
    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.
    CustomNamespaceSyncRules List<Pulumi.SignalFx.Aws.Inputs.IntegrationCustomNamespaceSyncRule>
    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.
    EnableAwsUsage bool
    Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If true, Splunk Observability imports the metrics.
    EnableCheckLargeVolume bool
    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.
    EnableLogsSync bool
    Enables AWS logs synchronization.
    ExternalId string
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    ImportCloudWatch bool
    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.
    MetricStatsToSyncs List<Pulumi.SignalFx.Aws.Inputs.IntegrationMetricStatsToSync>
    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.
    NamedToken string
    A named token to use for ingest
    NamespaceSyncRules List<Pulumi.SignalFx.Aws.Inputs.IntegrationNamespaceSyncRule>
    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.
    PollRate int
    AWS poll rate (in seconds). Between 60 and 600.
    RoleArn 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.
    SyncCustomNamespacesOnly bool
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    Token string
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    UseMetricStreamsSync bool
    Enables the use of Cloudwatch Metric Streams for metrics synchronization.
    Enabled bool
    Whether the integration is enabled or not
    IntegrationId string
    The ID of this integration
    Regions []string
    List of AWS regions that Splunk Observability should monitor.
    CustomCloudwatchNamespaces []string
    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.
    CustomNamespaceSyncRules []IntegrationCustomNamespaceSyncRuleArgs
    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.
    EnableAwsUsage bool
    Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If true, Splunk Observability imports the metrics.
    EnableCheckLargeVolume bool
    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.
    EnableLogsSync bool
    Enables AWS logs synchronization.
    ExternalId string
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    ImportCloudWatch bool
    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.
    MetricStatsToSyncs []IntegrationMetricStatsToSyncArgs
    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.
    NamedToken string
    A named token to use for ingest
    NamespaceSyncRules []IntegrationNamespaceSyncRuleArgs
    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.
    PollRate int
    AWS poll rate (in seconds). Between 60 and 600.
    RoleArn 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.
    SyncCustomNamespacesOnly bool
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    Token string
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    UseMetricStreamsSync bool
    Enables the use of Cloudwatch Metric Streams for metrics synchronization.
    enabled Boolean
    Whether the integration is enabled or not
    integrationId String
    The ID of this integration
    regions List<String>
    List of AWS regions that Splunk Observability should monitor.
    customCloudwatchNamespaces List<String>
    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.
    customNamespaceSyncRules List<IntegrationCustomNamespaceSyncRule>
    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.
    enableAwsUsage Boolean
    Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If true, Splunk Observability imports the metrics.
    enableCheckLargeVolume Boolean
    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.
    enableLogsSync Boolean
    Enables AWS logs synchronization.
    externalId String
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    importCloudWatch Boolean
    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.
    metricStatsToSyncs List<IntegrationMetricStatsToSync>
    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.
    namedToken String
    A named token to use for ingest
    namespaceSyncRules List<IntegrationNamespaceSyncRule>
    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.
    pollRate Integer
    AWS poll rate (in seconds). Between 60 and 600.
    roleArn 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.
    syncCustomNamespacesOnly Boolean
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    token String
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    useMetricStreamsSync Boolean
    Enables the use of Cloudwatch Metric Streams for metrics synchronization.
    enabled boolean
    Whether the integration is enabled or not
    integrationId string
    The ID of this integration
    regions string[]
    List of AWS regions that Splunk Observability should monitor.
    customCloudwatchNamespaces string[]
    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.
    customNamespaceSyncRules IntegrationCustomNamespaceSyncRule[]
    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.
    enableAwsUsage boolean
    Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If true, Splunk Observability imports the metrics.
    enableCheckLargeVolume boolean
    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.
    enableLogsSync boolean
    Enables AWS logs synchronization.
    externalId string
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    importCloudWatch boolean
    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.
    metricStatsToSyncs IntegrationMetricStatsToSync[]
    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.
    namedToken string
    A named token to use for ingest
    namespaceSyncRules IntegrationNamespaceSyncRule[]
    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.
    pollRate number
    AWS poll rate (in seconds). Between 60 and 600.
    roleArn 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.
    syncCustomNamespacesOnly boolean
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    token string
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    useMetricStreamsSync boolean
    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_namespaces Sequence[str]
    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_sync_rules Sequence[IntegrationCustomNamespaceSyncRuleArgs]
    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_usage bool
    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_large_volume bool
    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_sync bool
    Enables AWS logs synchronization.
    external_id str
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    import_cloud_watch bool
    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_to_syncs Sequence[IntegrationMetricStatsToSyncArgs]
    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_rules Sequence[IntegrationNamespaceSyncRuleArgs]
    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 and 600.
    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_namespaces_only bool
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    token str
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    use_metric_streams_sync bool
    Enables the use of Cloudwatch Metric Streams for metrics synchronization.
    enabled Boolean
    Whether the integration is enabled or not
    integrationId String
    The ID of this integration
    regions List<String>
    List of AWS regions that Splunk Observability should monitor.
    customCloudwatchNamespaces List<String>
    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.
    customNamespaceSyncRules List<Property Map>
    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.
    enableAwsUsage Boolean
    Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If true, Splunk Observability imports the metrics.
    enableCheckLargeVolume Boolean
    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.
    enableLogsSync Boolean
    Enables AWS logs synchronization.
    externalId String
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    importCloudWatch Boolean
    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.
    metricStatsToSyncs List<Property Map>
    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.
    namedToken String
    A named token to use for ingest
    namespaceSyncRules List<Property Map>
    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.
    pollRate Number
    AWS poll rate (in seconds). Between 60 and 600.
    roleArn 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.
    syncCustomNamespacesOnly Boolean
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    token String
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    useMetricStreamsSync Boolean
    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:

    AuthMethod string
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_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 or signalfx_aws_integration_token
    AuthMethod string
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_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 or signalfx_aws_integration_token
    authMethod String
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_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 or signalfx_aws_integration_token
    authMethod string
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_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 or signalfx_aws_integration_token
    auth_method str
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_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 or signalfx_aws_integration_token
    authMethod String
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_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 or signalfx_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.
    The following state arguments are supported:
    AuthMethod string
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_aws_token_integration to define this
    CustomCloudwatchNamespaces List<string>
    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.
    CustomNamespaceSyncRules List<Pulumi.SignalFx.Aws.Inputs.IntegrationCustomNamespaceSyncRule>
    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.
    EnableAwsUsage bool
    Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If true, Splunk Observability imports the metrics.
    EnableCheckLargeVolume bool
    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.
    EnableLogsSync bool
    Enables AWS logs synchronization.
    Enabled bool
    Whether the integration is enabled or not
    ExternalId string
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    ImportCloudWatch bool
    Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
    IntegrationId string
    The ID of this integration
    Key string
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    MetricStatsToSyncs List<Pulumi.SignalFx.Aws.Inputs.IntegrationMetricStatsToSync>
    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 or signalfx_aws_integration_token
    NamedToken string
    A named token to use for ingest
    NamespaceSyncRules List<Pulumi.SignalFx.Aws.Inputs.IntegrationNamespaceSyncRule>
    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.
    PollRate int
    AWS poll rate (in seconds). Between 60 and 600.
    Regions List<string>
    List of AWS regions that Splunk Observability should monitor.
    RoleArn 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.
    SyncCustomNamespacesOnly bool
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    Token string
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    UseMetricStreamsSync bool
    Enables the use of Cloudwatch Metric Streams for metrics synchronization.
    AuthMethod string
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_aws_token_integration to define this
    CustomCloudwatchNamespaces []string
    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.
    CustomNamespaceSyncRules []IntegrationCustomNamespaceSyncRuleArgs
    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.
    EnableAwsUsage bool
    Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If true, Splunk Observability imports the metrics.
    EnableCheckLargeVolume bool
    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.
    EnableLogsSync bool
    Enables AWS logs synchronization.
    Enabled bool
    Whether the integration is enabled or not
    ExternalId string
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    ImportCloudWatch bool
    Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
    IntegrationId string
    The ID of this integration
    Key string
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    MetricStatsToSyncs []IntegrationMetricStatsToSyncArgs
    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 or signalfx_aws_integration_token
    NamedToken string
    A named token to use for ingest
    NamespaceSyncRules []IntegrationNamespaceSyncRuleArgs
    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.
    PollRate int
    AWS poll rate (in seconds). Between 60 and 600.
    Regions []string
    List of AWS regions that Splunk Observability should monitor.
    RoleArn 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.
    SyncCustomNamespacesOnly bool
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    Token string
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    UseMetricStreamsSync bool
    Enables the use of Cloudwatch Metric Streams for metrics synchronization.
    authMethod String
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_aws_token_integration to define this
    customCloudwatchNamespaces List<String>
    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.
    customNamespaceSyncRules List<IntegrationCustomNamespaceSyncRule>
    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.
    enableAwsUsage Boolean
    Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If true, Splunk Observability imports the metrics.
    enableCheckLargeVolume Boolean
    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.
    enableLogsSync Boolean
    Enables AWS logs synchronization.
    enabled Boolean
    Whether the integration is enabled or not
    externalId String
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    importCloudWatch Boolean
    Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
    integrationId String
    The ID of this integration
    key String
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    metricStatsToSyncs List<IntegrationMetricStatsToSync>
    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 or signalfx_aws_integration_token
    namedToken String
    A named token to use for ingest
    namespaceSyncRules List<IntegrationNamespaceSyncRule>
    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.
    pollRate Integer
    AWS poll rate (in seconds). Between 60 and 600.
    regions List<String>
    List of AWS regions that Splunk Observability should monitor.
    roleArn 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.
    syncCustomNamespacesOnly Boolean
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    token String
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    useMetricStreamsSync Boolean
    Enables the use of Cloudwatch Metric Streams for metrics synchronization.
    authMethod string
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_aws_token_integration to define this
    customCloudwatchNamespaces string[]
    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.
    customNamespaceSyncRules IntegrationCustomNamespaceSyncRule[]
    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.
    enableAwsUsage boolean
    Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If true, Splunk Observability imports the metrics.
    enableCheckLargeVolume boolean
    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.
    enableLogsSync boolean
    Enables AWS logs synchronization.
    enabled boolean
    Whether the integration is enabled or not
    externalId string
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    importCloudWatch boolean
    Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
    integrationId string
    The ID of this integration
    key string
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    metricStatsToSyncs IntegrationMetricStatsToSync[]
    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 or signalfx_aws_integration_token
    namedToken string
    A named token to use for ingest
    namespaceSyncRules IntegrationNamespaceSyncRule[]
    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.
    pollRate number
    AWS poll rate (in seconds). Between 60 and 600.
    regions string[]
    List of AWS regions that Splunk Observability should monitor.
    roleArn 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.
    syncCustomNamespacesOnly boolean
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    token string
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    useMetricStreamsSync boolean
    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 or signalfx_aws_token_integration to define this
    custom_cloudwatch_namespaces Sequence[str]
    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_sync_rules Sequence[IntegrationCustomNamespaceSyncRuleArgs]
    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_usage bool
    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_large_volume bool
    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_sync bool
    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_watch bool
    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_to_syncs Sequence[IntegrationMetricStatsToSyncArgs]
    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 or signalfx_aws_integration_token
    named_token str
    A named token to use for ingest
    namespace_sync_rules Sequence[IntegrationNamespaceSyncRuleArgs]
    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 and 600.
    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_namespaces_only bool
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    token str
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    use_metric_streams_sync bool
    Enables the use of Cloudwatch Metric Streams for metrics synchronization.
    authMethod String
    The mechanism used to authenticate with AWS. Use one of signalfx_aws_external_integration or signalfx_aws_token_integration to define this
    customCloudwatchNamespaces List<String>
    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.
    customNamespaceSyncRules List<Property Map>
    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.
    enableAwsUsage Boolean
    Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If true, Splunk Observability imports the metrics.
    enableCheckLargeVolume Boolean
    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.
    enableLogsSync Boolean
    Enables AWS logs synchronization.
    enabled Boolean
    Whether the integration is enabled or not
    externalId String
    Used with signalfx_aws_external_integration. Use this property to specify the external id.
    importCloudWatch Boolean
    Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.
    integrationId String
    The ID of this integration
    key String
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    metricStatsToSyncs List<Property Map>
    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 or signalfx_aws_integration_token
    namedToken String
    A named token to use for ingest
    namespaceSyncRules List<Property Map>
    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.
    pollRate Number
    AWS poll rate (in seconds). Between 60 and 600.
    regions List<String>
    List of AWS regions that Splunk Observability should monitor.
    roleArn 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.
    syncCustomNamespacesOnly Boolean
    Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the custom_namespace_sync_rule field for details). Defaults to false.
    token String
    Used with signalfx_aws_token_integration. Use this property to specify the token.
    useMetricStreamsSync Boolean
    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.
    DefaultAction 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 and filter_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".
    FilterAction string
    Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
    FilterSource 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.
    DefaultAction 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 and filter_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".
    FilterAction string
    Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
    FilterSource 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.
    defaultAction 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 and filter_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".
    filterAction String
    Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
    filterSource 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.
    defaultAction 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 and filter_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".
    filterAction string
    Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
    filterSource 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 and filter_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.
    defaultAction 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 and filter_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".
    filterAction String
    Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
    filterSource 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

    Metric string
    AWS metric that you want to pick statistics for
    Namespace string
    An AWS namespace having AWS metric that you want to pick statistics for
    Stats List<string>
    AWS statistics you want to collect
    Metric string
    AWS metric that you want to pick statistics for
    Namespace string
    An AWS namespace having AWS metric that you want to pick statistics for
    Stats []string
    AWS statistics you want to collect
    metric String
    AWS metric that you want to pick statistics for
    namespace String
    An AWS namespace having AWS metric that you want to pick statistics for
    stats List<String>
    AWS statistics you want to collect
    metric string
    AWS metric that you want to pick statistics for
    namespace string
    An AWS namespace having AWS metric that you want to pick statistics for
    stats string[]
    AWS statistics you want to collect
    metric str
    AWS metric that you want to pick statistics for
    namespace str
    An AWS namespace having AWS metric that you want to pick statistics for
    stats Sequence[str]
    AWS statistics you want to collect
    metric String
    AWS metric that you want to pick statistics for
    namespace String
    An AWS namespace having AWS metric that you want to pick statistics for
    stats List<String>
    AWS statistics you want to collect

    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.
    DefaultAction 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 and filter_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".
    FilterAction string
    Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
    FilterSource 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.
    DefaultAction 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 and filter_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".
    FilterAction string
    Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
    FilterSource 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.
    defaultAction 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 and filter_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".
    filterAction String
    Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
    filterSource 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.
    defaultAction 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 and filter_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".
    filterAction string
    Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
    filterSource 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 and filter_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.
    defaultAction 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 and filter_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".
    filterAction String
    Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
    filterSource 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.
    signalfx logo
    SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi