avi 31.1.1, Apr 14 25

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.Alertemailconfig

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “Avi: avi.Alertemailconfig” sidebar_current: “docs-avi-resource-alertemailconfig” description: |- Creates and manages Avi AlertEmailConfig.

avi.Alertemailconfig

The AlertEmailConfig resource allows the creation and management of Avi AlertEmailConfig

Example Usage

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

const foo = new avi.Alertemailconfig("foo", {tenantRef: "/api/tenant/?name=admin"});

import pulumi
import pulumi_avi as avi

foo = avi.Alertemailconfig("foo", tenant_ref="/api/tenant/?name=admin")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.NewAlertemailconfig(ctx, "foo", &avi.AlertemailconfigArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var foo = new Avi.Alertemailconfig("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Alertemailconfig;
import com.pulumi.avi.AlertemailconfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foo = new Alertemailconfig("foo", AlertemailconfigArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}

resources:
  foo:
    type: avi:Alertemailconfig
    properties:
      tenantRef: /api/tenant/?name=admin

Create Alertemailconfig Resource

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

Constructor syntax

new Alertemailconfig(name: string, args: AlertemailconfigArgs, opts?: CustomResourceOptions);

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

@overload
def Alertemailconfig(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     to_emails: Optional[str] = None,
                     alertemailconfig_id: Optional[str] = None,
                     cc_emails: Optional[str] = None,
                     configpb_attributes: Optional[Sequence[AlertemailconfigConfigpbAttributeArgs]] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None,
                     tenant_ref: Optional[str] = None,
                     uuid: Optional[str] = None)

func NewAlertemailconfig(ctx *Context, name string, args AlertemailconfigArgs, opts ...ResourceOption) (*Alertemailconfig, error)

public Alertemailconfig(string name, AlertemailconfigArgs args, CustomResourceOptions? opts = null)

public Alertemailconfig(String name, AlertemailconfigArgs args)
public Alertemailconfig(String name, AlertemailconfigArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args AlertemailconfigArgs: 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 alertemailconfigResource = new Avi.Alertemailconfig("alertemailconfigResource", new()
{
    ToEmails = "string",
    AlertemailconfigId = "string",
    CcEmails = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.AlertemailconfigConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    Description = "string",
    Name = "string",
    TenantRef = "string",
    Uuid = "string",
});

example, err := avi.NewAlertemailconfig(ctx, "alertemailconfigResource", &avi.AlertemailconfigArgs{
	ToEmails:           pulumi.String("string"),
	AlertemailconfigId: pulumi.String("string"),
	CcEmails:           pulumi.String("string"),
	ConfigpbAttributes: avi.AlertemailconfigConfigpbAttributeArray{
		&avi.AlertemailconfigConfigpbAttributeArgs{
			Version: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	TenantRef:   pulumi.String("string"),
	Uuid:        pulumi.String("string"),
})

var alertemailconfigResource = new Alertemailconfig("alertemailconfigResource", AlertemailconfigArgs.builder()
    .toEmails("string")
    .alertemailconfigId("string")
    .ccEmails("string")
    .configpbAttributes(AlertemailconfigConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .description("string")
    .name("string")
    .tenantRef("string")
    .uuid("string")
    .build());

alertemailconfig_resource = avi.Alertemailconfig("alertemailconfigResource",
    to_emails="string",
    alertemailconfig_id="string",
    cc_emails="string",
    configpb_attributes=[{
        "version": "string",
    }],
    description="string",
    name="string",
    tenant_ref="string",
    uuid="string")

const alertemailconfigResource = new avi.Alertemailconfig("alertemailconfigResource", {
    toEmails: "string",
    alertemailconfigId: "string",
    ccEmails: "string",
    configpbAttributes: [{
        version: "string",
    }],
    description: "string",
    name: "string",
    tenantRef: "string",
    uuid: "string",
});

type: avi:Alertemailconfig
properties:
    alertemailconfigId: string
    ccEmails: string
    configpbAttributes:
        - version: string
    description: string
    name: string
    tenantRef: string
    toEmails: string
    uuid: string

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

ToEmails string: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
AlertemailconfigId string
CcEmails string: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<AlertemailconfigConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

ToEmails string: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
AlertemailconfigId string
CcEmails string: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []AlertemailconfigConfigpbAttributeArgs: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

toEmails String: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertemailconfigId String
ccEmails String: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<AlertemailconfigConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

toEmails string: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertemailconfigId string
ccEmails string: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes AlertemailconfigConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

to_emails str: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertemailconfig_id str
cc_emails str: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[AlertemailconfigConfigpbAttributeArgs]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

toEmails String: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertemailconfigId String
ccEmails String: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alertemailconfig_id: Optional[str] = None,
        cc_emails: Optional[str] = None,
        configpb_attributes: Optional[Sequence[AlertemailconfigConfigpbAttributeArgs]] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        to_emails: Optional[str] = None,
        uuid: Optional[str] = None) -> Alertemailconfig

func GetAlertemailconfig(ctx *Context, name string, id IDInput, state *AlertemailconfigState, opts ...ResourceOption) (*Alertemailconfig, error)

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

public static Alertemailconfig get(String name, Output<String> id, AlertemailconfigState state, CustomResourceOptions options)

resources:  _:    type: avi:Alertemailconfig    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:

AlertemailconfigId string
CcEmails string: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<AlertemailconfigConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ToEmails string: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

AlertemailconfigId string
CcEmails string: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []AlertemailconfigConfigpbAttributeArgs: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ToEmails string: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

alertemailconfigId String
ccEmails String: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<AlertemailconfigConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
toEmails String: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

alertemailconfigId string
ccEmails string: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes AlertemailconfigConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
toEmails string: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

alertemailconfig_id str
cc_emails str: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[AlertemailconfigConfigpbAttributeArgs]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
to_emails str: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

alertemailconfigId String
ccEmails String: Alerts are copied to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: A user-friendly name of the email notification service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
toEmails String: Alerts are sent to the comma separated list of email recipients. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.