Class RealmEvents

# keycloak..RealmEvents

Allows for managing Realm Events settings within Keycloak.

Example Usage

using Pulumi;
using Keycloak = Pulumi.Keycloak;

class MyStack : Stack
{
public MyStack()
{
    var realm = new Keycloak.Realm("realm", new Keycloak.RealmArgs
    {
        Realm = "test",
    });
    var realmEvents = new Keycloak.RealmEvents("realmEvents", new Keycloak.RealmEventsArgs
    {
        AdminEventsDetailsEnabled = true,
        AdminEventsEnabled = true,
        EnabledEventTypes = 
        {
            "LOGIN",
            "LOGOUT",
        },
        EventsEnabled = true,
        EventsExpiration = 3600,
        EventsListeners = 
        {
            "jboss-logging",
        },
        RealmId = realm.Id,
    });
}

}

Argument Reference

The following arguments are supported:

• realm_id - (Required) The name of the realm the event settings apply to.
• admin_events_enabled - (Optional) When true, admin events are saved to the database, making them available through the admin console. Defaults to false.
• admin_events_details_enabled - (Optional) When true, saved admin events will included detailed information for create/update requests. Defaults to false.
• events_enabled - (Optional) When true, events from enabled_event_types are saved to the database, making them available through the admin console. Defaults to false.
• events_expiration - (Optional) The amount of time in seconds events will be saved in the database. Defaults to 0 or never.
• enabled_event_types - (Optional) The event types that will be saved to the database. Omitting this field enables all event types. Defaults to [] or all event types.
• events_listeners - (Optional) The event listeners that events should be sent to. Defaults to [] or none. Note that new realms enable the jboss-logging listener by default, and this resource will remove that unless it is specified.

Inheritance

System.Object

Resource

CustomResource

RealmEvents

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Keycloak

Assembly: Pulumi.Keycloak.dll

Syntax

public class RealmEvents : CustomResource

Constructors

RealmEvents(String, RealmEventsArgs, CustomResourceOptions)

Create a RealmEvents resource with the given unique name, arguments, and options.

Declaration

public RealmEvents(string name, RealmEventsArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
RealmEventsArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AdminEventsDetailsEnabled

Declaration

public Output<bool?> AdminEventsDetailsEnabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

AdminEventsEnabled

Declaration

public Output<bool?> AdminEventsEnabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

EnabledEventTypes

Declaration

public Output<ImmutableArray<string>> EnabledEventTypes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

EventsEnabled

Declaration

public Output<bool?> EventsEnabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

EventsExpiration

Declaration

public Output<int?> EventsExpiration { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

EventsListeners

Declaration

public Output<ImmutableArray<string>> EventsListeners { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

RealmId

Declaration

public Output<string> RealmId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, RealmEventsState, CustomResourceOptions)

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

Declaration

public static RealmEvents Get(string name, Input<string> id, RealmEventsState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
RealmEventsState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
RealmEvents