UNPKG

@pulumi/sumologic

Version:

A Pulumi package for creating and managing sumologic cloud resources.

129 lines (128 loc) 5.14 kB
import * as pulumi from "@pulumi/pulumi"; /** * Provides a [Sumologic Cloud-to-Cloud source][1]. * * ## Supported Integrations * * List of available integrations along with their corresponding `JSON` templates is present [here](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Cloud-to-Cloud_Integration_Framework#Integrations) * * __IMPORTANT:__ The API credentials are stored in plain-text in the state. This is a potential security issue. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as sumologic from "@pulumi/sumologic"; * * const collector = new sumologic.Collector("collector", { * name: "my-collector", * description: "Just testing this", * }); * const oktaSource = new sumologic.CloudToCloudSource("okta_source", { * collectorId: collector.id, * schemaRef: { * type: "Okta", * }, * config: JSON.stringify({ * name: "okta source", * domain: "dev-xxx-admin.okta.com", * collectAll: true, * apiKey: "xxx", * fields: { * _siemForward: false, * }, * pollingInterval: 30, * }), * }); * ``` * * ## Import * * Cloud-to-Cloud sources can be imported using the collector and source IDs (`collector/source`), e.g.: * * hcl * * ```sh * $ pulumi import sumologic:index/cloudToCloudSource:CloudToCloudSource test 100000001/100000001 * ``` * * Cloud-to-Cloud sources can be imported using the collector name and source name (`collectorName/sourceName`), e.g.: * * hcl * * ```sh * $ pulumi import sumologic:index/cloudToCloudSource:CloudToCloudSource test my-test-collector/my-test-source * ``` * * [1]: https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Cloud-to-Cloud_Integration_Framework * * [2]: https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Cloud-to-Cloud_Integration_Framework#Integrations */ export declare class CloudToCloudSource extends pulumi.CustomResource { /** * Get an existing CloudToCloudSource resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CloudToCloudSourceState, opts?: pulumi.CustomResourceOptions): CloudToCloudSource; /** * Returns true if the given object is an instance of CloudToCloudSource. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is CloudToCloudSource; readonly collectorId: pulumi.Output<number>; /** * This is a JSON object which contains the configuration parameters for the Source. Each schema type requires different JSON parameters. Refer to `JSON Configuration` and `Config Parameters` sections in the integration page for the specific `type` you have chosen to create. */ readonly config: pulumi.Output<string>; /** * Source schema details. */ readonly schemaRef: pulumi.Output<{ [key: string]: string; }>; /** * Create a CloudToCloudSource resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: CloudToCloudSourceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering CloudToCloudSource resources. */ export interface CloudToCloudSourceState { collectorId?: pulumi.Input<number>; /** * This is a JSON object which contains the configuration parameters for the Source. Each schema type requires different JSON parameters. Refer to `JSON Configuration` and `Config Parameters` sections in the integration page for the specific `type` you have chosen to create. */ config?: pulumi.Input<string>; /** * Source schema details. */ schemaRef?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; } /** * The set of arguments for constructing a CloudToCloudSource resource. */ export interface CloudToCloudSourceArgs { collectorId: pulumi.Input<number>; /** * This is a JSON object which contains the configuration parameters for the Source. Each schema type requires different JSON parameters. Refer to `JSON Configuration` and `Config Parameters` sections in the integration page for the specific `type` you have chosen to create. */ config: pulumi.Input<string>; /** * Source schema details. */ schemaRef: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; }