1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. mailmanager
  6. Relay
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
aws logo aws logo
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi

    Manages an AWS SES Mail Manager Relay.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.mailmanager.Relay("example", {
        authentication: {
            noAuthentication: {},
        },
        name: "example",
        serverName: "smtp.example.com",
        serverPort: 25,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.mailmanager.Relay("example",
        authentication={
            "no_authentication": {},
        },
        name="example",
        server_name="smtp.example.com",
        server_port=25)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/mailmanager"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mailmanager.NewRelay(ctx, "example", &mailmanager.RelayArgs{
    			Authentication: &mailmanager.RelayAuthenticationArgs{
    				NoAuthentication: &mailmanager.RelayAuthenticationNoAuthenticationArgs{},
    			},
    			Name:       pulumi.String("example"),
    			ServerName: pulumi.String("smtp.example.com"),
    			ServerPort: pulumi.Int(25),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.MailManager.Relay("example", new()
        {
            Authentication = new Aws.MailManager.Inputs.RelayAuthenticationArgs
            {
                NoAuthentication = null,
            },
            Name = "example",
            ServerName = "smtp.example.com",
            ServerPort = 25,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.mailmanager.Relay;
    import com.pulumi.aws.mailmanager.RelayArgs;
    import com.pulumi.aws.mailmanager.inputs.RelayAuthenticationArgs;
    import com.pulumi.aws.mailmanager.inputs.RelayAuthenticationNoAuthenticationArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = new Relay("example", RelayArgs.builder()
                .authentication(RelayAuthenticationArgs.builder()
                    .noAuthentication(RelayAuthenticationNoAuthenticationArgs.builder()
                        .build())
                    .build())
                .name("example")
                .serverName("smtp.example.com")
                .serverPort(25)
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:mailmanager:Relay
        properties:
          authentication:
            noAuthentication: {}
          name: example
          serverName: smtp.example.com
          serverPort: 25
    
    pulumi {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    resource "aws_mailmanager_relay" "example" {
      authentication = {
        no_authentication = {}
      }
      name        = "example"
      server_name = "smtp.example.com"
      server_port = 25
    }
    

    With Secret Authentication

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.secretsmanager.Secret("example", {name: "example"});
    const exampleSecretVersion = new aws.secretsmanager.SecretVersion("example", {
        secretId: example.id,
        secretString: JSON.stringify({
            username: "user",
            password: "pass",
        }),
    });
    const exampleRelay = new aws.mailmanager.Relay("example", {
        authentication: {
            secretArn: exampleSecretVersion.arn,
        },
        name: "example",
        serverName: "smtp.example.com",
        serverPort: 587,
    });
    
    import pulumi
    import json
    import pulumi_aws as aws
    
    example = aws.secretsmanager.Secret("example", name="example")
    example_secret_version = aws.secretsmanager.SecretVersion("example",
        secret_id=example.id,
        secret_string=json.dumps({
            "username": "user",
            "password": "pass",
        }))
    example_relay = aws.mailmanager.Relay("example",
        authentication={
            "secret_arn": example_secret_version.arn,
        },
        name="example",
        server_name="smtp.example.com",
        server_port=587)
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/mailmanager"
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/secretsmanager"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := secretsmanager.NewSecret(ctx, "example", &secretsmanager.SecretArgs{
    			Name: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		tmpJSON0, err := json.Marshal(map[string]string{
    			"username": "user",
    			"password": "pass",
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		exampleSecretVersion, err := secretsmanager.NewSecretVersion(ctx, "example", &secretsmanager.SecretVersionArgs{
    			SecretId:     example.ID().ToIDOutput().ToStringOutput(),
    			SecretString: pulumi.String(json0),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = mailmanager.NewRelay(ctx, "example", &mailmanager.RelayArgs{
    			Authentication: &mailmanager.RelayAuthenticationArgs{
    				SecretArn: exampleSecretVersion.Arn,
    			},
    			Name:       pulumi.String("example"),
    			ServerName: pulumi.String("smtp.example.com"),
    			ServerPort: pulumi.Int(587),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.SecretsManager.Secret("example", new()
        {
            Name = "example",
        });
    
        var exampleSecretVersion = new Aws.SecretsManager.SecretVersion("example", new()
        {
            SecretId = example.Id,
            SecretString = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["username"] = "user",
                ["password"] = "pass",
            }),
        });
    
        var exampleRelay = new Aws.MailManager.Relay("example", new()
        {
            Authentication = new Aws.MailManager.Inputs.RelayAuthenticationArgs
            {
                SecretArn = exampleSecretVersion.Arn,
            },
            Name = "example",
            ServerName = "smtp.example.com",
            ServerPort = 587,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.secretsmanager.Secret;
    import com.pulumi.aws.secretsmanager.SecretArgs;
    import com.pulumi.aws.secretsmanager.SecretVersion;
    import com.pulumi.aws.secretsmanager.SecretVersionArgs;
    import com.pulumi.aws.mailmanager.Relay;
    import com.pulumi.aws.mailmanager.RelayArgs;
    import com.pulumi.aws.mailmanager.inputs.RelayAuthenticationArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = new Secret("example", SecretArgs.builder()
                .name("example")
                .build());
    
            var exampleSecretVersion = new SecretVersion("exampleSecretVersion", SecretVersionArgs.builder()
                .secretId(example.id())
                .secretString(serializeJson(
                    jsonObject(
                        jsonProperty("username", "user"),
                        jsonProperty("password", "pass")
                    )))
                .build());
    
            var exampleRelay = new Relay("exampleRelay", RelayArgs.builder()
                .authentication(RelayAuthenticationArgs.builder()
                    .secretArn(exampleSecretVersion.arn())
                    .build())
                .name("example")
                .serverName("smtp.example.com")
                .serverPort(587)
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:secretsmanager:Secret
        properties:
          name: example
      exampleSecretVersion:
        type: aws:secretsmanager:SecretVersion
        name: example
        properties:
          secretId: ${example.id}
          secretString:
            fn::toJSON:
              username: user
              password: pass
      exampleRelay:
        type: aws:mailmanager:Relay
        name: example
        properties:
          authentication:
            secretArn: ${exampleSecretVersion.arn}
          name: example
          serverName: smtp.example.com
          serverPort: 587
    
    pulumi {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    resource "aws_secretsmanager_secret" "example" {
      name = "example"
    }
    resource "aws_secretsmanager_secretversion" "example" {
      secret_id = aws_secretsmanager_secret.example.id
      secret_string = jsonencode({
        "username" = "user"
        "password" = "pass"
      })
    }
    resource "aws_mailmanager_relay" "example" {
      authentication = {
        secret_arn = aws_secretsmanager_secretversion.example.arn
      }
      name        = "example"
      server_name = "smtp.example.com"
      server_port = 587
    }
    

    Create Relay Resource

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

    Constructor syntax

    new Relay(name: string, args: RelayArgs, opts?: CustomResourceOptions);
    @overload
    def Relay(resource_name: str,
              args: RelayArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Relay(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              server_name: Optional[str] = None,
              server_port: Optional[int] = None,
              authentication: Optional[RelayAuthenticationArgs] = None,
              name: Optional[str] = None,
              region: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
    func NewRelay(ctx *Context, name string, args RelayArgs, opts ...ResourceOption) (*Relay, error)
    public Relay(string name, RelayArgs args, CustomResourceOptions? opts = null)
    public Relay(String name, RelayArgs args)
    public Relay(String name, RelayArgs args, CustomResourceOptions options)
    
    type: aws:mailmanager:Relay
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws_mailmanager_relay" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args RelayArgs
    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 RelayArgs
    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 RelayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RelayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RelayArgs
    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 relayResource = new Aws.MailManager.Relay("relayResource", new()
    {
        ServerName = "string",
        ServerPort = 0,
        Authentication = new Aws.MailManager.Inputs.RelayAuthenticationArgs
        {
            NoAuthentication = null,
            SecretArn = "string",
        },
        Name = "string",
        Region = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := mailmanager.NewRelay(ctx, "relayResource", &mailmanager.RelayArgs{
    	ServerName: pulumi.String("string"),
    	ServerPort: pulumi.Int(0),
    	Authentication: &mailmanager.RelayAuthenticationArgs{
    		NoAuthentication: &mailmanager.RelayAuthenticationNoAuthenticationArgs{},
    		SecretArn:        pulumi.String("string"),
    	},
    	Name:   pulumi.String("string"),
    	Region: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    resource "aws_mailmanager_relay" "relayResource" {
      lifecycle {
        create_before_destroy = true
      }
      server_name = "string"
      server_port = 0
      authentication = {
        no_authentication = {}
        secret_arn        = "string"
      }
      name   = "string"
      region = "string"
      tags = {
        "string" = "string"
      }
    }
    
    var relayResource = new Relay("relayResource", RelayArgs.builder()
        .serverName("string")
        .serverPort(0)
        .authentication(RelayAuthenticationArgs.builder()
            .noAuthentication(RelayAuthenticationNoAuthenticationArgs.builder()
                .build())
            .secretArn("string")
            .build())
        .name("string")
        .region("string")
        .tags(Map.of("string", "string"))
        .build());
    
    relay_resource = aws.mailmanager.Relay("relayResource",
        server_name="string",
        server_port=0,
        authentication={
            "no_authentication": {},
            "secret_arn": "string",
        },
        name="string",
        region="string",
        tags={
            "string": "string",
        })
    
    const relayResource = new aws.mailmanager.Relay("relayResource", {
        serverName: "string",
        serverPort: 0,
        authentication: {
            noAuthentication: {},
            secretArn: "string",
        },
        name: "string",
        region: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:mailmanager:Relay
    properties:
        authentication:
            noAuthentication: {}
            secretArn: string
        name: string
        region: string
        serverName: string
        serverPort: 0
        tags:
            string: string
    

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

    ServerName string
    Hostname of the SMTP server.
    ServerPort int

    Port of the SMTP server.

    The following arguments are optional:

    Authentication RelayAuthentication
    Authentication configuration for the relay. See authentication Block.
    Name string
    Name of the relay.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ServerName string
    Hostname of the SMTP server.
    ServerPort int

    Port of the SMTP server.

    The following arguments are optional:

    Authentication RelayAuthenticationArgs
    Authentication configuration for the relay. See authentication Block.
    Name string
    Name of the relay.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    server_name string
    Hostname of the SMTP server.
    server_port number

    Port of the SMTP server.

    The following arguments are optional:

    authentication object
    Authentication configuration for the relay. See authentication Block.
    name string
    Name of the relay.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    serverName String
    Hostname of the SMTP server.
    serverPort Integer

    Port of the SMTP server.

    The following arguments are optional:

    authentication RelayAuthentication
    Authentication configuration for the relay. See authentication Block.
    name String
    Name of the relay.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    serverName string
    Hostname of the SMTP server.
    serverPort number

    Port of the SMTP server.

    The following arguments are optional:

    authentication RelayAuthentication
    Authentication configuration for the relay. See authentication Block.
    name string
    Name of the relay.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    server_name str
    Hostname of the SMTP server.
    server_port int

    Port of the SMTP server.

    The following arguments are optional:

    authentication RelayAuthenticationArgs
    Authentication configuration for the relay. See authentication Block.
    name str
    Name of the relay.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    serverName String
    Hostname of the SMTP server.
    serverPort Number

    Port of the SMTP server.

    The following arguments are optional:

    authentication Property Map
    Authentication configuration for the relay. See authentication Block.
    name String
    Name of the relay.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the relay.
    CreatedTimestamp string
    Timestamp when the relay was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTimestamp string
    Timestamp when the relay was last modified.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Arn string
    ARN of the relay.
    CreatedTimestamp string
    Timestamp when the relay was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTimestamp string
    Timestamp when the relay was last modified.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the relay.
    created_timestamp string
    Timestamp when the relay was created.
    id string
    The provider-assigned unique ID for this managed resource.
    last_modified_timestamp string
    Timestamp when the relay was last modified.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the relay.
    createdTimestamp String
    Timestamp when the relay was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTimestamp String
    Timestamp when the relay was last modified.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the relay.
    createdTimestamp string
    Timestamp when the relay was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTimestamp string
    Timestamp when the relay was last modified.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn str
    ARN of the relay.
    created_timestamp str
    Timestamp when the relay was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_timestamp str
    Timestamp when the relay was last modified.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the relay.
    createdTimestamp String
    Timestamp when the relay was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTimestamp String
    Timestamp when the relay was last modified.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Look up Existing Relay Resource

    Get an existing Relay 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?: RelayState, opts?: CustomResourceOptions): Relay
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            authentication: Optional[RelayAuthenticationArgs] = None,
            created_timestamp: Optional[str] = None,
            last_modified_timestamp: Optional[str] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            server_name: Optional[str] = None,
            server_port: Optional[int] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Relay
    func GetRelay(ctx *Context, name string, id IDInput, state *RelayState, opts ...ResourceOption) (*Relay, error)
    public static Relay Get(string name, Input<string> id, RelayState? state, CustomResourceOptions? opts = null)
    public static Relay get(String name, Output<String> id, RelayState state, CustomResourceOptions options)
    resources:  _:    type: aws:mailmanager:Relay    get:      id: ${id}
    import {
      to = aws_mailmanager_relay.example
      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:
    Arn string
    ARN of the relay.
    Authentication RelayAuthentication
    Authentication configuration for the relay. See authentication Block.
    CreatedTimestamp string
    Timestamp when the relay was created.
    LastModifiedTimestamp string
    Timestamp when the relay was last modified.
    Name string
    Name of the relay.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    ServerName string
    Hostname of the SMTP server.
    ServerPort int

    Port of the SMTP server.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Arn string
    ARN of the relay.
    Authentication RelayAuthenticationArgs
    Authentication configuration for the relay. See authentication Block.
    CreatedTimestamp string
    Timestamp when the relay was created.
    LastModifiedTimestamp string
    Timestamp when the relay was last modified.
    Name string
    Name of the relay.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    ServerName string
    Hostname of the SMTP server.
    ServerPort int

    Port of the SMTP server.

    The following arguments are optional:

    Tags map[string]string
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the relay.
    authentication object
    Authentication configuration for the relay. See authentication Block.
    created_timestamp string
    Timestamp when the relay was created.
    last_modified_timestamp string
    Timestamp when the relay was last modified.
    name string
    Name of the relay.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    server_name string
    Hostname of the SMTP server.
    server_port number

    Port of the SMTP server.

    The following arguments are optional:

    tags map(string)
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the relay.
    authentication RelayAuthentication
    Authentication configuration for the relay. See authentication Block.
    createdTimestamp String
    Timestamp when the relay was created.
    lastModifiedTimestamp String
    Timestamp when the relay was last modified.
    name String
    Name of the relay.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    serverName String
    Hostname of the SMTP server.
    serverPort Integer

    Port of the SMTP server.

    The following arguments are optional:

    tags Map<String,String>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the relay.
    authentication RelayAuthentication
    Authentication configuration for the relay. See authentication Block.
    createdTimestamp string
    Timestamp when the relay was created.
    lastModifiedTimestamp string
    Timestamp when the relay was last modified.
    name string
    Name of the relay.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    serverName string
    Hostname of the SMTP server.
    serverPort number

    Port of the SMTP server.

    The following arguments are optional:

    tags {[key: string]: string}
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn str
    ARN of the relay.
    authentication RelayAuthenticationArgs
    Authentication configuration for the relay. See authentication Block.
    created_timestamp str
    Timestamp when the relay was created.
    last_modified_timestamp str
    Timestamp when the relay was last modified.
    name str
    Name of the relay.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    server_name str
    Hostname of the SMTP server.
    server_port int

    Port of the SMTP server.

    The following arguments are optional:

    tags Mapping[str, str]
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the relay.
    authentication Property Map
    Authentication configuration for the relay. See authentication Block.
    createdTimestamp String
    Timestamp when the relay was created.
    lastModifiedTimestamp String
    Timestamp when the relay was last modified.
    name String
    Name of the relay.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    serverName String
    Hostname of the SMTP server.
    serverPort Number

    Port of the SMTP server.

    The following arguments are optional:

    tags Map<String>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Supporting Types

    RelayAuthentication, RelayAuthenticationArgs

    NoAuthentication RelayAuthenticationNoAuthentication
    No authentication is required to connect to the SMTP server.
    SecretArn string
    ARN of the Secrets Manager secret containing the SMTP credentials.
    NoAuthentication RelayAuthenticationNoAuthentication
    No authentication is required to connect to the SMTP server.
    SecretArn string
    ARN of the Secrets Manager secret containing the SMTP credentials.
    no_authentication object
    No authentication is required to connect to the SMTP server.
    secret_arn string
    ARN of the Secrets Manager secret containing the SMTP credentials.
    noAuthentication RelayAuthenticationNoAuthentication
    No authentication is required to connect to the SMTP server.
    secretArn String
    ARN of the Secrets Manager secret containing the SMTP credentials.
    noAuthentication RelayAuthenticationNoAuthentication
    No authentication is required to connect to the SMTP server.
    secretArn string
    ARN of the Secrets Manager secret containing the SMTP credentials.
    no_authentication RelayAuthenticationNoAuthentication
    No authentication is required to connect to the SMTP server.
    secret_arn str
    ARN of the Secrets Manager secret containing the SMTP credentials.
    noAuthentication Property Map
    No authentication is required to connect to the SMTP server.
    secretArn String
    ARN of the Secrets Manager secret containing the SMTP credentials.

    Import

    Identity Schema

    Required

    • id (String) Identifier of the relay.

    Optional

    • accountId (String) AWS Account where this resource is managed.
    • region (String) Region where this resource is managed.

    Using pulumi import, import an SES Mail Manager Relay using its identifier. For example:

    $ pulumi import aws:mailmanager/relay:Relay example relay-id-12345678
    

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.46.0
    published on Thursday, Sep 10, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial