1. Packages
  2. Coralogix Provider
  3. API Docs
  4. Integration
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

coralogix.Integration

Explore with Pulumi AI

coralogix logo
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as coralogix from "@pulumi/coralogix";
    
    const example = new coralogix.Integration("example", {
        integrationKey: "aws-metrics-collector",
        parameters: [{
            ApplicationName: "cxsdk",
            AwsRegion: "eu-north-1",
            AwsRoleArn: "arn:aws:iam::123456789012:role/example-role",
            EnrichWithTags: true,
            IntegrationName: "sdk-integration-setup",
            MetricNamespaces: ["AWS/S3"],
            SubsystemName: "aws-metrics-collector",
            WithAggregations: false,
        }],
        version: "0.1.0",
    });
    const aws_resource_catalog = new coralogix.Integration("aws-resource-catalog", {
        integrationKey: "aws-resource-catalog",
        parameters: [{
            AwsRoleArn: "arn:aws:iam::123456789012:role/S3Access",
            IntegrationName: "aws-resource-catalog",
        }],
        version: "0.1.0",
    });
    
    import pulumi
    import pulumi_coralogix as coralogix
    
    example = coralogix.Integration("example",
        integration_key="aws-metrics-collector",
        parameters=[{
            "ApplicationName": "cxsdk",
            "AwsRegion": "eu-north-1",
            "AwsRoleArn": "arn:aws:iam::123456789012:role/example-role",
            "EnrichWithTags": True,
            "IntegrationName": "sdk-integration-setup",
            "MetricNamespaces": ["AWS/S3"],
            "SubsystemName": "aws-metrics-collector",
            "WithAggregations": False,
        }],
        version="0.1.0")
    aws_resource_catalog = coralogix.Integration("aws-resource-catalog",
        integration_key="aws-resource-catalog",
        parameters=[{
            "AwsRoleArn": "arn:aws:iam::123456789012:role/S3Access",
            "IntegrationName": "aws-resource-catalog",
        }],
        version="0.1.0")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/coralogix/v2/coralogix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := coralogix.NewIntegration(ctx, "example", &coralogix.IntegrationArgs{
    			IntegrationKey: pulumi.String("aws-metrics-collector"),
    			Parameters: pulumi.Any{
    				map[string]interface{}{
    					"ApplicationName": "cxsdk",
    					"AwsRegion":       "eu-north-1",
    					"AwsRoleArn":      "arn:aws:iam::123456789012:role/example-role",
    					"EnrichWithTags":  true,
    					"IntegrationName": "sdk-integration-setup",
    					"MetricNamespaces": []string{
    						"AWS/S3",
    					},
    					"SubsystemName":    "aws-metrics-collector",
    					"WithAggregations": false,
    				},
    			},
    			Version: pulumi.String("0.1.0"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = coralogix.NewIntegration(ctx, "aws-resource-catalog", &coralogix.IntegrationArgs{
    			IntegrationKey: pulumi.String("aws-resource-catalog"),
    			Parameters: pulumi.Any{
    				map[string]interface{}{
    					"AwsRoleArn":      "arn:aws:iam::123456789012:role/S3Access",
    					"IntegrationName": "aws-resource-catalog",
    				},
    			},
    			Version: pulumi.String("0.1.0"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Coralogix = Pulumi.Coralogix;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Coralogix.Integration("example", new()
        {
            IntegrationKey = "aws-metrics-collector",
            Parameters = new[]
            {
                
                {
                    { "ApplicationName", "cxsdk" },
                    { "AwsRegion", "eu-north-1" },
                    { "AwsRoleArn", "arn:aws:iam::123456789012:role/example-role" },
                    { "EnrichWithTags", true },
                    { "IntegrationName", "sdk-integration-setup" },
                    { "MetricNamespaces", new[]
                    {
                        "AWS/S3",
                    } },
                    { "SubsystemName", "aws-metrics-collector" },
                    { "WithAggregations", false },
                },
            },
            Version = "0.1.0",
        });
    
        var aws_resource_catalog = new Coralogix.Integration("aws-resource-catalog", new()
        {
            IntegrationKey = "aws-resource-catalog",
            Parameters = new[]
            {
                
                {
                    { "AwsRoleArn", "arn:aws:iam::123456789012:role/S3Access" },
                    { "IntegrationName", "aws-resource-catalog" },
                },
            },
            Version = "0.1.0",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.coralogix.Integration;
    import com.pulumi.coralogix.IntegrationArgs;
    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 example = new Integration("example", IntegrationArgs.builder()
                .integrationKey("aws-metrics-collector")
                .parameters(Map.ofEntries(
                    Map.entry("ApplicationName", "cxsdk"),
                    Map.entry("AwsRegion", "eu-north-1"),
                    Map.entry("AwsRoleArn", "arn:aws:iam::123456789012:role/example-role"),
                    Map.entry("EnrichWithTags", true),
                    Map.entry("IntegrationName", "sdk-integration-setup"),
                    Map.entry("MetricNamespaces", "AWS/S3"),
                    Map.entry("SubsystemName", "aws-metrics-collector"),
                    Map.entry("WithAggregations", false)
                ))
                .version("0.1.0")
                .build());
    
            var aws_resource_catalog = new Integration("aws-resource-catalog", IntegrationArgs.builder()
                .integrationKey("aws-resource-catalog")
                .parameters(Map.ofEntries(
                    Map.entry("AwsRoleArn", "arn:aws:iam::123456789012:role/S3Access"),
                    Map.entry("IntegrationName", "aws-resource-catalog")
                ))
                .version("0.1.0")
                .build());
    
        }
    }
    
    resources:
      example:
        type: coralogix:Integration
        properties:
          integrationKey: aws-metrics-collector
          # Note that the attribute casing is important here
          parameters:
            - ApplicationName: cxsdk
              AwsRegion: eu-north-1
              AwsRoleArn: arn:aws:iam::123456789012:role/example-role
              EnrichWithTags: true
              IntegrationName: sdk-integration-setup
              MetricNamespaces:
                - AWS/S3
              SubsystemName: aws-metrics-collector
              WithAggregations: false
          version: 0.1.0
      aws-resource-catalog:
        type: coralogix:Integration
        properties:
          integrationKey: aws-resource-catalog
          parameters:
            - AwsRoleArn: arn:aws:iam::123456789012:role/S3Access
              IntegrationName: aws-resource-catalog
          version: 0.1.0
    

    Create Integration Resource

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

    Constructor syntax

    new Integration(name: string, args: IntegrationArgs, opts?: CustomResourceOptions);
    @overload
    def Integration(resource_name: str,
                    args: IntegrationArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Integration(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    integration_key: Optional[str] = None,
                    parameters: Optional[Any] = None,
                    version: Optional[str] = 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: coralogix:Integration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.

    Constructor example

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

    var integrationResource = new Coralogix.Integration("integrationResource", new()
    {
        IntegrationKey = "string",
        Parameters = "any",
        Version = "string",
    });
    
    example, err := coralogix.NewIntegration(ctx, "integrationResource", &coralogix.IntegrationArgs{
    	IntegrationKey: pulumi.String("string"),
    	Parameters:     pulumi.Any("any"),
    	Version:        pulumi.String("string"),
    })
    
    var integrationResource = new Integration("integrationResource", IntegrationArgs.builder()
        .integrationKey("string")
        .parameters("any")
        .version("string")
        .build());
    
    integration_resource = coralogix.Integration("integrationResource",
        integration_key="string",
        parameters="any",
        version="string")
    
    const integrationResource = new coralogix.Integration("integrationResource", {
        integrationKey: "string",
        parameters: "any",
        version: "string",
    });
    
    type: coralogix:Integration
    properties:
        integrationKey: string
        parameters: any
        version: string
    

    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

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

    The Integration resource accepts the following input properties:

    IntegrationKey string
    Selector for the integration.
    Parameters object
    Parameters required by the integration.
    Version string
    The integration version
    IntegrationKey string
    Selector for the integration.
    Parameters interface{}
    Parameters required by the integration.
    Version string
    The integration version
    integrationKey String
    Selector for the integration.
    parameters Object
    Parameters required by the integration.
    version String
    The integration version
    integrationKey string
    Selector for the integration.
    parameters any
    Parameters required by the integration.
    version string
    The integration version
    integration_key str
    Selector for the integration.
    parameters Any
    Parameters required by the integration.
    version str
    The integration version
    integrationKey String
    Selector for the integration.
    parameters Any
    Parameters required by the integration.
    version String
    The integration version

    Outputs

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

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

    Look up Existing 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,
            integration_key: Optional[str] = None,
            parameters: Optional[Any] = None,
            version: Optional[str] = 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)
    resources:  _:    type: coralogix:Integration    get:      id: ${id}
    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:
    IntegrationKey string
    Selector for the integration.
    Parameters object
    Parameters required by the integration.
    Version string
    The integration version
    IntegrationKey string
    Selector for the integration.
    Parameters interface{}
    Parameters required by the integration.
    Version string
    The integration version
    integrationKey String
    Selector for the integration.
    parameters Object
    Parameters required by the integration.
    version String
    The integration version
    integrationKey string
    Selector for the integration.
    parameters any
    Parameters required by the integration.
    version string
    The integration version
    integration_key str
    Selector for the integration.
    parameters Any
    Parameters required by the integration.
    version str
    The integration version
    integrationKey String
    Selector for the integration.
    parameters Any
    Parameters required by the integration.
    version String
    The integration version

    Package Details

    Repository
    coralogix coralogix/terraform-provider-coralogix
    License
    Notes
    This Pulumi package is based on the coralogix Terraform Provider.
    coralogix logo
    coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix