ibm 1.78.0, Apr 30 25

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.EnDestinationCustomEmail

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

Create EnDestinationCustomEmail Resource

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

Constructor syntax

new EnDestinationCustomEmail(name: string, args: EnDestinationCustomEmailArgs, opts?: CustomResourceOptions);

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

@overload
def EnDestinationCustomEmail(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             instance_guid: Optional[str] = None,
                             type: Optional[str] = None,
                             collect_failed_events: Optional[bool] = None,
                             config: Optional[EnDestinationCustomEmailConfigArgs] = None,
                             description: Optional[str] = None,
                             en_destination_custom_email_id: Optional[str] = None,
                             name: Optional[str] = None,
                             verification_type: Optional[str] = None)

func NewEnDestinationCustomEmail(ctx *Context, name string, args EnDestinationCustomEmailArgs, opts ...ResourceOption) (*EnDestinationCustomEmail, error)

public EnDestinationCustomEmail(string name, EnDestinationCustomEmailArgs args, CustomResourceOptions? opts = null)

public EnDestinationCustomEmail(String name, EnDestinationCustomEmailArgs args)
public EnDestinationCustomEmail(String name, EnDestinationCustomEmailArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args EnDestinationCustomEmailArgs: 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 enDestinationCustomEmailResource = new Ibm.EnDestinationCustomEmail("enDestinationCustomEmailResource", new()
{
    InstanceGuid = "string",
    Type = "string",
    CollectFailedEvents = false,
    Config = new Ibm.Inputs.EnDestinationCustomEmailConfigArgs
    {
        Params = new[]
        {
            new Ibm.Inputs.EnDestinationCustomEmailConfigParamArgs
            {
                Domain = "string",
                Dkims = new[]
                {
                    new Ibm.Inputs.EnDestinationCustomEmailConfigParamDkimArgs
                    {
                        PublicKey = "string",
                        Selector = "string",
                        Verification = "string",
                    },
                },
                Spfs = new[]
                {
                    new Ibm.Inputs.EnDestinationCustomEmailConfigParamSpfArgs
                    {
                        TxtName = "string",
                        TxtValue = "string",
                        Verification = "string",
                    },
                },
            },
        },
    },
    Description = "string",
    EnDestinationCustomEmailId = "string",
    Name = "string",
    VerificationType = "string",
});

example, err := ibm.NewEnDestinationCustomEmail(ctx, "enDestinationCustomEmailResource", &ibm.EnDestinationCustomEmailArgs{
	InstanceGuid:        pulumi.String("string"),
	Type:                pulumi.String("string"),
	CollectFailedEvents: pulumi.Bool(false),
	Config: &ibm.EnDestinationCustomEmailConfigArgs{
		Params: ibm.EnDestinationCustomEmailConfigParamArray{
			&ibm.EnDestinationCustomEmailConfigParamArgs{
				Domain: pulumi.String("string"),
				Dkims: ibm.EnDestinationCustomEmailConfigParamDkimArray{
					&ibm.EnDestinationCustomEmailConfigParamDkimArgs{
						PublicKey:    pulumi.String("string"),
						Selector:     pulumi.String("string"),
						Verification: pulumi.String("string"),
					},
				},
				Spfs: ibm.EnDestinationCustomEmailConfigParamSpfArray{
					&ibm.EnDestinationCustomEmailConfigParamSpfArgs{
						TxtName:      pulumi.String("string"),
						TxtValue:     pulumi.String("string"),
						Verification: pulumi.String("string"),
					},
				},
			},
		},
	},
	Description:                pulumi.String("string"),
	EnDestinationCustomEmailId: pulumi.String("string"),
	Name:                       pulumi.String("string"),
	VerificationType:           pulumi.String("string"),
})

var enDestinationCustomEmailResource = new EnDestinationCustomEmail("enDestinationCustomEmailResource", EnDestinationCustomEmailArgs.builder()
    .instanceGuid("string")
    .type("string")
    .collectFailedEvents(false)
    .config(EnDestinationCustomEmailConfigArgs.builder()
        .params(EnDestinationCustomEmailConfigParamArgs.builder()
            .domain("string")
            .dkims(EnDestinationCustomEmailConfigParamDkimArgs.builder()
                .publicKey("string")
                .selector("string")
                .verification("string")
                .build())
            .spfs(EnDestinationCustomEmailConfigParamSpfArgs.builder()
                .txtName("string")
                .txtValue("string")
                .verification("string")
                .build())
            .build())
        .build())
    .description("string")
    .enDestinationCustomEmailId("string")
    .name("string")
    .verificationType("string")
    .build());

en_destination_custom_email_resource = ibm.EnDestinationCustomEmail("enDestinationCustomEmailResource",
    instance_guid="string",
    type="string",
    collect_failed_events=False,
    config={
        "params": [{
            "domain": "string",
            "dkims": [{
                "public_key": "string",
                "selector": "string",
                "verification": "string",
            }],
            "spfs": [{
                "txt_name": "string",
                "txt_value": "string",
                "verification": "string",
            }],
        }],
    },
    description="string",
    en_destination_custom_email_id="string",
    name="string",
    verification_type="string")

const enDestinationCustomEmailResource = new ibm.EnDestinationCustomEmail("enDestinationCustomEmailResource", {
    instanceGuid: "string",
    type: "string",
    collectFailedEvents: false,
    config: {
        params: [{
            domain: "string",
            dkims: [{
                publicKey: "string",
                selector: "string",
                verification: "string",
            }],
            spfs: [{
                txtName: "string",
                txtValue: "string",
                verification: "string",
            }],
        }],
    },
    description: "string",
    enDestinationCustomEmailId: "string",
    name: "string",
    verificationType: "string",
});

type: ibm:EnDestinationCustomEmail
properties:
    collectFailedEvents: false
    config:
        params:
            - dkims:
                - publicKey: string
                  selector: string
                  verification: string
              domain: string
              spfs:
                - txtName: string
                  txtValue: string
                  verification: string
    description: string
    enDestinationCustomEmailId: string
    instanceGuid: string
    name: string
    type: string
    verificationType: string

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

InstanceGuid string: Unique identifier for IBM Cloud Event Notifications instance.
Type string: The type of Destination type smtp_custom.
CollectFailedEvents bool: Whether to collect the failed event in Cloud Object Storage bucket
Config EnDestinationCustomEmailConfig: Payload describing a destination configuration.
Description string: The Destination description.
EnDestinationCustomEmailId string
Name string: The Destintion name.
VerificationType string: Verification Method spf/dkim.

InstanceGuid string: Unique identifier for IBM Cloud Event Notifications instance.
Type string: The type of Destination type smtp_custom.
CollectFailedEvents bool: Whether to collect the failed event in Cloud Object Storage bucket
Config EnDestinationCustomEmailConfigArgs: Payload describing a destination configuration.
Description string: The Destination description.
EnDestinationCustomEmailId string
Name string: The Destintion name.
VerificationType string: Verification Method spf/dkim.

instanceGuid String: Unique identifier for IBM Cloud Event Notifications instance.
type String: The type of Destination type smtp_custom.
collectFailedEvents Boolean: Whether to collect the failed event in Cloud Object Storage bucket
config EnDestinationCustomEmailConfig: Payload describing a destination configuration.
description String: The Destination description.
enDestinationCustomEmailId String
name String: The Destintion name.
verificationType String: Verification Method spf/dkim.

instanceGuid string: Unique identifier for IBM Cloud Event Notifications instance.
type string: The type of Destination type smtp_custom.
collectFailedEvents boolean: Whether to collect the failed event in Cloud Object Storage bucket
config EnDestinationCustomEmailConfig: Payload describing a destination configuration.
description string: The Destination description.
enDestinationCustomEmailId string
name string: The Destintion name.
verificationType string: Verification Method spf/dkim.

instance_guid str: Unique identifier for IBM Cloud Event Notifications instance.
type str: The type of Destination type smtp_custom.
collect_failed_events bool: Whether to collect the failed event in Cloud Object Storage bucket
config EnDestinationCustomEmailConfigArgs: Payload describing a destination configuration.
description str: The Destination description.
en_destination_custom_email_id str
name str: The Destintion name.
verification_type str: Verification Method spf/dkim.

instanceGuid String: Unique identifier for IBM Cloud Event Notifications instance.
type String: The type of Destination type smtp_custom.
collectFailedEvents Boolean: Whether to collect the failed event in Cloud Object Storage bucket
config Property Map: Payload describing a destination configuration.
description String: The Destination description.
enDestinationCustomEmailId String
name String: The Destintion name.
verificationType String: Verification Method spf/dkim.

Outputs

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

DestinationId string: Destination ID
Id string: The provider-assigned unique ID for this managed resource.
SubscriptionCount double: Number of subscriptions.
SubscriptionNames List<string>: List of subscriptions.
UpdatedAt string: Last updated time.

DestinationId string: Destination ID
Id string: The provider-assigned unique ID for this managed resource.
SubscriptionCount float64: Number of subscriptions.
SubscriptionNames []string: List of subscriptions.
UpdatedAt string: Last updated time.

destinationId String: Destination ID
id String: The provider-assigned unique ID for this managed resource.
subscriptionCount Double: Number of subscriptions.
subscriptionNames List<String>: List of subscriptions.
updatedAt String: Last updated time.

destinationId string: Destination ID
id string: The provider-assigned unique ID for this managed resource.
subscriptionCount number: Number of subscriptions.
subscriptionNames string[]: List of subscriptions.
updatedAt string: Last updated time.

destination_id str: Destination ID
id str: The provider-assigned unique ID for this managed resource.
subscription_count float: Number of subscriptions.
subscription_names Sequence[str]: List of subscriptions.
updated_at str: Last updated time.

destinationId String: Destination ID
id String: The provider-assigned unique ID for this managed resource.
subscriptionCount Number: Number of subscriptions.
subscriptionNames List<String>: List of subscriptions.
updatedAt String: Last updated time.

Look up Existing EnDestinationCustomEmail Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        collect_failed_events: Optional[bool] = None,
        config: Optional[EnDestinationCustomEmailConfigArgs] = None,
        description: Optional[str] = None,
        destination_id: Optional[str] = None,
        en_destination_custom_email_id: Optional[str] = None,
        instance_guid: Optional[str] = None,
        name: Optional[str] = None,
        subscription_count: Optional[float] = None,
        subscription_names: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        verification_type: Optional[str] = None) -> EnDestinationCustomEmail

