@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
192 lines (191 loc) • 6.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage tls shipper
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.tls.Shipper("foo", {
* contentInfo: {
* format: "json",
* jsonInfo: {
* enable: true,
* keys: [
* "__content",
* "__pod_name__",
* "__path__",
* "__tf-test__",
* ],
* },
* },
* shipperEndTime: 1751255700021,
* shipperName: "tf-test",
* shipperStartTime: 1750737324521,
* shipperType: "tos",
* topicId: "8ba48bd7-2493-4300-b1d0-cb7xxxxxx",
* tosShipperInfo: {
* bucket: "tf-test",
* compress: "snappy",
* interval: 100,
* maxSize: 100,
* partitionFormat: "%Y/%m/%d/%H/%M",
* prefix: "terraform_1.9.4_linux_amd64.zip",
* },
* });
* ```
*
* ## Import
*
* Shipper can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:tls/shipper:Shipper default resource_id
* ```
*/
export declare class Shipper extends pulumi.CustomResource {
/**
* Get an existing Shipper 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?: ShipperState, opts?: pulumi.CustomResourceOptions): Shipper;
/**
* Returns true if the given object is an instance of Shipper. 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 Shipper;
/**
* Configuration of the delivery format for log content.
*/
readonly contentInfo: pulumi.Output<outputs.tls.ShipperContentInfo>;
/**
* JSON format log content configuration.
*/
readonly kafkaShipperInfo: pulumi.Output<outputs.tls.ShipperKafkaShipperInfo>;
/**
* Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly shipperEndTime: pulumi.Output<number | undefined>;
/**
* Delivery configuration name.
*/
readonly shipperName: pulumi.Output<string>;
/**
* Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly shipperStartTime: pulumi.Output<number | undefined>;
/**
* The type of delivery.
*/
readonly shipperType: pulumi.Output<string>;
/**
* Whether to enable the delivery configuration. The default value is true.
*/
readonly status: pulumi.Output<boolean>;
/**
* The log topic ID where the log to be delivered is located.
*/
readonly topicId: pulumi.Output<string>;
/**
* Deliver the relevant configuration to the object storage (TOS).
*/
readonly tosShipperInfo: pulumi.Output<outputs.tls.ShipperTosShipperInfo>;
/**
* Create a Shipper 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: ShipperArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Shipper resources.
*/
export interface ShipperState {
/**
* Configuration of the delivery format for log content.
*/
contentInfo?: pulumi.Input<inputs.tls.ShipperContentInfo>;
/**
* JSON format log content configuration.
*/
kafkaShipperInfo?: pulumi.Input<inputs.tls.ShipperKafkaShipperInfo>;
/**
* Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
shipperEndTime?: pulumi.Input<number>;
/**
* Delivery configuration name.
*/
shipperName?: pulumi.Input<string>;
/**
* Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
shipperStartTime?: pulumi.Input<number>;
/**
* The type of delivery.
*/
shipperType?: pulumi.Input<string>;
/**
* Whether to enable the delivery configuration. The default value is true.
*/
status?: pulumi.Input<boolean>;
/**
* The log topic ID where the log to be delivered is located.
*/
topicId?: pulumi.Input<string>;
/**
* Deliver the relevant configuration to the object storage (TOS).
*/
tosShipperInfo?: pulumi.Input<inputs.tls.ShipperTosShipperInfo>;
}
/**
* The set of arguments for constructing a Shipper resource.
*/
export interface ShipperArgs {
/**
* Configuration of the delivery format for log content.
*/
contentInfo: pulumi.Input<inputs.tls.ShipperContentInfo>;
/**
* JSON format log content configuration.
*/
kafkaShipperInfo?: pulumi.Input<inputs.tls.ShipperKafkaShipperInfo>;
/**
* Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
shipperEndTime?: pulumi.Input<number>;
/**
* Delivery configuration name.
*/
shipperName: pulumi.Input<string>;
/**
* Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
shipperStartTime?: pulumi.Input<number>;
/**
* The type of delivery.
*/
shipperType?: pulumi.Input<string>;
/**
* Whether to enable the delivery configuration. The default value is true.
*/
status?: pulumi.Input<boolean>;
/**
* The log topic ID where the log to be delivered is located.
*/
topicId: pulumi.Input<string>;
/**
* Deliver the relevant configuration to the object storage (TOS).
*/
tosShipperInfo?: pulumi.Input<inputs.tls.ShipperTosShipperInfo>;
}