@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
74 lines • 3.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Splunk Observability AWS CloudWatch integrations using Role ARNs. For help with this integration see [Connect to AWS CloudWatch](https://docs.splunk.com/observability/en/gdi/get-data-in/connect/aws/aws-apiconfig.html).
*
* > **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](https://dev.splunk.com/observability/docs/administration/authtokens#Operations-that-require-a-session-token-for-an-administrator).
*
* > **WARNING** This resource implements part of a workflow. Use it with `signalfx.aws.Integration`. Check with Splunk support for your realm's AWS account id.
*
* > **NOTE** When AWS IAM role is also created by Terraform to enforce a proper cleanup sequence add role related resources as dependencies for the `signalfx.aws.Integration` resource. See the `dependsOn` section in the example script below.
*/
export declare class ExternalIntegration extends pulumi.CustomResource {
/**
* Get an existing ExternalIntegration 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?: ExternalIntegrationState, opts?: pulumi.CustomResourceOptions): ExternalIntegration;
/**
* Returns true if the given object is an instance of ExternalIntegration. 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 ExternalIntegration;
/**
* The external ID to use with your IAM role and with `signalfx.aws.Integration`.
*/
readonly externalId: pulumi.Output<string>;
/**
* The name of this integration
*/
readonly name: pulumi.Output<string>;
/**
* The AWS Account ARN to use with your policies/roles, provided by Splunk Observability Cloud.
*/
readonly signalfxAwsAccount: pulumi.Output<string>;
/**
* Create a ExternalIntegration 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?: ExternalIntegrationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ExternalIntegration resources.
*/
export interface ExternalIntegrationState {
/**
* The external ID to use with your IAM role and with `signalfx.aws.Integration`.
*/
externalId?: pulumi.Input<string | undefined>;
/**
* The name of this integration
*/
name?: pulumi.Input<string | undefined>;
/**
* The AWS Account ARN to use with your policies/roles, provided by Splunk Observability Cloud.
*/
signalfxAwsAccount?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a ExternalIntegration resource.
*/
export interface ExternalIntegrationArgs {
/**
* The name of this integration
*/
name?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=externalIntegration.d.ts.map