Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Powerscale Provider
  3. API Docs
  4. ClusterEmail
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

powerscale.ClusterEmail

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

    This resource is used to manage the Cluster Email Settings entity of PowerScale Array. PowerScale Cluster Email Settings provide the ability to configure email settings on the cluster.We can Create, Update and Delete the Cluster Email Settings using this resource. We can also import existing Cluster Email Settings from PowerScale array. Note that, Cluster Email Settings is the native functionality of PowerScale. When creating the resource, we actually load Cluster Email Settings from PowerScale to the resource state.

    Example Usage

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

const test = new powerscale.ClusterEmail("test", {settings: {}});

    import pulumi
import pulumi_powerscale as powerscale

test = powerscale.ClusterEmail("test", settings={})

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := powerscale.NewClusterEmail(ctx, "test", &powerscale.ClusterEmailArgs{
			Settings: &powerscale.ClusterEmailSettingsArgs{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = new Powerscale.ClusterEmail("test", new()
    {
        Settings = null,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.ClusterEmail;
import com.pulumi.powerscale.ClusterEmailArgs;
import com.pulumi.powerscale.inputs.ClusterEmailSettingsArgs;
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 test = new ClusterEmail("test", ClusterEmailArgs.builder()
            .settings()
            .build());

    }
}

    resources:
  test:
    type: powerscale:ClusterEmail
    properties:
      settings: {}

    Create ClusterEmail Resource

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

    Constructor syntax

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

@overload
def ClusterEmail(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 settings: Optional[ClusterEmailSettingsArgs] = None)
    func NewClusterEmail(ctx *Context, name string, args ClusterEmailArgs, opts ...ResourceOption) (*ClusterEmail, error)
    public ClusterEmail(string name, ClusterEmailArgs args, CustomResourceOptions? opts = null)
    public ClusterEmail(String name, ClusterEmailArgs args)
public ClusterEmail(String name, ClusterEmailArgs args, CustomResourceOptions options)

    type: powerscale:ClusterEmail
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 ClusterEmailArgs
    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 ClusterEmailArgs
    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 ClusterEmailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterEmailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterEmailArgs
    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 clusterEmailResource = new Powerscale.ClusterEmail("clusterEmailResource", new()
{
    Settings = new Powerscale.Inputs.ClusterEmailSettingsArgs
    {
        BatchMode = "string",
        MailRelay = "string",
        MailSender = "string",
        MailSubject = "string",
        SmtpAuthPasswd = "string",
        SmtpAuthPasswdSet = false,
        SmtpAuthSecurity = "string",
        SmtpAuthUsername = "string",
        SmtpPort = 0,
        UseSmtpAuth = false,
        UserTemplate = "string",
    },
});

    example, err := powerscale.NewClusterEmail(ctx, "clusterEmailResource", &powerscale.ClusterEmailArgs{
	Settings: &powerscale.ClusterEmailSettingsArgs{
		BatchMode:         pulumi.String("string"),
		MailRelay:         pulumi.String("string"),
		MailSender:        pulumi.String("string"),
		MailSubject:       pulumi.String("string"),
		SmtpAuthPasswd:    pulumi.String("string"),
		SmtpAuthPasswdSet: pulumi.Bool(false),
		SmtpAuthSecurity:  pulumi.String("string"),
		SmtpAuthUsername:  pulumi.String("string"),
		SmtpPort:          pulumi.Float64(0),
		UseSmtpAuth:       pulumi.Bool(false),
		UserTemplate:      pulumi.String("string"),
	},
})

    var clusterEmailResource = new ClusterEmail("clusterEmailResource", ClusterEmailArgs.builder()
    .settings(ClusterEmailSettingsArgs.builder()
        .batchMode("string")
        .mailRelay("string")
        .mailSender("string")
        .mailSubject("string")
        .smtpAuthPasswd("string")
        .smtpAuthPasswdSet(false)
        .smtpAuthSecurity("string")
        .smtpAuthUsername("string")
        .smtpPort(0)
        .useSmtpAuth(false)
        .userTemplate("string")
        .build())
    .build());

    cluster_email_resource = powerscale.ClusterEmail("clusterEmailResource", settings={
    "batch_mode": "string",
    "mail_relay": "string",
    "mail_sender": "string",
    "mail_subject": "string",
    "smtp_auth_passwd": "string",
    "smtp_auth_passwd_set": False,
    "smtp_auth_security": "string",
    "smtp_auth_username": "string",
    "smtp_port": 0,
    "use_smtp_auth": False,
    "user_template": "string",
})

    const clusterEmailResource = new powerscale.ClusterEmail("clusterEmailResource", {settings: {
    batchMode: "string",
    mailRelay: "string",
    mailSender: "string",
    mailSubject: "string",
    smtpAuthPasswd: "string",
    smtpAuthPasswdSet: false,
    smtpAuthSecurity: "string",
    smtpAuthUsername: "string",
    smtpPort: 0,
    useSmtpAuth: false,
    userTemplate: "string",
}});

    type: powerscale:ClusterEmail
properties:
    settings:
        batchMode: string
        mailRelay: string
        mailSender: string
        mailSubject: string
        smtpAuthPasswd: string
        smtpAuthPasswdSet: false
        smtpAuthSecurity: string
        smtpAuthUsername: string
        smtpPort: 0
        useSmtpAuth: false
        userTemplate: string

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

    Settings ClusterEmailSettings
    Cluster email notification settings.
    Settings ClusterEmailSettingsArgs
    Cluster email notification settings.
    settings ClusterEmailSettings
    Cluster email notification settings.
    settings ClusterEmailSettings
    Cluster email notification settings.
    settings ClusterEmailSettingsArgs
    Cluster email notification settings.
    settings Property Map
    Cluster email notification settings.

    Outputs

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

    Get an existing ClusterEmail 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?: ClusterEmailState, opts?: CustomResourceOptions): ClusterEmail
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        settings: Optional[ClusterEmailSettingsArgs] = None) -> ClusterEmail
    func GetClusterEmail(ctx *Context, name string, id IDInput, state *ClusterEmailState, opts ...ResourceOption) (*ClusterEmail, error)
    public static ClusterEmail Get(string name, Input<string> id, ClusterEmailState? state, CustomResourceOptions? opts = null)
    public static ClusterEmail get(String name, Output<String> id, ClusterEmailState state, CustomResourceOptions options)
    resources:  _:    type: powerscale:ClusterEmail    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:
    Settings ClusterEmailSettings
    Cluster email notification settings.
    Settings ClusterEmailSettingsArgs
    Cluster email notification settings.
    settings ClusterEmailSettings
    Cluster email notification settings.
    settings ClusterEmailSettings
    Cluster email notification settings.
    settings ClusterEmailSettingsArgs
    Cluster email notification settings.
    settings Property Map
    Cluster email notification settings.

    Supporting Types

    ClusterEmailSettings, ClusterEmailSettingsArgs

    BatchMode string
    This setting determines how notifications will be batched together to be sent by email. 'none' means each notification will be sent separately. 'severity' means notifications of the same severity will be sent together. 'category' means notifications of the same category will be sent together. 'all' means all notifications will be batched together and sent in a single email.
    MailRelay string
    The address of the SMTP server to be used for relaying the notification messages. An SMTP server is required in order to send notifications. If this string is empty, no emails will be sent.
    MailSender string
    The full email address that will appear as the sender of notification messages.
    MailSubject string
    The subject line for notification messages from this cluster.
    SmtpAuthPasswd string
    Password to authenticate with if SMTP authentication is being used.
    SmtpAuthPasswdSet bool
    Indicates if an SMTP authentication password is set.
    SmtpAuthSecurity string
    The type of secure communication protocol to use if SMTP is being used. If 'none', plain text will be used, if 'starttls', the encrypted STARTTLS protocol will be used.
    SmtpAuthUsername string
    Username to authenticate with if SMTP authentication is being used.
    SmtpPort double
    The port on the SMTP server to be used for relaying the notification messages.
    UseSmtpAuth bool
    If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication.
    UserTemplate string
    Location of a custom template file that can be used to specify the layout of the notification emails. If this string is empty, the default template will be used.
    BatchMode string
    This setting determines how notifications will be batched together to be sent by email. 'none' means each notification will be sent separately. 'severity' means notifications of the same severity will be sent together. 'category' means notifications of the same category will be sent together. 'all' means all notifications will be batched together and sent in a single email.
    MailRelay string
    The address of the SMTP server to be used for relaying the notification messages. An SMTP server is required in order to send notifications. If this string is empty, no emails will be sent.
    MailSender string
    The full email address that will appear as the sender of notification messages.
    MailSubject string
    The subject line for notification messages from this cluster.
    SmtpAuthPasswd string
    Password to authenticate with if SMTP authentication is being used.
    SmtpAuthPasswdSet bool
    Indicates if an SMTP authentication password is set.
    SmtpAuthSecurity string
    The type of secure communication protocol to use if SMTP is being used. If 'none', plain text will be used, if 'starttls', the encrypted STARTTLS protocol will be used.
    SmtpAuthUsername string
    Username to authenticate with if SMTP authentication is being used.
    SmtpPort float64
    The port on the SMTP server to be used for relaying the notification messages.
    UseSmtpAuth bool
    If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication.
    UserTemplate string
    Location of a custom template file that can be used to specify the layout of the notification emails. If this string is empty, the default template will be used.
    batchMode String
    This setting determines how notifications will be batched together to be sent by email. 'none' means each notification will be sent separately. 'severity' means notifications of the same severity will be sent together. 'category' means notifications of the same category will be sent together. 'all' means all notifications will be batched together and sent in a single email.
    mailRelay String
    The address of the SMTP server to be used for relaying the notification messages. An SMTP server is required in order to send notifications. If this string is empty, no emails will be sent.
    mailSender String
    The full email address that will appear as the sender of notification messages.
    mailSubject String
    The subject line for notification messages from this cluster.
    smtpAuthPasswd String
    Password to authenticate with if SMTP authentication is being used.
    smtpAuthPasswdSet Boolean
    Indicates if an SMTP authentication password is set.
    smtpAuthSecurity String
    The type of secure communication protocol to use if SMTP is being used. If 'none', plain text will be used, if 'starttls', the encrypted STARTTLS protocol will be used.
    smtpAuthUsername String
    Username to authenticate with if SMTP authentication is being used.
    smtpPort Double
    The port on the SMTP server to be used for relaying the notification messages.
    useSmtpAuth Boolean
    If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication.
    userTemplate String
    Location of a custom template file that can be used to specify the layout of the notification emails. If this string is empty, the default template will be used.
    batchMode string
    This setting determines how notifications will be batched together to be sent by email. 'none' means each notification will be sent separately. 'severity' means notifications of the same severity will be sent together. 'category' means notifications of the same category will be sent together. 'all' means all notifications will be batched together and sent in a single email.
    mailRelay string
    The address of the SMTP server to be used for relaying the notification messages. An SMTP server is required in order to send notifications. If this string is empty, no emails will be sent.
    mailSender string
    The full email address that will appear as the sender of notification messages.
    mailSubject string
    The subject line for notification messages from this cluster.
    smtpAuthPasswd string
    Password to authenticate with if SMTP authentication is being used.
    smtpAuthPasswdSet boolean
    Indicates if an SMTP authentication password is set.
    smtpAuthSecurity string
    The type of secure communication protocol to use if SMTP is being used. If 'none', plain text will be used, if 'starttls', the encrypted STARTTLS protocol will be used.
    smtpAuthUsername string
    Username to authenticate with if SMTP authentication is being used.
    smtpPort number
    The port on the SMTP server to be used for relaying the notification messages.
    useSmtpAuth boolean
    If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication.
    userTemplate string
    Location of a custom template file that can be used to specify the layout of the notification emails. If this string is empty, the default template will be used.
    batch_mode str
    This setting determines how notifications will be batched together to be sent by email. 'none' means each notification will be sent separately. 'severity' means notifications of the same severity will be sent together. 'category' means notifications of the same category will be sent together. 'all' means all notifications will be batched together and sent in a single email.
    mail_relay str
    The address of the SMTP server to be used for relaying the notification messages. An SMTP server is required in order to send notifications. If this string is empty, no emails will be sent.
    mail_sender str
    The full email address that will appear as the sender of notification messages.
    mail_subject str
    The subject line for notification messages from this cluster.
    smtp_auth_passwd str
    Password to authenticate with if SMTP authentication is being used.
    smtp_auth_passwd_set bool
    Indicates if an SMTP authentication password is set.
    smtp_auth_security str
    The type of secure communication protocol to use if SMTP is being used. If 'none', plain text will be used, if 'starttls', the encrypted STARTTLS protocol will be used.
    smtp_auth_username str
    Username to authenticate with if SMTP authentication is being used.
    smtp_port float
    The port on the SMTP server to be used for relaying the notification messages.
    use_smtp_auth bool
    If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication.
    user_template str
    Location of a custom template file that can be used to specify the layout of the notification emails. If this string is empty, the default template will be used.
    batchMode String
    This setting determines how notifications will be batched together to be sent by email. 'none' means each notification will be sent separately. 'severity' means notifications of the same severity will be sent together. 'category' means notifications of the same category will be sent together. 'all' means all notifications will be batched together and sent in a single email.
    mailRelay String
    The address of the SMTP server to be used for relaying the notification messages. An SMTP server is required in order to send notifications. If this string is empty, no emails will be sent.
    mailSender String
    The full email address that will appear as the sender of notification messages.
    mailSubject String
    The subject line for notification messages from this cluster.
    smtpAuthPasswd String
    Password to authenticate with if SMTP authentication is being used.
    smtpAuthPasswdSet Boolean
    Indicates if an SMTP authentication password is set.
    smtpAuthSecurity String
    The type of secure communication protocol to use if SMTP is being used. If 'none', plain text will be used, if 'starttls', the encrypted STARTTLS protocol will be used.
    smtpAuthUsername String
    Username to authenticate with if SMTP authentication is being used.
    smtpPort Number
    The port on the SMTP server to be used for relaying the notification messages.
    useSmtpAuth Boolean
    If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication.
    userTemplate String
    Location of a custom template file that can be used to specify the layout of the notification emails. If this string is empty, the default template will be used.

    Import

    Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

    Licensed under the Mozilla Public License Version 2.0 (the “License”);

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

    http://mozilla.org/MPL/2.0/

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an “AS IS” BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.

    The command is

    $ pulumi import powerscale:index/clusterEmail:ClusterEmail email <anystring>

    Example:

    $ pulumi import powerscale:index/clusterEmail:ClusterEmail email cluster_email

    after running this command, populate the name field and other required parameters in the config file to start managing this resource.

    Note: running “terraform show” after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
    dell/terraform-provider-powerscale