Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akeyless Provider
  3. API Docs
  4. EventForwarderEmail
akeyless 1.10.0 published on Sunday, Jun 8, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

akeyless.EventForwarderEmail

Explore with Pulumi AI

akeyless logo
akeyless 1.10.0 published on Sunday, Jun 8, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

    Event Forwarder Email resource

    Create EventForwarderEmail Resource

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

    Constructor syntax

    new EventForwarderEmail(name: string, args?: EventForwarderEmailArgs, opts?: CustomResourceOptions);
    @overload
def EventForwarderEmail(resource_name: str,
                        args: Optional[EventForwarderEmailArgs] = None,
                        opts: Optional[ResourceOptions] = None)

@overload
def EventForwarderEmail(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        auth_methods_event_source_locations: Optional[Sequence[str]] = None,
                        description: Optional[str] = None,
                        email_to: Optional[str] = None,
                        event_forwarder_email_id: Optional[str] = None,
                        event_types: Optional[Sequence[str]] = None,
                        every: Optional[str] = None,
                        gateways_event_source_locations: Optional[Sequence[str]] = None,
                        include_error: Optional[str] = None,
                        items_event_source_locations: Optional[Sequence[str]] = None,
                        key: Optional[str] = None,
                        name: Optional[str] = None,
                        override_url: Optional[str] = None,
                        runner_type: Optional[str] = None,
                        targets_event_source_locations: Optional[Sequence[str]] = None)
    func NewEventForwarderEmail(ctx *Context, name string, args *EventForwarderEmailArgs, opts ...ResourceOption) (*EventForwarderEmail, error)
    public EventForwarderEmail(string name, EventForwarderEmailArgs? args = null, CustomResourceOptions? opts = null)
    public EventForwarderEmail(String name, EventForwarderEmailArgs args)