func GetEnDestinationCustomEmail(ctx *Context, name string, id IDInput, state *EnDestinationCustomEmailState, opts ...ResourceOption) (*EnDestinationCustomEmail, error)

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

public static EnDestinationCustomEmail get(String name, Output<String> id, EnDestinationCustomEmailState state, CustomResourceOptions options)

resources:  _:    type: ibm:EnDestinationCustomEmail    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:

CollectFailedEvents bool: Whether to collect the failed event in Cloud Object Storage bucket
Config EnDestinationCustomEmailConfig: Payload describing a destination configuration.
Description string: The Destination description.
DestinationId string: Destination ID
EnDestinationCustomEmailId string
InstanceGuid string: Unique identifier for IBM Cloud Event Notifications instance.
Name string: The Destintion name.
SubscriptionCount double: Number of subscriptions.
SubscriptionNames List<string>: List of subscriptions.
Type string: The type of Destination type smtp_custom.
UpdatedAt string: Last updated time.
VerificationType string: Verification Method spf/dkim.

CollectFailedEvents bool: Whether to collect the failed event in Cloud Object Storage bucket
Config EnDestinationCustomEmailConfigArgs: Payload describing a destination configuration.
Description string: The Destination description.
DestinationId string: Destination ID
EnDestinationCustomEmailId string
InstanceGuid string: Unique identifier for IBM Cloud Event Notifications instance.
Name string: The Destintion name.
SubscriptionCount float64: Number of subscriptions.
SubscriptionNames []string: List of subscriptions.
Type string: The type of Destination type smtp_custom.
UpdatedAt string: Last updated time.
VerificationType string: Verification Method spf/dkim.

