Class CfnMailManagerRelay
Resource to create an SMTP relay, which can be used within a Mail Manager rule set to forward incoming emails to defined relay destinations.
Inherited Members
Namespace: Amazon.CDK.AWS.SES
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMailManagerRelay : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnMailManagerRelay
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html
CloudformationResource: AWS::SES::MailManagerRelay
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SES;
var noAuthentication;
var cfnMailManagerRelay = new CfnMailManagerRelay(this, "MyCfnMailManagerRelay", new CfnMailManagerRelayProps {
Authentication = new RelayAuthenticationProperty {
NoAuthentication = noAuthentication,
SecretArn = "secretArn"
},
ServerName = "serverName",
ServerPort = 123,
// the properties below are optional
RelayName = "relayName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnMailManagerRelay(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnMailManagerRelay(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnMailManagerRelay(Construct, String, ICfnMailManagerRelayProps) |
Properties
AttrRelayArn | The Amazon Resource Name (ARN) of the relay. |
AttrRelayId | The unique relay identifier. |
Authentication | Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
RelayName | The unique relay name. |
ServerName | The destination relay server address. |
ServerPort | The destination relay server port. |
Tags | The tags used to organize, track, or control access for the resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnMailManagerRelay(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnMailManagerRelay(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnMailManagerRelay(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnMailManagerRelay(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnMailManagerRelay(Construct, String, ICfnMailManagerRelayProps)
public CfnMailManagerRelay(Construct scope, string id, ICfnMailManagerRelayProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnMailManagerRelayProps
Resource properties.
Properties
AttrRelayArn
The Amazon Resource Name (ARN) of the relay.
public virtual string AttrRelayArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RelayArn
AttrRelayId
The unique relay identifier.
public virtual string AttrRelayId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RelayId
Authentication
Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
public virtual object Authentication { get; set; }
Property Value
System.Object
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
RelayName
The unique relay name.
public virtual string RelayName { get; set; }
Property Value
System.String
ServerName
The destination relay server address.
public virtual string ServerName { get; set; }
Property Value
System.String
ServerPort
The destination relay server port.
public virtual double ServerPort { get; set; }
Property Value
System.Double
Tags
The tags used to organize, track, or control access for the resource.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>