public EventForwarderEmail(String name, EventForwarderEmailArgs args, CustomResourceOptions options)

    type: akeyless:EventForwarderEmail
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 EventForwarderEmailArgs
    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 EventForwarderEmailArgs
    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 EventForwarderEmailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EventForwarderEmailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EventForwarderEmailArgs
    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 eventForwarderEmailResource = new Akeyless.EventForwarderEmail("eventForwarderEmailResource", new()
{
    AuthMethodsEventSourceLocations = new[]
    {
        "string",
    },
    Description = "string",
    EmailTo = "string",
    EventForwarderEmailId = "string",
    EventTypes = new[]
    {
        "string",
    },
    Every = "string",
    GatewaysEventSourceLocations = new[]
    {
        "string",
    },
    IncludeError = "string",
    ItemsEventSourceLocations = new[]
    {
        "string",
    },
    Key = "string",
    Name = "string",
    OverrideUrl = "string",
    RunnerType = "string",
    TargetsEventSourceLocations = new[]
    {
        "string",
    },
});

    example, err := akeyless.NewEventForwarderEmail(ctx, "eventForwarderEmailResource", &akeyless.EventForwarderEmailArgs{
	AuthMethodsEventSourceLocations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:           pulumi.String("string"),
	EmailTo:               pulumi.String("string"),
	EventForwarderEmailId: pulumi.String("string"),
	EventTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Every: pulumi.String("string"),
	GatewaysEventSourceLocations: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncludeError: pulumi.String("string"),
	ItemsEventSourceLocations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Key:         pulumi.String("string"),
	Name:        pulumi.String("string"),
	OverrideUrl: pulumi.String("string"),
	RunnerType:  pulumi.String("string"),
	TargetsEventSourceLocations: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var eventForwarderEmailResource = new EventForwarderEmail("eventForwarderEmailResource", EventForwarderEmailArgs.builder()
    .authMethodsEventSourceLocations("string")
    .description("string")
    .emailTo("string")
    .eventForwarderEmailId("string")
    .eventTypes("string")
    .every("string")
    .gatewaysEventSourceLocations("string")
    .includeError("string")
    .itemsEventSourceLocations("string")
    .key("string")
    .name("string")
    .overrideUrl("string")
    .runnerType("string")
    .targetsEventSourceLocations("string")
    .build());

    event_forwarder_email_resource = akeyless.EventForwarderEmail("eventForwarderEmailResource",
    auth_methods_event_source_locations=["string"],
    description="string",
    email_to="string",
    event_forwarder_email_id="string",
    event_types=["string"],
    every="string",
    gateways_event_source_locations=["string"],
    include_error="string",
    items_event_source_locations=["string"],
    key="string",
    name="string",
    override_url="string",
    runner_type="string",
    targets_event_source_locations=["string"])

    const eventForwarderEmailResource = new akeyless.EventForwarderEmail("eventForwarderEmailResource", {
    authMethodsEventSourceLocations: ["string"],
    description: "string",
    emailTo: "string",
    eventForwarderEmailId: "string",
    eventTypes: ["string"],
    every: "string",
    gatewaysEventSourceLocations: ["string"],
    includeError: "string",
    itemsEventSourceLocations: ["string"],
    key: "string",
    name: "string",
    overrideUrl: "string",
    runnerType: "string",
    targetsEventSourceLocations: ["string"],
});

    type: akeyless:EventForwarderEmail
properties:
    authMethodsEventSourceLocations:
        - string
    description: string
    emailTo: string
    eventForwarderEmailId: string
    eventTypes:
        - string
    every: string
    gatewaysEventSourceLocations:
        - string
    includeError: string
    itemsEventSourceLocations:
        - string
    key: string
    name: string
    overrideUrl: string
    runnerType: string
    targetsEventSourceLocations:
        - string

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

    AuthMethodsEventSourceLocations List<string>
    Auth Methods event sources to forward events about, for example: /abc/*
    Description string
    Description of the object
    EmailTo string
    A comma seperated list of email addresses to send event to
    EventForwarderEmailId string
    The ID of this resource.
    EventTypes List<string>
    A comma-separated list of types of events to notify about
    Every string
    Rate of periodic runner repetition in hours
    GatewaysEventSourceLocations List<string>
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    IncludeError string
    Set this option to include event errors details [true/false]
    ItemsEventSourceLocations List<string>
    Items event sources to forward events about, for example: /abc/*
    Key string
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    Name string
    Event Forwarder name
    OverrideUrl string
    Override Akeyless default URL with your Gateway url (port 18888)
    RunnerType string
    Event Forwarder runner type [immediate/periodic]
    TargetsEventSourceLocations List<string>
    Targets event sources to forward events about, for example: /abc/*
    AuthMethodsEventSourceLocations []string
    Auth Methods event sources to forward events about, for example: /abc/*
    Description string
    Description of the object
    EmailTo string
    A comma seperated list of email addresses to send event to
    EventForwarderEmailId string
    The ID of this resource.
    EventTypes []string
    A comma-separated list of types of events to notify about
    Every string
    Rate of periodic runner repetition in hours
    GatewaysEventSourceLocations []string
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    IncludeError string
    Set this option to include event errors details [true/false]
    ItemsEventSourceLocations []string
    Items event sources to forward events about, for example: /abc/*
    Key string
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    Name string
    Event Forwarder name
    OverrideUrl string
    Override Akeyless default URL with your Gateway url (port 18888)
    RunnerType string
    Event Forwarder runner type [immediate/periodic]
    TargetsEventSourceLocations []string
    Targets event sources to forward events about, for example: /abc/*
    authMethodsEventSourceLocations List<String>
    Auth Methods event sources to forward events about, for example: /abc/*
    description String
    Description of the object
    emailTo String
    A comma seperated list of email addresses to send event to
    eventForwarderEmailId String
    The ID of this resource.
    eventTypes List<String>
    A comma-separated list of types of events to notify about
    every String
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations List<String>
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    includeError String
    Set this option to include event errors details [true/false]
    itemsEventSourceLocations List<String>
    Items event sources to forward events about, for example: /abc/*
    key String
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    name String
    Event Forwarder name
    overrideUrl String
    Override Akeyless default URL with your Gateway url (port 18888)
    runnerType String
    Event Forwarder runner type [immediate/periodic]
    targetsEventSourceLocations List<String>
    Targets event sources to forward events about, for example: /abc/*
    authMethodsEventSourceLocations string[]
    Auth Methods event sources to forward events about, for example: /abc/*
    description string
    Description of the object
    emailTo string
    A comma seperated list of email addresses to send event to
    eventForwarderEmailId string
    The ID of this resource.
    eventTypes string[]
    A comma-separated list of types of events to notify about
    every string
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations string[]
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    includeError string
    Set this option to include event errors details [true/false]
    itemsEventSourceLocations string[]
    Items event sources to forward events about, for example: /abc/*
    key string
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    name string
    Event Forwarder name
    overrideUrl string
    Override Akeyless default URL with your Gateway url (port 18888)
    runnerType string
    Event Forwarder runner type [immediate/periodic]
    targetsEventSourceLocations string[]
    Targets event sources to forward events about, for example: /abc/*
    auth_methods_event_source_locations Sequence[str]
    Auth Methods event sources to forward events about, for example: /abc/*
    description str
    Description of the object
    email_to str
    A comma seperated list of email addresses to send event to
    event_forwarder_email_id str
    The ID of this resource.
    event_types Sequence[str]
    A comma-separated list of types of events to notify about
    every str
    Rate of periodic runner repetition in hours
    gateways_event_source_locations Sequence[str]
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    include_error str
    Set this option to include event errors details [true/false]
    items_event_source_locations Sequence[str]
    Items event sources to forward events about, for example: /abc/*
    key str
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    name str
    Event Forwarder name
    override_url str
    Override Akeyless default URL with your Gateway url (port 18888)
    runner_type str
    Event Forwarder runner type [immediate/periodic]
    targets_event_source_locations Sequence[str]
    Targets event sources to forward events about, for example: /abc/*
    authMethodsEventSourceLocations List<String>
    Auth Methods event sources to forward events about, for example: /abc/*
    description String
    Description of the object
    emailTo String
    A comma seperated list of email addresses to send event to
    eventForwarderEmailId String
    The ID of this resource.
    eventTypes List<String>
    A comma-separated list of types of events to notify about
    every String
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations List<String>
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    includeError String
    Set this option to include event errors details [true/false]
    itemsEventSourceLocations List<String>
    Items event sources to forward events about, for example: /abc/*
    key String
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    name String
    Event Forwarder name
    overrideUrl String
    Override Akeyless default URL with your Gateway url (port 18888)
    runnerType String
    Event Forwarder runner type [immediate/periodic]
    targetsEventSourceLocations List<String>
    Targets event sources to forward events about, for example: /abc/*

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EventForwarderEmail 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 EventForwarderEmail Resource

    Get an existing EventForwarderEmail 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?: EventForwarderEmailState, opts?: CustomResourceOptions): EventForwarderEmail
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_methods_event_source_locations: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        email_to: Optional[str] = None,
        event_forwarder_email_id: Optional[str] = None,
        event_types: Optional[Sequence[str]] = None,
        every: Optional[str] = None,
        gateways_event_source_locations: Optional[Sequence[str]] = None,
        include_error: Optional[str] = None,
        items_event_source_locations: Optional[Sequence[str]] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        override_url: Optional[str] = None,
        runner_type: Optional[str] = None,
        targets_event_source_locations: Optional[Sequence[str]] = None) -> EventForwarderEmail
    func GetEventForwarderEmail(ctx *Context, name string, id IDInput, state *EventForwarderEmailState, opts ...ResourceOption) (*EventForwarderEmail, error)
    public static EventForwarderEmail Get(string name, Input<string> id, EventForwarderEmailState? state, CustomResourceOptions? opts = null)
    public static EventForwarderEmail get(String name, Output<String> id, EventForwarderEmailState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:EventForwarderEmail    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:
    AuthMethodsEventSourceLocations List<string>
    Auth Methods event sources to forward events about, for example: /abc/*
    Description string
    Description of the object
    EmailTo string
    A comma seperated list of email addresses to send event to
    EventForwarderEmailId string
    The ID of this resource.
    EventTypes List<string>
    A comma-separated list of types of events to notify about
    Every string
    Rate of periodic runner repetition in hours
    GatewaysEventSourceLocations List<string>
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    IncludeError string
    Set this option to include event errors details [true/false]
    ItemsEventSourceLocations List<string>
    Items event sources to forward events about, for example: /abc/*
    Key string
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    Name string
    Event Forwarder name
    OverrideUrl string
    Override Akeyless default URL with your Gateway url (port 18888)
    RunnerType string
    Event Forwarder runner type [immediate/periodic]
    TargetsEventSourceLocations List<string>
    Targets event sources to forward events about, for example: /abc/*
    AuthMethodsEventSourceLocations []string
    Auth Methods event sources to forward events about, for example: /abc/*
    Description string
    Description of the object
    EmailTo string
    A comma seperated list of email addresses to send event to
    EventForwarderEmailId string
    The ID of this resource.
    EventTypes []string
    A comma-separated list of types of events to notify about
    Every string
    Rate of periodic runner repetition in hours
    GatewaysEventSourceLocations []string
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    IncludeError string
    Set this option to include event errors details [true/false]
    ItemsEventSourceLocations []string
    Items event sources to forward events about, for example: /abc/*
    Key string
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    Name string
    Event Forwarder name
    OverrideUrl string
    Override Akeyless default URL with your Gateway url (port 18888)
    RunnerType string
    Event Forwarder runner type [immediate/periodic]
    TargetsEventSourceLocations []string
    Targets event sources to forward events about, for example: /abc/*
    authMethodsEventSourceLocations List<String>
    Auth Methods event sources to forward events about, for example: /abc/*
    description String
    Description of the object
    emailTo String
    A comma seperated list of email addresses to send event to
    eventForwarderEmailId String
    The ID of this resource.
    eventTypes List<String>
    A comma-separated list of types of events to notify about
    every String
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations List<String>
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    includeError String
    Set this option to include event errors details [true/false]
    itemsEventSourceLocations List<String>
    Items event sources to forward events about, for example: /abc/*
    key String
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    name String
    Event Forwarder name
    overrideUrl String
    Override Akeyless default URL with your Gateway url (port 18888)
    runnerType String
    Event Forwarder runner type [immediate/periodic]
    targetsEventSourceLocations List<String>
    Targets event sources to forward events about, for example: /abc/*
    authMethodsEventSourceLocations string[]
    Auth Methods event sources to forward events about, for example: /abc/*
    description string
    Description of the object
    emailTo string
    A comma seperated list of email addresses to send event to
    eventForwarderEmailId string
    The ID of this resource.
    eventTypes string[]
    A comma-separated list of types of events to notify about
    every string
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations string[]
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    includeError string
    Set this option to include event errors details [true/false]
    itemsEventSourceLocations string[]
    Items event sources to forward events about, for example: /abc/*
    key string
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    name string
    Event Forwarder name
    overrideUrl string
    Override Akeyless default URL with your Gateway url (port 18888)
    runnerType string
    Event Forwarder runner type [immediate/periodic]
    targetsEventSourceLocations string[]
    Targets event sources to forward events about, for example: /abc/*
    auth_methods_event_source_locations Sequence[str]
    Auth Methods event sources to forward events about, for example: /abc/*
    description str
    Description of the object
    email_to str
    A comma seperated list of email addresses to send event to
    event_forwarder_email_id str
    The ID of this resource.
    event_types Sequence[str]
    A comma-separated list of types of events to notify about
    every str
    Rate of periodic runner repetition in hours
    gateways_event_source_locations Sequence[str]
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    include_error str
    Set this option to include event errors details [true/false]
    items_event_source_locations Sequence[str]
    Items event sources to forward events about, for example: /abc/*
    key str
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    name str
    Event Forwarder name
    override_url str
    Override Akeyless default URL with your Gateway url (port 18888)
    runner_type str
    Event Forwarder runner type [immediate/periodic]
    targets_event_source_locations Sequence[str]
    Targets event sources to forward events about, for example: /abc/*
    authMethodsEventSourceLocations List<String>
    Auth Methods event sources to forward events about, for example: /abc/*
    description String
    Description of the object
    emailTo String
    A comma seperated list of email addresses to send event to
    eventForwarderEmailId String
    The ID of this resource.
    eventTypes List<String>
    A comma-separated list of types of events to notify about
    every String
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations List<String>
    Gateways event sources to forward events about,for example the relevant Gateways cluster urls,: http://localhost:8000.
    includeError String
    Set this option to include event errors details [true/false]
    itemsEventSourceLocations List<String>
    Items event sources to forward events about, for example: /abc/*
    key String
    Key name. The key will be used to encrypt the Event Forwarder secret value. If key name is not specified, the account default protection key is used
    name String
    Event Forwarder name
    overrideUrl String
    Override Akeyless default URL with your Gateway url (port 18888)
    runnerType String
    Event Forwarder runner type [immediate/periodic]
    targetsEventSourceLocations List<String>
    Targets event sources to forward events about, for example: /abc/*

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.10.0 published on Sunday, Jun 8, 2025 by akeyless-community
    akeyless-community/terraform-provider-akeyless