collectFailedEvents Boolean: Whether to collect the failed event in Cloud Object Storage bucket
config EnDestinationCustomEmailConfig: Payload describing a destination configuration.
description String: The Destination description.
destinationId String: Destination ID
enDestinationCustomEmailId String
instanceGuid String: Unique identifier for IBM Cloud Event Notifications instance.
name String: The Destintion name.
subscriptionCount Double: Number of subscriptions.
subscriptionNames List<String>: List of subscriptions.
type String: The type of Destination type smtp_custom.
updatedAt String: Last updated time.
verificationType String: Verification Method spf/dkim.

collectFailedEvents boolean: Whether to collect the failed event in Cloud Object Storage bucket
config EnDestinationCustomEmailConfig: Payload describing a destination configuration.
description string: The Destination description.
destinationId string: Destination ID
enDestinationCustomEmailId string
instanceGuid string: Unique identifier for IBM Cloud Event Notifications instance.
name string: The Destintion name.
subscriptionCount number: Number of subscriptions.
subscriptionNames string[]: List of subscriptions.
type string: The type of Destination type smtp_custom.
updatedAt string: Last updated time.
verificationType string: Verification Method spf/dkim.

collect_failed_events bool: Whether to collect the failed event in Cloud Object Storage bucket
config EnDestinationCustomEmailConfigArgs: Payload describing a destination configuration.
description str: The Destination description.
destination_id str: Destination ID
en_destination_custom_email_id str
instance_guid str: Unique identifier for IBM Cloud Event Notifications instance.
name str: The Destintion name.
subscription_count float: Number of subscriptions.
subscription_names Sequence[str]: List of subscriptions.
type str: The type of Destination type smtp_custom.
updated_at str: Last updated time.
verification_type str: Verification Method spf/dkim.

collectFailedEvents Boolean: Whether to collect the failed event in Cloud Object Storage bucket
config Property Map: Payload describing a destination configuration.
description String: The Destination description.
destinationId String: Destination ID
enDestinationCustomEmailId String
instanceGuid String: Unique identifier for IBM Cloud Event Notifications instance.
name String: The Destintion name.
subscriptionCount Number: Number of subscriptions.
subscriptionNames List<String>: List of subscriptions.
type String: The type of Destination type smtp_custom.
updatedAt String: Last updated time.
verificationType String: Verification Method spf/dkim.