@volcengine/pulumi/tls/getShippers.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to query detailed information of tls shippers
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const default = volcengine.tls.getShippers({});
 * ```
 */
export declare function getShippers(args?: GetShippersArgs, opts?: pulumi.InvokeOptions): Promise<GetShippersResult>;
/**
 * A collection of arguments for invoking getShippers.
 */
export interface GetShippersArgs {
    /**
     * Specify the IAM project name for querying the data delivery configuration under the specified IAM project.
     */
    iamProjectName?: string;
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: string;
    /**
     * File name where to save data source results.
     */
    outputFile?: string;
    /**
     * Specify the log item ID for querying the data delivery configuration under the specified log item.
     */
    projectId?: string;
    /**
     * Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
     */
    projectName?: string;
    /**
     * Delivery configuration ID.
     */
    shipperId?: string;
    /**
     * Delivery configuration name.
     */
    shipperName?: string;
    /**
     * Specify the delivery type for querying the delivery configuration related to that delivery type.
     */
    shipperType?: string;
    /**
     * Specify the log topic ID for querying the data delivery configuration related to this log topic.
     */
    topicId?: string;
    /**
     * Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
     */
    topicName?: string;
}
/**
 * A collection of values returned by getShippers.
 */
export interface GetShippersResult {
    readonly iamProjectName?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly nameRegex?: string;
    readonly outputFile?: string;
    /**
     * The log project ID where the log to be delivered is located.
     */
    readonly projectId?: string;
    /**
     * The name of the log item where the log to be delivered is located.
     */
    readonly projectName?: string;
    /**
     * Deliver configuration ID.
     */
    readonly shipperId?: string;
    /**
     * Delivery configuration name.
     */
    readonly shipperName?: string;
    /**
     * The type of delivery.
     */
    readonly shipperType?: string;
    /**
     * Submit the relevant information of the configuration.
     */
    readonly shippers: outputs.tls.GetShippersShipper[];
    /**
     * The log topic ID where the log to be delivered is located.
     */
    readonly topicId?: string;
    /**
     * The name of the log topic where the log to be delivered is located.
     */
    readonly topicName?: string;
    /**
     * The total count of query.
     */
    readonly totalCount: number;
}
/**
 * Use this data source to query detailed information of tls shippers
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const default = volcengine.tls.getShippers({});
 * ```
 */
export declare function getShippersOutput(args?: GetShippersOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetShippersResult>;
/**
 * A collection of arguments for invoking getShippers.
 */
export interface GetShippersOutputArgs {
    /**
     * Specify the IAM project name for querying the data delivery configuration under the specified IAM project.
     */
    iamProjectName?: pulumi.Input<string>;
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: pulumi.Input<string>;
    /**
     * File name where to save data source results.
     */
    outputFile?: pulumi.Input<string>;
    /**
     * Specify the log item ID for querying the data delivery configuration under the specified log item.
     */
    projectId?: pulumi.Input<string>;
    /**
     * Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
     */
    projectName?: pulumi.Input<string>;
    /**
     * Delivery configuration ID.
     */
    shipperId?: pulumi.Input<string>;
    /**
     * Delivery configuration name.
     */
    shipperName?: pulumi.Input<string>;
    /**
     * Specify the delivery type for querying the delivery configuration related to that delivery type.
     */
    shipperType?: pulumi.Input<string>;
    /**
     * Specify the log topic ID for querying the data delivery configuration related to this log topic.
     */
    topicId?: pulumi.Input<string>;
    /**
     * Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
     */
    topicName?: pulumi.Input<string>;
}