Auditing

mongodbatlas..Auditing provides an Auditing resource. This allows auditing to be created.

Example Usage

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var test = new Mongodbatlas.Auditing("test", new Mongodbatlas.AuditingArgs
        {
            AuditAuthorizationSuccess = false,
            AuditFilter = "{ 'atype': 'authenticate', 'param': {   'user': 'auditAdmin',   'db': 'admin',   'mechanism': 'SCRAM-SHA-1' }}",
            Enabled = true,
            ProjectId = "<project-id>",
        });
    }

}

Coming soon!

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Auditing("test",
    audit_authorization_success=False,
    audit_filter="{ 'atype': 'authenticate', 'param': {   'user': 'auditAdmin',   'db': 'admin',   'mechanism': 'SCRAM-SHA-1' }}",
    enabled=True,
    project_id="<project-id>")

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.Auditing("test", {
    auditAuthorizationSuccess: false,
    auditFilter: "{ 'atype': 'authenticate', 'param': {   'user': 'auditAdmin',   'db': 'admin',   'mechanism': 'SCRAM-SHA-1' }}",
    enabled: true,
    projectId: "<project-id>",
});

Create a Auditing Resource

new Auditing(name: string, args: AuditingArgs, opts?: CustomResourceOptions);

def Auditing(resource_name, opts=None, audit_authorization_success=None, audit_filter=None, enabled=None, project_id=None, __props__=None);

func NewAuditing(ctx *Context, name string, args AuditingArgs, opts ...ResourceOption) (*Auditing, error)

public Auditing(string name, AuditingArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args AuditingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AuditingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AuditingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Auditing Resource Properties

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

Inputs

The Auditing resource accepts the following input properties:

ProjectId string: The unique ID for the project to configure auditing.
AuditAuthorizationSuccess bool: JSON-formatted audit filter used by the project
AuditFilter string: Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess
Enabled bool: Denotes whether or not the project associated with the {project_id} has database auditing enabled.

ProjectId string: The unique ID for the project to configure auditing.
AuditAuthorizationSuccess bool: JSON-formatted audit filter used by the project
AuditFilter string: Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess
Enabled bool: Denotes whether or not the project associated with the {project_id} has database auditing enabled.

projectId string: The unique ID for the project to configure auditing.
auditAuthorizationSuccess boolean: JSON-formatted audit filter used by the project
auditFilter string: Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess
enabled boolean: Denotes whether or not the project associated with the {project_id} has database auditing enabled.

project_id str: The unique ID for the project to configure auditing.
audit_authorization_success bool: JSON-formatted audit filter used by the project
audit_filter str: Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess
enabled bool: Denotes whether or not the project associated with the {project_id} has database auditing enabled.

Outputs

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

ConfigurationType string: Denotes the configuration method for the audit filter. Possible values are: * NONE - auditing not configured for the project. * FILTER_BUILDER - auditing configured via Atlas UI filter builder. * FILTER_JSON - auditing configured via Atlas custom filter or API.
Id string: The provider-assigned unique ID for this managed resource.

ConfigurationType string: Denotes the configuration method for the audit filter. Possible values are: * NONE - auditing not configured for the project. * FILTER_BUILDER - auditing configured via Atlas UI filter builder. * FILTER_JSON - auditing configured via Atlas custom filter or API.
Id string: The provider-assigned unique ID for this managed resource.

configurationType string: Denotes the configuration method for the audit filter. Possible values are: * NONE - auditing not configured for the project. * FILTER_BUILDER - auditing configured via Atlas UI filter builder. * FILTER_JSON - auditing configured via Atlas custom filter or API.
id string: The provider-assigned unique ID for this managed resource.

configuration_type str: Denotes the configuration method for the audit filter. Possible values are: * NONE - auditing not configured for the project. * FILTER_BUILDER - auditing configured via Atlas UI filter builder. * FILTER_JSON - auditing configured via Atlas custom filter or API.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Auditing Resource

Get an existing Auditing 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?: AuditingState, opts?: CustomResourceOptions): Auditing

static get(resource_name, id, opts=None, audit_authorization_success=None, audit_filter=None, configuration_type=None, enabled=None, project_id=None, __props__=None);

func GetAuditing(ctx *Context, name string, id IDInput, state *AuditingState, opts ...ResourceOption) (*Auditing, error)

public static Auditing Get(string name, Input<string> id, AuditingState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AuditAuthorizationSuccess bool: JSON-formatted audit filter used by the project
AuditFilter string: Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess
ConfigurationType string: Denotes the configuration method for the audit filter. Possible values are: * NONE - auditing not configured for the project. * FILTER_BUILDER - auditing configured via Atlas UI filter builder. * FILTER_JSON - auditing configured via Atlas custom filter or API.
Enabled bool: Denotes whether or not the project associated with the {project_id} has database auditing enabled.
ProjectId string: The unique ID for the project to configure auditing.

AuditAuthorizationSuccess bool: JSON-formatted audit filter used by the project
AuditFilter string: Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess
ConfigurationType string: Denotes the configuration method for the audit filter. Possible values are: * NONE - auditing not configured for the project. * FILTER_BUILDER - auditing configured via Atlas UI filter builder. * FILTER_JSON - auditing configured via Atlas custom filter or API.
Enabled bool: Denotes whether or not the project associated with the {project_id} has database auditing enabled.
ProjectId string: The unique ID for the project to configure auditing.

auditAuthorizationSuccess boolean: JSON-formatted audit filter used by the project
auditFilter string: Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess
configurationType string: Denotes the configuration method for the audit filter. Possible values are: * NONE - auditing not configured for the project. * FILTER_BUILDER - auditing configured via Atlas UI filter builder. * FILTER_JSON - auditing configured via Atlas custom filter or API.
enabled boolean: Denotes whether or not the project associated with the {project_id} has database auditing enabled.
projectId string: The unique ID for the project to configure auditing.

audit_authorization_success bool: JSON-formatted audit filter used by the project
audit_filter str: Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess
configuration_type str: Denotes the configuration method for the audit filter. Possible values are: * NONE - auditing not configured for the project. * FILTER_BUILDER - auditing configured via Atlas UI filter builder. * FILTER_JSON - auditing configured via Atlas custom filter or API.
enabled bool: Denotes whether or not the project associated with the {project_id} has database auditing enabled.
project_id str: The unique ID for the project to configure auditing.

Package Details

Repository: https://github.com/pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud