@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
217 lines (216 loc) • 9.44 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provides a [Sumologic Kinesis Log source](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/AWS_Kinesis_Firehose_for_Logs_Source). This source is used to ingest log via Kinesis Firehose from AWS.
*
* __IMPORTANT:__ The AWS 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 kinesisLogAccessKey = new sumologic.KinesisLogSource("kinesis_log_access_key", {
* name: "Kinesis Log",
* description: "Description for Kinesis Log Source",
* category: "prod/kinesis/log",
* contentType: "KinesisLog",
* collectorId: collector.id,
* authentication: {
* type: "S3BucketAuthentication",
* accessKey: "someKey",
* secretKey: "******",
* },
* path: {
* type: "KinesisLogPath",
* bucketName: "testBucket",
* pathExpression: "http-endpoint-failed/*",
* scanInterval: 30000,
* },
* });
* const kinesisLogRoleArn = new sumologic.KinesisLogSource("kinesis_log_role_arn", {
* name: "Kinesis Log",
* description: "Description for Kinesis Log Source",
* category: "prod/kinesis/log",
* contentType: "KinesisLog",
* collectorId: collector.id,
* authentication: {
* type: "AWSRoleBasedAuthentication",
* roleArn: "arn:aws:iam::604066827510:role/cw-role-SumoRole-4AOLS73TGKYI",
* },
* path: {
* type: "KinesisLogPath",
* bucketName: "testBucket",
* pathExpression: "http-endpoint-failed/*",
* scanInterval: 30000,
* },
* });
* ```
*
* ## Import
*
* Kinesis Log sources can be imported using the collector and source IDs (`collector/source`), e.g.:
*
* hcl
*
* ```sh
* $ pulumi import sumologic:index/kinesisLogSource:KinesisLogSource test 123/456
* ```
*
* HTTP sources can be imported using the collector name and source name (`collectorName/sourceName`), e.g.:
*
* hcl
*
* ```sh
* $ pulumi import sumologic:index/kinesisLogSource:KinesisLogSource test my-test-collector/my-test-source
* ```
*
* [1]: https://help.sumologic.com/Send_Data/Sources/03Use_JSON_to_Configure_Sources/JSON_Parameters_for_Hosted_Sources
*
* [2]: https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/AWS_Kinesis_Firehose_for_Logs_Source
*/
export declare class KinesisLogSource extends pulumi.CustomResource {
/**
* Get an existing KinesisLogSource 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?: KinesisLogSourceState, opts?: pulumi.CustomResourceOptions): KinesisLogSource;
/**
* Returns true if the given object is an instance of KinesisLogSource. 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 KinesisLogSource;
/**
* Authentication details for connecting to the S3 bucket.
*/
readonly authentication: pulumi.Output<outputs.KinesisLogSourceAuthentication | undefined>;
readonly automaticDateParsing: pulumi.Output<boolean | undefined>;
readonly category: pulumi.Output<string | undefined>;
readonly collectorId: pulumi.Output<number>;
/**
* The content-type of the collected data. Details can be found in the [Sumologic documentation for hosted sources](https://help.sumologic.com/Send_Data/Sources/03Use_JSON_to_Configure_Sources/JSON_Parameters_for_Hosted_Sources).
*/
readonly contentType: pulumi.Output<string>;
readonly cutoffRelativeTime: pulumi.Output<string | undefined>;
readonly cutoffTimestamp: pulumi.Output<number | undefined>;
readonly defaultDateFormats: pulumi.Output<outputs.KinesisLogSourceDefaultDateFormat[] | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly fields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly filters: pulumi.Output<outputs.KinesisLogSourceFilter[] | undefined>;
readonly forceTimezone: pulumi.Output<boolean | undefined>;
readonly hashAlgorithm: pulumi.Output<string | undefined>;
readonly hostName: pulumi.Output<string | undefined>;
readonly manualPrefixRegexp: pulumi.Output<string | undefined>;
readonly messagePerRequest: pulumi.Output<boolean | undefined>;
readonly multilineProcessingEnabled: pulumi.Output<boolean | undefined>;
readonly name: pulumi.Output<string>;
/**
* The location of S3 bucket for failed Kinesis log data.
*/
readonly path: pulumi.Output<outputs.KinesisLogSourcePath | undefined>;
readonly timezone: pulumi.Output<string | undefined>;
/**
* The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
*/
readonly url: pulumi.Output<string>;
readonly useAutolineMatching: pulumi.Output<boolean | undefined>;
/**
* Create a KinesisLogSource 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: KinesisLogSourceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering KinesisLogSource resources.
*/
export interface KinesisLogSourceState {
/**
* Authentication details for connecting to the S3 bucket.
*/
authentication?: pulumi.Input<inputs.KinesisLogSourceAuthentication>;
automaticDateParsing?: pulumi.Input<boolean>;
category?: pulumi.Input<string>;
collectorId?: pulumi.Input<number>;
/**
* The content-type of the collected data. Details can be found in the [Sumologic documentation for hosted sources](https://help.sumologic.com/Send_Data/Sources/03Use_JSON_to_Configure_Sources/JSON_Parameters_for_Hosted_Sources).
*/
contentType?: pulumi.Input<string>;
cutoffRelativeTime?: pulumi.Input<string>;
cutoffTimestamp?: pulumi.Input<number>;
defaultDateFormats?: pulumi.Input<pulumi.Input<inputs.KinesisLogSourceDefaultDateFormat>[]>;
description?: pulumi.Input<string>;
fields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
filters?: pulumi.Input<pulumi.Input<inputs.KinesisLogSourceFilter>[]>;
forceTimezone?: pulumi.Input<boolean>;
hashAlgorithm?: pulumi.Input<string>;
hostName?: pulumi.Input<string>;
manualPrefixRegexp?: pulumi.Input<string>;
messagePerRequest?: pulumi.Input<boolean>;
multilineProcessingEnabled?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
/**
* The location of S3 bucket for failed Kinesis log data.
*/
path?: pulumi.Input<inputs.KinesisLogSourcePath>;
timezone?: pulumi.Input<string>;
/**
* The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
*/
url?: pulumi.Input<string>;
useAutolineMatching?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a KinesisLogSource resource.
*/
export interface KinesisLogSourceArgs {
/**
* Authentication details for connecting to the S3 bucket.
*/
authentication?: pulumi.Input<inputs.KinesisLogSourceAuthentication>;
automaticDateParsing?: pulumi.Input<boolean>;
category?: pulumi.Input<string>;
collectorId: pulumi.Input<number>;
/**
* The content-type of the collected data. Details can be found in the [Sumologic documentation for hosted sources](https://help.sumologic.com/Send_Data/Sources/03Use_JSON_to_Configure_Sources/JSON_Parameters_for_Hosted_Sources).
*/
contentType: pulumi.Input<string>;
cutoffRelativeTime?: pulumi.Input<string>;
cutoffTimestamp?: pulumi.Input<number>;
defaultDateFormats?: pulumi.Input<pulumi.Input<inputs.KinesisLogSourceDefaultDateFormat>[]>;
description?: pulumi.Input<string>;
fields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
filters?: pulumi.Input<pulumi.Input<inputs.KinesisLogSourceFilter>[]>;
forceTimezone?: pulumi.Input<boolean>;
hashAlgorithm?: pulumi.Input<string>;
hostName?: pulumi.Input<string>;
manualPrefixRegexp?: pulumi.Input<string>;
messagePerRequest?: pulumi.Input<boolean>;
multilineProcessingEnabled?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
/**
* The location of S3 bucket for failed Kinesis log data.
*/
path?: pulumi.Input<inputs.KinesisLogSourcePath>;
timezone?: pulumi.Input<string>;
useAutolineMatching?: pulumi.Input<boolean>;
}