authentik 2025.2.0, Mar 24 25

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

authentik.EventRule

Explore with Pulumi AI

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

Create EventRule Resource

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

Constructor syntax

new EventRule(name: string, args: EventRuleArgs, opts?: CustomResourceOptions);

@overload
def EventRule(resource_name: str,
              args: EventRuleArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def EventRule(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              transports: Optional[Sequence[str]] = None,
              event_rule_id: Optional[str] = None,
              group: Optional[str] = None,
              name: Optional[str] = None,
              severity: Optional[str] = None,
              webhook_mapping: Optional[str] = None)

func NewEventRule(ctx *Context, name string, args EventRuleArgs, opts ...ResourceOption) (*EventRule, error)

public EventRule(string name, EventRuleArgs args, CustomResourceOptions? opts = null)

public EventRule(String name, EventRuleArgs args)
public EventRule(String name, EventRuleArgs args, CustomResourceOptions options)

type: authentik:EventRule
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 EventRuleArgs: 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 EventRuleArgs: 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 EventRuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args EventRuleArgs: 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 eventRuleResource = new Authentik.EventRule("eventRuleResource", new()
{
    Transports = new[]
    {
        "string",
    },
    EventRuleId = "string",
    Group = "string",
    Name = "string",
    Severity = "string",
    WebhookMapping = "string",
});

example, err := authentik.NewEventRule(ctx, "eventRuleResource", &authentik.EventRuleArgs{
	Transports: pulumi.StringArray{
		pulumi.String("string"),
	},
	EventRuleId:    pulumi.String("string"),
	Group:          pulumi.String("string"),
	Name:           pulumi.String("string"),
	Severity:       pulumi.String("string"),
	WebhookMapping: pulumi.String("string"),
})

var eventRuleResource = new EventRule("eventRuleResource", EventRuleArgs.builder()
    .transports("string")
    .eventRuleId("string")
    .group("string")
    .name("string")
    .severity("string")
    .webhookMapping("string")
    .build());

event_rule_resource = authentik.EventRule("eventRuleResource",
    transports=["string"],
    event_rule_id="string",
    group="string",
    name="string",
    severity="string",
    webhook_mapping="string")

const eventRuleResource = new authentik.EventRule("eventRuleResource", {
    transports: ["string"],
    eventRuleId: "string",
    group: "string",
    name: "string",
    severity: "string",
    webhookMapping: "string",
});

type: authentik:EventRule
properties:
    eventRuleId: string
    group: string
    name: string
    severity: string
    transports:
        - string
    webhookMapping: string

EventRule 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 EventRule resource accepts the following input properties:

Transports List<string>
EventRuleId string
Group string
Name string
Severity string: Allowed values: - notice - warning - alert Defaults to warning.
WebhookMapping string

Transports []string
EventRuleId string
Group string
Name string
Severity string: Allowed values: - notice - warning - alert Defaults to warning.
WebhookMapping string

transports List<String>
eventRuleId String
group String
name String
severity String: Allowed values: - notice - warning - alert Defaults to warning.
webhookMapping String

transports string[]
eventRuleId string
group string
name string
severity string: Allowed values: - notice - warning - alert Defaults to warning.
webhookMapping string

transports Sequence[str]
event_rule_id str
group str
name str
severity str: Allowed values: - notice - warning - alert Defaults to warning.
webhook_mapping str

transports List<String>
eventRuleId String
group String
name String
severity String: Allowed values: - notice - warning - alert Defaults to warning.
webhookMapping String

Outputs

All input properties are implicitly available as output properties. Additionally, the EventRule 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 string: The provider-assigned unique ID for this managed resource.

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

id String: The provider-assigned unique ID for this managed resource.

Look up Existing EventRule Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        event_rule_id: Optional[str] = None,
        group: Optional[str] = None,
        name: Optional[str] = None,
        severity: Optional[str] = None,
        transports: Optional[Sequence[str]] = None,
        webhook_mapping: Optional[str] = None) -> EventRule

func GetEventRule(ctx *Context, name string, id IDInput, state *EventRuleState, opts ...ResourceOption) (*EventRule, error)

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

public static EventRule get(String name, Output<String> id, EventRuleState state, CustomResourceOptions options)

resources:  _:    type: authentik:EventRule    get:      id: ${id}

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:

EventRuleId string
Group string
Name string
Severity string: Allowed values: - notice - warning - alert Defaults to warning.
Transports List<string>
WebhookMapping string

EventRuleId string
Group string
Name string
Severity string: Allowed values: - notice - warning - alert Defaults to warning.
Transports []string
WebhookMapping string

eventRuleId String
group String
name String
severity String: Allowed values: - notice - warning - alert Defaults to warning.
transports List<String>
webhookMapping String

eventRuleId string
group string
name string
severity string: Allowed values: - notice - warning - alert Defaults to warning.
transports string[]
webhookMapping string

event_rule_id str
group str
name str
severity str: Allowed values: - notice - warning - alert Defaults to warning.
transports Sequence[str]
webhook_mapping str

eventRuleId String
group String
name String
severity String: Allowed values: - notice - warning - alert Defaults to warning.
transports List<String>
webhookMapping String

Package Details

Repository: authentik goauthentik/terraform-provider-authentik
License
Notes: This Pulumi package is based on the authentik Terraform Provider.

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

authentik.EventRule

On this page

On this page

Create EventRule Resource

Constructor syntax

Parameters

Constructor example

EventRule Resource Properties

Inputs

Outputs

Look up Existing EventRule Resource

Package Details

On this page

On this page