Docs Packages
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. LogExportConfig
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.LogExportConfig

Explore with Pulumi AI

cockroach logo
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

    Log Export configuration for a cluster.

    Create LogExportConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LogExportConfig(name: string, args: LogExportConfigArgs, opts?: CustomResourceOptions);
    @overload
def LogExportConfig(resource_name: str,
                    args: LogExportConfigArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def LogExportConfig(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    auth_principal: Optional[str] = None,
                    cluster_id: Optional[str] = None,
                    log_name: Optional[str] = None,
                    type: Optional[str] = None,
                    groups: Optional[Sequence[LogExportConfigGroupArgs]] = None,
                    omitted_channels: Optional[Sequence[str]] = None,
                    redact: Optional[bool] = None,
                    region: Optional[str] = None)
    func NewLogExportConfig(ctx *Context, name string, args LogExportConfigArgs, opts ...ResourceOption) (*LogExportConfig, error)
    public LogExportConfig(string name, LogExportConfigArgs args, CustomResourceOptions? opts = null)
    public LogExportConfig(String name, LogExportConfigArgs args)
public LogExportConfig(String name, LogExportConfigArgs args, CustomResourceOptions options)

    type: cockroach:LogExportConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LogExportConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LogExportConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LogExportConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogExportConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogExportConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var logExportConfigResource = new Cockroach.LogExportConfig("logExportConfigResource", new()
{
    AuthPrincipal = "string",
    ClusterId = "string",
    LogName = "string",
    Type = "string",
    Groups = new[]
    {
        new Cockroach.Inputs.LogExportConfigGroupArgs
        {
            Channels = new[]
            {
                "string",
            },
            LogName = "string",
            MinLevel = "string",
            Redact = false,
        },
    },
    OmittedChannels = new[]
    {
        "string",
    },
    Redact = false,
    Region = "string",
});

    example, err := cockroach.NewLogExportConfig(ctx, "logExportConfigResource", &cockroach.LogExportConfigArgs{
	AuthPrincipal: pulumi.String("string"),
	ClusterId:     pulumi.String("string"),
	LogName:       pulumi.String("string"),
	Type:          pulumi.String("string"),
	Groups: cockroach.LogExportConfigGroupArray{
		&cockroach.LogExportConfigGroupArgs{
			Channels: pulumi.StringArray{
				pulumi.String("string"),
			},
			LogName:  pulumi.String("string"),
			MinLevel: pulumi.String("string"),
			Redact:   pulumi.Bool(false),
		},
	},
	OmittedChannels: pulumi.StringArray{
		pulumi.String("string"),
	},
	Redact: pulumi.Bool(false),
	Region: pulumi.String("string"),
})

    var logExportConfigResource = new LogExportConfig("logExportConfigResource", LogExportConfigArgs.builder()
    .authPrincipal("string")
    .clusterId("string")
    .logName("string")
    .type("string")
    .groups(LogExportConfigGroupArgs.builder()
        .channels("string")
        .logName("string")
        .minLevel("string")
        .redact(false)
        .build())
    .omittedChannels("string")
    .redact(false)
    .region("string")
    .build());

    log_export_config_resource = cockroach.LogExportConfig("logExportConfigResource",
    auth_principal="string",
    cluster_id="string",
    log_name="string",
    type="string",
    groups=[cockroach.LogExportConfigGroupArgs(
        channels=["string"],
        log_name="string",
        min_level="string",
        redact=False,
    )],
    omitted_channels=["string"],
    redact=False,
    region="string")

    const logExportConfigResource = new cockroach.LogExportConfig("logExportConfigResource", {
    authPrincipal: "string",
    clusterId: "string",
    logName: "string",
    type: "string",
    groups: [{
        channels: ["string"],
        logName: "string",
        minLevel: "string",
        redact: false,
    }],
    omittedChannels: ["string"],
    redact: false,
    region: "string",
});

    type: cockroach:LogExportConfig
properties:
    authPrincipal: string
    clusterId: string
    groups:
        - channels:
            - string
          logName: string
          minLevel: string
          redact: false
    logName: string
    omittedChannels:
        - string
    redact: false
    region: string
    type: string

    LogExportConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The LogExportConfig resource accepts the following input properties:

    AuthPrincipal string
    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.
    ClusterId string
    Cluster ID.
    LogName string
    An identifier for the logs in the customer's log sink.
    Type string
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    Groups List<Pulumiverse.Cockroach.Inputs.LogExportConfigGroup>
    OmittedChannels List<string>
    Controls what CRDB channels do not get exported.
    Redact bool
    Controls whether logs are redacted before forwarding to customer sinks.
    Region string
    Controls whether all logs are sent to a specific region in the customer sink.
    AuthPrincipal string
    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.
    ClusterId string
    Cluster ID.
    LogName string
    An identifier for the logs in the customer's log sink.
    Type string
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    Groups []LogExportConfigGroupArgs
    OmittedChannels []string
    Controls what CRDB channels do not get exported.
    Redact bool
    Controls whether logs are redacted before forwarding to customer sinks.
    Region string
    Controls whether all logs are sent to a specific region in the customer sink.
    authPrincipal String
    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.
    clusterId String
    Cluster ID.
    logName String
    An identifier for the logs in the customer's log sink.
    type String
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    groups List<LogExportConfigGroup>
    omittedChannels List<String>
    Controls what CRDB channels do not get exported.
    redact Boolean
    Controls whether logs are redacted before forwarding to customer sinks.
    region String
    Controls whether all logs are sent to a specific region in the customer sink.
    authPrincipal string
    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.
    clusterId string
    Cluster ID.
    logName string
    An identifier for the logs in the customer's log sink.
    type string
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    groups LogExportConfigGroup[]
    omittedChannels string[]
    Controls what CRDB channels do not get exported.
    redact boolean
    Controls whether logs are redacted before forwarding to customer sinks.
    region string
    Controls whether all logs are sent to a specific region in the customer sink.
    auth_principal str
    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.
    cluster_id str
    Cluster ID.
    log_name str
    An identifier for the logs in the customer's log sink.
    type str
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    groups Sequence[LogExportConfigGroupArgs]
    omitted_channels Sequence[str]
    Controls what CRDB channels do not get exported.
    redact bool
    Controls whether logs are redacted before forwarding to customer sinks.
    region str
    Controls whether all logs are sent to a specific region in the customer sink.
    authPrincipal String
    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.
    clusterId String
    Cluster ID.
    logName String
    An identifier for the logs in the customer's log sink.
    type String
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    groups List<Property Map>
    omittedChannels List<String>
    Controls what CRDB channels do not get exported.
    redact Boolean
    Controls whether logs are redacted before forwarding to customer sinks.
    region String
    Controls whether all logs are sent to a specific region in the customer sink.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LogExportConfig resource produces the following output properties:

    CreatedAt string
    Indicates when log export was initially configured.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    UpdatedAt string
    Indicates when the log export configuration was last updated.
    UserMessage string
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
    CreatedAt string
    Indicates when log export was initially configured.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    UpdatedAt string
    Indicates when the log export configuration was last updated.
    UserMessage string
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
    createdAt String
    Indicates when log export was initially configured.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    updatedAt String
    Indicates when the log export configuration was last updated.
    userMessage String
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
    createdAt string
    Indicates when log export was initially configured.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    updatedAt string
    Indicates when the log export configuration was last updated.
    userMessage string
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
    created_at str
    Indicates when log export was initially configured.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    updated_at str
    Indicates when the log export configuration was last updated.
    user_message str
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
    createdAt String
    Indicates when log export was initially configured.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    updatedAt String
    Indicates when the log export configuration was last updated.
    userMessage String
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.

    Look up Existing LogExportConfig Resource

    Get an existing LogExportConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LogExportConfigState, opts?: CustomResourceOptions): LogExportConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_principal: Optional[str] = None,
        cluster_id: Optional[str] = None,
        created_at: Optional[str] = None,
        groups: Optional[Sequence[LogExportConfigGroupArgs]] = None,
        log_name: Optional[str] = None,
        omitted_channels: Optional[Sequence[str]] = None,
        redact: Optional[bool] = None,
        region: Optional[str] = None,
        status: Optional[str] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        user_message: Optional[str] = None) -> LogExportConfig
    func GetLogExportConfig(ctx *Context, name string, id IDInput, state *LogExportConfigState, opts ...ResourceOption) (*LogExportConfig, error)
    public static LogExportConfig Get(string name, Input<string> id, LogExportConfigState? state, CustomResourceOptions? opts = null)
    public static LogExportConfig get(String name, Output<String> id, LogExportConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AuthPrincipal string
    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.
    ClusterId string
    Cluster ID.
    CreatedAt string
    Indicates when log export was initially configured.
    Groups List<Pulumiverse.Cockroach.Inputs.LogExportConfigGroup>
    LogName string
    An identifier for the logs in the customer's log sink.
    OmittedChannels List<string>
    Controls what CRDB channels do not get exported.
    Redact bool
    Controls whether logs are redacted before forwarding to customer sinks.
    Region string
    Controls whether all logs are sent to a specific region in the customer sink.
    Status string
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    Type string
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    UpdatedAt string
    Indicates when the log export configuration was last updated.
    UserMessage string
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
    AuthPrincipal string
    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.
    ClusterId string
    Cluster ID.
    CreatedAt string
    Indicates when log export was initially configured.
    Groups []LogExportConfigGroupArgs
    LogName string
    An identifier for the logs in the customer's log sink.
    OmittedChannels []string
    Controls what CRDB channels do not get exported.
    Redact bool
    Controls whether logs are redacted before forwarding to customer sinks.
    Region string
    Controls whether all logs are sent to a specific region in the customer sink.
    Status string
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    Type string
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    UpdatedAt string
    Indicates when the log export configuration was last updated.
    UserMessage string
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
    authPrincipal String
    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.
    clusterId String
    Cluster ID.
    createdAt String
    Indicates when log export was initially configured.
    groups List<LogExportConfigGroup>
    logName String
    An identifier for the logs in the customer's log sink.
    omittedChannels List<String>
    Controls what CRDB channels do not get exported.
    redact Boolean
    Controls whether logs are redacted before forwarding to customer sinks.
    region String
    Controls whether all logs are sent to a specific region in the customer sink.
    status String
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    type String
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    updatedAt String
    Indicates when the log export configuration was last updated.
    userMessage String
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
    authPrincipal string
    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.
    clusterId string
    Cluster ID.
    createdAt string
    Indicates when log export was initially configured.
    groups LogExportConfigGroup[]
    logName string
    An identifier for the logs in the customer's log sink.
    omittedChannels string[]
    Controls what CRDB channels do not get exported.
    redact boolean
    Controls whether logs are redacted before forwarding to customer sinks.
    region string
    Controls whether all logs are sent to a specific region in the customer sink.
    status string
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    type string
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    updatedAt string
    Indicates when the log export configuration was last updated.
    userMessage string
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
    auth_principal str
    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.
    cluster_id str
    Cluster ID.
    created_at str
    Indicates when log export was initially configured.
    groups Sequence[LogExportConfigGroupArgs]
    log_name str
    An identifier for the logs in the customer's log sink.
    omitted_channels Sequence[str]
    Controls what CRDB channels do not get exported.
    redact bool
    Controls whether logs are redacted before forwarding to customer sinks.
    region str
    Controls whether all logs are sent to a specific region in the customer sink.
    status str
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    type str
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    updated_at str
    Indicates when the log export configuration was last updated.
    user_message str
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
    authPrincipal String
    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.
    clusterId String
    Cluster ID.
    createdAt String
    Indicates when log export was initially configured.
    groups List<Property Map>
    logName String
    An identifier for the logs in the customer's log sink.
    omittedChannels List<String>
    Controls what CRDB channels do not get exported.
    redact Boolean
    Controls whether logs are redacted before forwarding to customer sinks.
    region String
    Controls whether all logs are sent to a specific region in the customer sink.
    status String
    Encodes the possible states that a log export configuration can be in as it is created, deployed, and disabled.
    type String
    The cloud selection being exported to along with the cloud logging platform. Possible values are: * AWS_CLOUDWATCH * GCP_CLOUD_LOGGING
    updatedAt String
    Indicates when the log export configuration was last updated.
    userMessage String
    Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.

    Supporting Types

    LogExportConfigGroup, LogExportConfigGroupArgs

    Channels List<string>
    A list of CockroachDB log channels to include in this group.
    LogName string
    The name of the group, reflected in the log sink.
    MinLevel string
    The minimum log level to filter to this log group.
    Redact bool
    Governs whether this log group should aggregate redacted logs if unset.
    Channels []string
    A list of CockroachDB log channels to include in this group.
    LogName string
    The name of the group, reflected in the log sink.
    MinLevel string
    The minimum log level to filter to this log group.
    Redact bool
    Governs whether this log group should aggregate redacted logs if unset.
    channels List<String>
    A list of CockroachDB log channels to include in this group.
    logName String
    The name of the group, reflected in the log sink.
    minLevel String
    The minimum log level to filter to this log group.
    redact Boolean
    Governs whether this log group should aggregate redacted logs if unset.
    channels string[]
    A list of CockroachDB log channels to include in this group.
    logName string
    The name of the group, reflected in the log sink.
    minLevel string
    The minimum log level to filter to this log group.
    redact boolean
    Governs whether this log group should aggregate redacted logs if unset.
    channels Sequence[str]
    A list of CockroachDB log channels to include in this group.
    log_name str
    The name of the group, reflected in the log sink.
    min_level str
    The minimum log level to filter to this log group.
    redact bool
    Governs whether this log group should aggregate redacted logs if unset.
    channels List<String>
    A list of CockroachDB log channels to include in this group.
    logName String
    The name of the group, reflected in the log sink.
    minLevel String
    The minimum log level to filter to this log group.
    redact Boolean
    Governs whether this log group should aggregate redacted logs if unset.

    Package Details

    Repository
    cockroach pulumiverse/pulumi-cockroach
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cockroach Terraform Provider.
    cockroach logo
    CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
    pulumiverse/pulumi-cockroach