@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
154 lines • 4.53 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets information about a [data export](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#data-exports) in Scaleway's Cockpit.
*
* Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
*
* ## Example Usage
*
* ### By ID
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = scaleway.observability.getExporter({
* id: "fr-par/11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ### By name and project
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = scaleway.observability.getExporter({
* projectId: "11111111-1111-1111-1111-111111111111",
* name: "my-datadog-exporter",
* });
* ```
*/
export declare function getExporter(args?: GetExporterArgs, opts?: pulumi.InvokeOptions): Promise<GetExporterResult>;
/**
* A collection of arguments for invoking getExporter.
*/
export interface GetExporterArgs {
/**
* The regional ID of the exporter (`{region}/{id}`). If set, other filters are ignored.
*/
id?: string;
/**
* The name of the exporter.
*/
name?: string;
/**
* The project ID.
*/
projectId?: string;
/**
* The region. Defaults to the provider region.
*/
region?: string;
}
/**
* A collection of values returned by getExporter.
*/
export interface GetExporterResult {
/**
* Creation date (RFC 3339).
*/
readonly createdAt: string;
/**
* Datadog destination configuration (endpoint only, API key is write-only).
*/
readonly datadogDestinations: outputs.observability.GetExporterDatadogDestination[];
/**
* ID of the linked data source.
*/
readonly datasourceId: string;
/**
* Description of the data export.
*/
readonly description: string;
/**
* List of exported products.
*/
readonly exportedProducts: string[];
/**
* The regional ID of the exporter.
*/
readonly id?: string;
/**
* Name of the data export.
*/
readonly name?: string;
/**
* OTLP destination configuration.
*/
readonly otlpDestinations: outputs.observability.GetExporterOtlpDestination[];
readonly projectId?: string;
readonly region?: string;
/**
* Status of the data export (`creating`, `ready`, `error`).
*/
readonly status: string;
/**
* Last update date (RFC 3339).
*/
readonly updatedAt: string;
}
/**
* Gets information about a [data export](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#data-exports) in Scaleway's Cockpit.
*
* Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
*
* ## Example Usage
*
* ### By ID
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = scaleway.observability.getExporter({
* id: "fr-par/11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ### By name and project
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = scaleway.observability.getExporter({
* projectId: "11111111-1111-1111-1111-111111111111",
* name: "my-datadog-exporter",
* });
* ```
*/
export declare function getExporterOutput(args?: GetExporterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetExporterResult>;
/**
* A collection of arguments for invoking getExporter.
*/
export interface GetExporterOutputArgs {
/**
* The regional ID of the exporter (`{region}/{id}`). If set, other filters are ignored.
*/
id?: pulumi.Input<string | undefined>;
/**
* The name of the exporter.
*/
name?: pulumi.Input<string | undefined>;
/**
* The project ID.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The region. Defaults to the provider region.
*/
region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getExporter.d.ts.map