cockroach.LogExportConfig
Explore with Pulumi AI
Log Export configuration for a cluster.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cockroach.LogExportConfig;
import com.pulumi.cockroach.LogExportConfigArgs;
import com.pulumi.cockroach.inputs.LogExportConfigGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var clusterId = config.get("clusterId");
final var authPrincipal = config.get("authPrincipal");
var example = new LogExportConfig("example", LogExportConfigArgs.builder()
.clusterId(clusterId)
.authPrincipal(authPrincipal)
.logName("example")
.type("GCP_CLOUD_LOGGING")
.redact(true)
.groups(
LogExportConfigGroupArgs.builder()
.log_name("sql")
.channels(
"SQL_SCHEMA",
"SQL_EXEC")
.redact(false)
.build(),
LogExportConfigGroupArgs.builder()
.log_name("devops")
.channels(
"OPS",
"HEALTH",
"STORAGE")
.min_level("WARNING")
.build())
.omittedChannels("SQL_PERF")
.build());
}
}
configuration:
clusterId:
type: string
authPrincipal:
type: string
resources:
example:
type: cockroach:LogExportConfig
properties:
clusterId: ${clusterId}
authPrincipal: ${authPrincipal}
logName: example
type: GCP_CLOUD_LOGGING
redact: true
groups:
- log_name: sql
channels:
- SQL_SCHEMA
- SQL_EXEC
redact: false
- log_name: devops
channels:
- OPS
- HEALTH
- STORAGE
min_level: WARNING
omittedChannels:
- SQL_PERF
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=[{
"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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LogExportConfig resource accepts the following input properties:
- Auth
Principal 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.
- Cluster
Id string - Cluster ID.
- Log
Name 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 * AZURE_LOG_ANALYTICS
- Groups
List<Pulumiverse.
Cockroach. Inputs. Log Export Config Group> - Omitted
Channels 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.
- Auth
Principal 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.
- Cluster
Id string - Cluster ID.
- Log
Name 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 * AZURE_LOG_ANALYTICS
- Groups
[]Log
Export Config Group Args - Omitted
Channels []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.
- auth
Principal 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.
- cluster
Id String - Cluster ID.
- log
Name 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 * AZURE_LOG_ANALYTICS
- groups
List<Log
Export Config Group> - omitted
Channels 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.
- auth
Principal 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.
- cluster
Id string - Cluster ID.
- log
Name 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 * AZURE_LOG_ANALYTICS
- groups
Log
Export Config Group[] - omitted
Channels 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 * AZURE_LOG_ANALYTICS
- groups
Sequence[Log
Export Config Group Args] - 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.
- auth
Principal 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.
- cluster
Id String - Cluster ID.
- log
Name 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 * AZURE_LOG_ANALYTICS
- groups List<Property Map>
- omitted
Channels 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:
- Created
At 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.
- Updated
At string - Indicates when the log export configuration was last updated.
- User
Message string - Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
- Created
At 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.
- Updated
At string - Indicates when the log export configuration was last updated.
- User
Message string - Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
- created
At 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.
- updated
At String - Indicates when the log export configuration was last updated.
- user
Message String - Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
- created
At 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.
- updated
At string - Indicates when the log export configuration was last updated.
- user
Message 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.
- created
At 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.
- updated
At String - Indicates when the log export configuration was last updated.
- user
Message 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.
- Auth
Principal 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.
- Cluster
Id string - Cluster ID.
- Created
At string - Indicates when log export was initially configured.
- Groups
List<Pulumiverse.
Cockroach. Inputs. Log Export Config Group> - Log
Name string - An identifier for the logs in the customer's log sink.
- Omitted
Channels 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 * AZURE_LOG_ANALYTICS
- Updated
At string - Indicates when the log export configuration was last updated.
- User
Message string - Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
- Auth
Principal 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.
- Cluster
Id string - Cluster ID.
- Created
At string - Indicates when log export was initially configured.
- Groups
[]Log
Export Config Group Args - Log
Name string - An identifier for the logs in the customer's log sink.
- Omitted
Channels []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 * AZURE_LOG_ANALYTICS
- Updated
At string - Indicates when the log export configuration was last updated.
- User
Message string - Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
- auth
Principal 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.
- cluster
Id String - Cluster ID.
- created
At String - Indicates when log export was initially configured.
- groups
List<Log
Export Config Group> - log
Name String - An identifier for the logs in the customer's log sink.
- omitted
Channels 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 * AZURE_LOG_ANALYTICS
- updated
At String - Indicates when the log export configuration was last updated.
- user
Message String - Elaborates on the log export status and hints at how to fix issues that may have occurred during asynchronous operations.
- auth
Principal 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.
- cluster
Id string - Cluster ID.
- created
At string - Indicates when log export was initially configured.
- groups
Log
Export Config Group[] - log
Name string - An identifier for the logs in the customer's log sink.
- omitted
Channels 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 * AZURE_LOG_ANALYTICS
- updated
At string - Indicates when the log export configuration was last updated.
- user
Message 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[Log
Export Config Group Args] - 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 * AZURE_LOG_ANALYTICS
- 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.
- auth
Principal 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.
- cluster
Id String - Cluster ID.
- created
At String - Indicates when log export was initially configured.
- groups List<Property Map>
- log
Name String - An identifier for the logs in the customer's log sink.
- omitted
Channels 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 * AZURE_LOG_ANALYTICS
- updated
At String - Indicates when the log export configuration was last updated.
- user
Message 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
Package Details
- Repository
- cockroach pulumiverse/pulumi-cockroach
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cockroach
Terraform Provider.