@lbrlabs/pulumi-cockroach
Version:
A Pulumi package to create and managed cockroach db resources in Pulumi programs.
169 lines (168 loc) • 6.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Log Export configuration for a cluster.
*/
export declare class LogExportConfig extends pulumi.CustomResource {
/**
* Get an existing LogExportConfig 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?: LogExportConfigState, opts?: pulumi.CustomResourceOptions): LogExportConfig;
/**
* Returns true if the given object is an instance of LogExportConfig. 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 LogExportConfig;
/**
* Either the AWS Role ARN that identifies a role that the cluster account can assume to write to CloudWatch or the GCP
* Project ID that the cluster service account has permissions to write to for cloud logging.
*/
readonly authPrincipal: pulumi.Output<string>;
/**
* Cluster ID.
*/
readonly clusterId: pulumi.Output<string>;
/**
* Indicates when log export was initially configured.
*/
readonly createdAt: pulumi.Output<string>;
readonly groups: pulumi.Output<outputs.LogExportConfigGroup[] | undefined>;
/**
* An identifier for the logs in the customer's log sink.
*/
readonly logName: pulumi.Output<string>;
/**
* Controls what CRDB channels do not get exported.
*/
readonly omittedChannels: pulumi.Output<string[] | undefined>;
/**
* Controls whether logs are redacted before forwarding to customer sinks.
*/
readonly redact: pulumi.Output<boolean | undefined>;
/**
* Controls whether all logs are sent to a specific region in the customer sink.
*/
readonly region: pulumi.Output<string>;
/**
* Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
*/
readonly status: pulumi.Output<string>;
/**
* The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH *
* GCP_CLOUD_LOGGING
*/
readonly type: pulumi.Output<string>;
/**
* Indicates when the log export configuration was last updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous
* operations.
*/
readonly userMessage: pulumi.Output<string>;
/**
* Create a LogExportConfig 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: LogExportConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LogExportConfig resources.
*/
export interface LogExportConfigState {
/**
* Either the AWS Role ARN that identifies a role that the cluster account can assume to write to CloudWatch or the GCP
* Project ID that the cluster service account has permissions to write to for cloud logging.
*/
authPrincipal?: pulumi.Input<string>;
/**
* Cluster ID.
*/
clusterId?: pulumi.Input<string>;
/**
* Indicates when log export was initially configured.
*/
createdAt?: pulumi.Input<string>;
groups?: pulumi.Input<pulumi.Input<inputs.LogExportConfigGroup>[]>;
/**
* An identifier for the logs in the customer's log sink.
*/
logName?: pulumi.Input<string>;
/**
* Controls what CRDB channels do not get exported.
*/
omittedChannels?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Controls whether logs are redacted before forwarding to customer sinks.
*/
redact?: pulumi.Input<boolean>;
/**
* Controls whether all logs are sent to a specific region in the customer sink.
*/
region?: pulumi.Input<string>;
/**
* Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
*/
status?: pulumi.Input<string>;
/**
* The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH *
* GCP_CLOUD_LOGGING
*/
type?: pulumi.Input<string>;
/**
* Indicates when the log export configuration was last updated.
*/
updatedAt?: pulumi.Input<string>;
/**
* Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous
* operations.
*/
userMessage?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a LogExportConfig resource.
*/
export interface LogExportConfigArgs {
/**
* Either the AWS Role ARN that identifies a role that the cluster account can assume to write to CloudWatch or the GCP
* Project ID that the cluster service account has permissions to write to for cloud logging.
*/
authPrincipal: pulumi.Input<string>;
/**
* Cluster ID.
*/
clusterId: pulumi.Input<string>;
groups?: pulumi.Input<pulumi.Input<inputs.LogExportConfigGroup>[]>;
/**
* An identifier for the logs in the customer's log sink.
*/
logName: pulumi.Input<string>;
/**
* Controls what CRDB channels do not get exported.
*/
omittedChannels?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Controls whether logs are redacted before forwarding to customer sinks.
*/
redact?: pulumi.Input<boolean>;
/**
* Controls whether all logs are sent to a specific region in the customer sink.
*/
region?: pulumi.Input<string>;
/**
* The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH *
* GCP_CLOUD_LOGGING
*/
type: pulumi.Input<string>;
}