

This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::SES::MailManagerRelay
<a name="aws-resource-ses-mailmanagerrelay"></a>

Resource to create an SMTP relay, which can be used within a Mail Manager rule set to forward incoming emails to defined relay destinations.

## Syntax
<a name="aws-resource-ses-mailmanagerrelay-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-ses-mailmanagerrelay-syntax.json"></a>

```
{
  "Type" : "AWS::SES::MailManagerRelay",
  "Properties" : {
      "[Authentication](#cfn-ses-mailmanagerrelay-authentication)" : RelayAuthentication,
      "[RelayName](#cfn-ses-mailmanagerrelay-relayname)" : String,
      "[ServerName](#cfn-ses-mailmanagerrelay-servername)" : String,
      "[ServerPort](#cfn-ses-mailmanagerrelay-serverport)" : Number,
      "[Tags](#cfn-ses-mailmanagerrelay-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-ses-mailmanagerrelay-syntax.yaml"></a>

```
Type: AWS::SES::MailManagerRelay
Properties:
  [Authentication](#cfn-ses-mailmanagerrelay-authentication): 
    RelayAuthentication
  [RelayName](#cfn-ses-mailmanagerrelay-relayname): String
  [ServerName](#cfn-ses-mailmanagerrelay-servername): String
  [ServerPort](#cfn-ses-mailmanagerrelay-serverport): Number
  [Tags](#cfn-ses-mailmanagerrelay-tags): 
    - Tag
```

## Properties
<a name="aws-resource-ses-mailmanagerrelay-properties"></a>

`Authentication`  <a name="cfn-ses-mailmanagerrelay-authentication"></a>
Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.  
*Required*: Yes  
*Type*: [RelayAuthentication](aws-properties-ses-mailmanagerrelay-relayauthentication.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RelayName`  <a name="cfn-ses-mailmanagerrelay-relayname"></a>
The unique relay name.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-_]+$`  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-ses-mailmanagerrelay-servername"></a>
The destination relay server address.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-\.]+$`  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerPort`  <a name="cfn-ses-mailmanagerrelay-serverport"></a>
The destination relay server port.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `65535`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-ses-mailmanagerrelay-tags"></a>
The tags used to organize, track, or control access for the resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-ses-mailmanagerrelay-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-ses-mailmanagerrelay-return-values"></a>

### Ref
<a name="aws-resource-ses-mailmanagerrelay-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-ses-mailmanagerrelay-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-ses-mailmanagerrelay-return-values-fn--getatt-fn--getatt"></a>

`RelayArn`  <a name="RelayArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the relay.

`RelayId`  <a name="RelayId-fn::getatt"></a>
The unique relay identifier.

# AWS::SES::MailManagerRelay RelayAuthentication
<a name="aws-properties-ses-mailmanagerrelay-relayauthentication"></a>

Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored, or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

## Syntax
<a name="aws-properties-ses-mailmanagerrelay-relayauthentication-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ses-mailmanagerrelay-relayauthentication-syntax.json"></a>

```
{
  "[NoAuthentication](#cfn-ses-mailmanagerrelay-relayauthentication-noauthentication)" : Json,
  "[SecretArn](#cfn-ses-mailmanagerrelay-relayauthentication-secretarn)" : String
}
```

### YAML
<a name="aws-properties-ses-mailmanagerrelay-relayauthentication-syntax.yaml"></a>

```
  [NoAuthentication](#cfn-ses-mailmanagerrelay-relayauthentication-noauthentication): Json
  [SecretArn](#cfn-ses-mailmanagerrelay-relayauthentication-secretarn): String
```

## Properties
<a name="aws-properties-ses-mailmanagerrelay-relayauthentication-properties"></a>

`NoAuthentication`  <a name="cfn-ses-mailmanagerrelay-relayauthentication-noauthentication"></a>
Keep an empty structure if the relay destination server does not require SMTP credential authentication.  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretArn`  <a name="cfn-ses-mailmanagerrelay-relayauthentication-secretarn"></a>
The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc):secretsmanager:[a-z0-9-]+:\d{12}:secret:[a-zA-Z0-9/_+=,.@-]+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SES::MailManagerRelay Tag
<a name="aws-properties-ses-mailmanagerrelay-tag"></a>

A key-value pair (the value is optional), that you can define and assign to AWS resources.

## Syntax
<a name="aws-properties-ses-mailmanagerrelay-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ses-mailmanagerrelay-tag-syntax.json"></a>

```
{
  "[Key](#cfn-ses-mailmanagerrelay-tag-key)" : String,
  "[Value](#cfn-ses-mailmanagerrelay-tag-value)" : String
}
```

### YAML
<a name="aws-properties-ses-mailmanagerrelay-tag-syntax.yaml"></a>

```
  [Key](#cfn-ses-mailmanagerrelay-tag-key): String
  [Value](#cfn-ses-mailmanagerrelay-tag-value): String
```

## Properties
<a name="aws-properties-ses-mailmanagerrelay-tag-properties"></a>

`Key`  <a name="cfn-ses-mailmanagerrelay-tag-key"></a>
The key of the key-value tag.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9/_\+=\.:@\-]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-ses-mailmanagerrelay-tag-value"></a>
The value of the key-value tag.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9/_\+=\.:@\-]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)