Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

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 = "my-realm",
            Enabled = true,
        });
        var realmEvents = new Keycloak.RealmEvents("realmEvents", new Keycloak.RealmEventsArgs
        {
            RealmId = realm.Id,
            EventsEnabled = true,
            EventsExpiration = 3600,
            AdminEventsEnabled = true,
            AdminEventsDetailsEnabled = true,
            EnabledEventTypes = 
            {
                "LOGIN",
                "LOGOUT",
            },
            EventsListeners = 
            {
                "jboss-logging",
            },
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-keycloak/sdk/v3/go/keycloak"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        realm, err := keycloak.NewRealm(ctx, "realm", &keycloak.RealmArgs{
            Realm:   pulumi.String("my-realm"),
            Enabled: pulumi.Bool(true),
        })
        if err != nil {
            return err
        }
        _, err = keycloak.NewRealmEvents(ctx, "realmEvents", &keycloak.RealmEventsArgs{
            RealmId:                   realm.ID(),
            EventsEnabled:             pulumi.Bool(true),
            EventsExpiration:          pulumi.Int(3600),
            AdminEventsEnabled:        pulumi.Bool(true),
            AdminEventsDetailsEnabled: pulumi.Bool(true),
            EnabledEventTypes: pulumi.StringArray{
                pulumi.String("LOGIN"),
                pulumi.String("LOGOUT"),
            },
            EventsListeners: pulumi.StringArray{
                pulumi.String("jboss-logging"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
realm_events = keycloak.RealmEvents("realmEvents",
    realm_id=realm.id,
    events_enabled=True,
    events_expiration=3600,
    admin_events_enabled=True,
    admin_events_details_enabled=True,
    enabled_event_types=[
        "LOGIN",
        "LOGOUT",
    ],
    events_listeners=["jboss-logging"])
import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";

const realm = new keycloak.Realm("realm", {
    realm: "my-realm",
    enabled: true,
});
const realmEvents = new keycloak.RealmEvents("realmEvents", {
    realmId: realm.id,
    eventsEnabled: true,
    eventsExpiration: 3600,
    adminEventsEnabled: true,
    adminEventsDetailsEnabled: true,
    enabledEventTypes: [
        "LOGIN",
        "LOGOUT",
    ],
    eventsListeners: ["jboss-logging"],
});

Create a RealmEvents Resource

new RealmEvents(name: string, args: RealmEventsArgs, opts?: CustomResourceOptions);
def RealmEvents(resource_name: str, opts: Optional[ResourceOptions] = None, admin_events_details_enabled: Optional[bool] = None, admin_events_enabled: Optional[bool] = None, enabled_event_types: Optional[Sequence[str]] = None, events_enabled: Optional[bool] = None, events_expiration: Optional[int] = None, events_listeners: Optional[Sequence[str]] = None, realm_id: Optional[str] = None)
func NewRealmEvents(ctx *Context, name string, args RealmEventsArgs, opts ...ResourceOption) (*RealmEvents, error)
public RealmEvents(string name, RealmEventsArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args RealmEventsArgs
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 RealmEventsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RealmEventsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

RealmEvents Resource Properties

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

Inputs

The RealmEvents resource accepts the following input properties:

RealmId string

The name of the realm the event settings apply to.

AdminEventsDetailsEnabled bool

When true, saved admin events will included detailed information for create/update requests. Defaults to false.

AdminEventsEnabled bool

When true, admin events are saved to the database, making them available through the admin console. Defaults to false.

EnabledEventTypes List<string>

The event types that will be saved to the database. Omitting this field enables all event types. Defaults to [] or all event types.

EventsEnabled bool

When true, events from enabled_event_types are saved to the database, making them available through the admin console. Defaults to false.

EventsExpiration int

The amount of time in seconds events will be saved in the database. Defaults to 0 or never.

EventsListeners List<string>

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.

RealmId string

The name of the realm the event settings apply to.

AdminEventsDetailsEnabled bool

When true, saved admin events will included detailed information for create/update requests. Defaults to false.

AdminEventsEnabled bool

When true, admin events are saved to the database, making them available through the admin console. Defaults to false.

EnabledEventTypes []string

The event types that will be saved to the database. Omitting this field enables all event types. Defaults to [] or all event types.

EventsEnabled bool

When true, events from enabled_event_types are saved to the database, making them available through the admin console. Defaults to false.

EventsExpiration int

The amount of time in seconds events will be saved in the database. Defaults to 0 or never.

EventsListeners []string

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.

realmId string

The name of the realm the event settings apply to.

adminEventsDetailsEnabled boolean

When true, saved admin events will included detailed information for create/update requests. Defaults to false.

adminEventsEnabled boolean

When true, admin events are saved to the database, making them available through the admin console. Defaults to false.

enabledEventTypes string[]

The event types that will be saved to the database. Omitting this field enables all event types. Defaults to [] or all event types.

eventsEnabled boolean

When true, events from enabled_event_types are saved to the database, making them available through the admin console. Defaults to false.

eventsExpiration number

The amount of time in seconds events will be saved in the database. Defaults to 0 or never.

eventsListeners string[]

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.

realm_id str

The name of the realm the event settings apply to.

admin_events_details_enabled bool

When true, saved admin events will included detailed information for create/update requests. Defaults to false.

admin_events_enabled bool

When true, admin events are saved to the database, making them available through the admin console. Defaults to false.

enabled_event_types Sequence[str]

The event types that will be saved to the database. Omitting this field enables all event types. Defaults to [] or all event types.

events_enabled bool

When true, events from enabled_event_types are saved to the database, making them available through the admin console. Defaults to false.

events_expiration int

The amount of time in seconds events will be saved in the database. Defaults to 0 or never.

events_listeners Sequence[str]

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.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing RealmEvents Resource

Get an existing RealmEvents 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?: RealmEventsState, opts?: CustomResourceOptions): RealmEvents
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, admin_events_details_enabled: Optional[bool] = None, admin_events_enabled: Optional[bool] = None, enabled_event_types: Optional[Sequence[str]] = None, events_enabled: Optional[bool] = None, events_expiration: Optional[int] = None, events_listeners: Optional[Sequence[str]] = None, realm_id: Optional[str] = None) -> RealmEvents
func GetRealmEvents(ctx *Context, name string, id IDInput, state *RealmEventsState, opts ...ResourceOption) (*RealmEvents, error)
public static RealmEvents Get(string name, Input<string> id, RealmEventsState? 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:

AdminEventsDetailsEnabled bool

When true, saved admin events will included detailed information for create/update requests. Defaults to false.

AdminEventsEnabled bool

When true, admin events are saved to the database, making them available through the admin console. Defaults to false.

EnabledEventTypes List<string>

The event types that will be saved to the database. Omitting this field enables all event types. Defaults to [] or all event types.

EventsEnabled bool

When true, events from enabled_event_types are saved to the database, making them available through the admin console. Defaults to false.

EventsExpiration int

The amount of time in seconds events will be saved in the database. Defaults to 0 or never.

EventsListeners List<string>

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.

RealmId string

The name of the realm the event settings apply to.

AdminEventsDetailsEnabled bool

When true, saved admin events will included detailed information for create/update requests. Defaults to false.

AdminEventsEnabled bool

When true, admin events are saved to the database, making them available through the admin console. Defaults to false.

EnabledEventTypes []string

The event types that will be saved to the database. Omitting this field enables all event types. Defaults to [] or all event types.

EventsEnabled bool

When true, events from enabled_event_types are saved to the database, making them available through the admin console. Defaults to false.

EventsExpiration int

The amount of time in seconds events will be saved in the database. Defaults to 0 or never.

EventsListeners []string

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.

RealmId string

The name of the realm the event settings apply to.

adminEventsDetailsEnabled boolean

When true, saved admin events will included detailed information for create/update requests. Defaults to false.

adminEventsEnabled boolean

When true, admin events are saved to the database, making them available through the admin console. Defaults to false.

enabledEventTypes string[]

The event types that will be saved to the database. Omitting this field enables all event types. Defaults to [] or all event types.

eventsEnabled boolean

When true, events from enabled_event_types are saved to the database, making them available through the admin console. Defaults to false.

eventsExpiration number

The amount of time in seconds events will be saved in the database. Defaults to 0 or never.

eventsListeners string[]

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.

realmId string

The name of the realm the event settings apply to.

admin_events_details_enabled bool

When true, saved admin events will included detailed information for create/update requests. Defaults to false.

admin_events_enabled bool

When true, admin events are saved to the database, making them available through the admin console. Defaults to false.

enabled_event_types Sequence[str]

The event types that will be saved to the database. Omitting this field enables all event types. Defaults to [] or all event types.

events_enabled bool

When true, events from enabled_event_types are saved to the database, making them available through the admin console. Defaults to false.

events_expiration int

The amount of time in seconds events will be saved in the database. Defaults to 0 or never.

events_listeners Sequence[str]

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.

realm_id str

The name of the realm the event settings apply to.

Import

This resource currently does not support importing.

Package Details

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