@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
210 lines (209 loc) • 8.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provides a Sumologic AWS XRay source to collect metrics derived from XRay traces.
*
* __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 awsXraySource = new sumologic.AwsXraySource("aws_xray_source", {
* name: "AWS XRay Metrics",
* description: "My description",
* category: "aws/xray",
* contentType: "AwsXRay",
* scanInterval: 300000,
* paused: false,
* collectorId: collector.id,
* authentication: {
* type: "AWSRoleBasedAuthentication",
* roleArn: "arn:aws:iam::01234567890:role/sumo-role",
* },
* path: {
* type: "AwsXRayPath",
* limitToRegions: ["us-west-2"],
* },
* });
* ```
*
* ## Import
*
* AWS XRay sources can be imported using the collector and source IDs (`collector/source`), e.g.:
*
* hcl
*
* ```sh
* $ pulumi import sumologic:index/awsXraySource:AwsXraySource test 123/456
* ```
*
* AWS XRay sources can be imported using the collector name and source name (`collectorName/sourceName`), e.g.:
*
* hcl
*
* ```sh
* $ pulumi import sumologic:index/awsXraySource:AwsXraySource test my-test-collector/my-test-source
* ```
*/
export declare class AwsXraySource extends pulumi.CustomResource {
/**
* Get an existing AwsXraySource 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?: AwsXraySourceState, opts?: pulumi.CustomResourceOptions): AwsXraySource;
/**
* Returns true if the given object is an instance of AwsXraySource. 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 AwsXraySource;
/**
* Authentication details for making `xray:Get*` calls.
*/
readonly authentication: pulumi.Output<outputs.AwsXraySourceAuthentication>;
readonly automaticDateParsing: pulumi.Output<boolean | undefined>;
readonly category: pulumi.Output<string | undefined>;
readonly collectorId: pulumi.Output<number>;
/**
* The content-type of the collected data. This has to be `AwsXRay` for AWS XRay source.
*/
readonly contentType: pulumi.Output<string>;
readonly cutoffRelativeTime: pulumi.Output<string | undefined>;
readonly cutoffTimestamp: pulumi.Output<number | undefined>;
readonly defaultDateFormats: pulumi.Output<outputs.AwsXraySourceDefaultDateFormat[] | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly fields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly filters: pulumi.Output<outputs.AwsXraySourceFilter[] | 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 multilineProcessingEnabled: pulumi.Output<boolean | undefined>;
readonly name: pulumi.Output<string>;
/**
* The location to scan for new data.
*/
readonly path: pulumi.Output<outputs.AwsXraySourcePath>;
/**
* When set to true, the scanner is paused. To disable, set to false.
*/
readonly paused: pulumi.Output<boolean | undefined>;
/**
* Time interval in milliseconds of scans for new data. The minimum value is 1000 milliseconds. Currently this value is not respected, and collection happens at a default interval of 1 minute.
*/
readonly scanInterval: pulumi.Output<number | undefined>;
readonly timezone: pulumi.Output<string | undefined>;
readonly url: pulumi.Output<string>;
readonly useAutolineMatching: pulumi.Output<boolean | undefined>;
/**
* Create a AwsXraySource 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: AwsXraySourceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AwsXraySource resources.
*/
export interface AwsXraySourceState {
/**
* Authentication details for making `xray:Get*` calls.
*/
authentication?: pulumi.Input<inputs.AwsXraySourceAuthentication>;
automaticDateParsing?: pulumi.Input<boolean>;
category?: pulumi.Input<string>;
collectorId?: pulumi.Input<number>;
/**
* The content-type of the collected data. This has to be `AwsXRay` for AWS XRay source.
*/
contentType?: pulumi.Input<string>;
cutoffRelativeTime?: pulumi.Input<string>;
cutoffTimestamp?: pulumi.Input<number>;
defaultDateFormats?: pulumi.Input<pulumi.Input<inputs.AwsXraySourceDefaultDateFormat>[]>;
description?: pulumi.Input<string>;
fields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
filters?: pulumi.Input<pulumi.Input<inputs.AwsXraySourceFilter>[]>;
forceTimezone?: pulumi.Input<boolean>;
hashAlgorithm?: pulumi.Input<string>;
hostName?: pulumi.Input<string>;
manualPrefixRegexp?: pulumi.Input<string>;
multilineProcessingEnabled?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
/**
* The location to scan for new data.
*/
path?: pulumi.Input<inputs.AwsXraySourcePath>;
/**
* When set to true, the scanner is paused. To disable, set to false.
*/
paused?: pulumi.Input<boolean>;
/**
* Time interval in milliseconds of scans for new data. The minimum value is 1000 milliseconds. Currently this value is not respected, and collection happens at a default interval of 1 minute.
*/
scanInterval?: pulumi.Input<number>;
timezone?: pulumi.Input<string>;
url?: pulumi.Input<string>;
useAutolineMatching?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a AwsXraySource resource.
*/
export interface AwsXraySourceArgs {
/**
* Authentication details for making `xray:Get*` calls.
*/
authentication: pulumi.Input<inputs.AwsXraySourceAuthentication>;
automaticDateParsing?: pulumi.Input<boolean>;
category?: pulumi.Input<string>;
collectorId: pulumi.Input<number>;
/**
* The content-type of the collected data. This has to be `AwsXRay` for AWS XRay source.
*/
contentType: pulumi.Input<string>;
cutoffRelativeTime?: pulumi.Input<string>;
cutoffTimestamp?: pulumi.Input<number>;
defaultDateFormats?: pulumi.Input<pulumi.Input<inputs.AwsXraySourceDefaultDateFormat>[]>;
description?: pulumi.Input<string>;
fields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
filters?: pulumi.Input<pulumi.Input<inputs.AwsXraySourceFilter>[]>;
forceTimezone?: pulumi.Input<boolean>;
hashAlgorithm?: pulumi.Input<string>;
hostName?: pulumi.Input<string>;
manualPrefixRegexp?: pulumi.Input<string>;
multilineProcessingEnabled?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
/**
* The location to scan for new data.
*/
path: pulumi.Input<inputs.AwsXraySourcePath>;
/**
* When set to true, the scanner is paused. To disable, set to false.
*/
paused?: pulumi.Input<boolean>;
/**
* Time interval in milliseconds of scans for new data. The minimum value is 1000 milliseconds. Currently this value is not respected, and collection happens at a default interval of 1 minute.
*/
scanInterval?: pulumi.Input<number>;
timezone?: pulumi.Input<string>;
useAutolineMatching?: pulumi.Input<boolean>;
}