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.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnMailManagerRelay

Implements

IInspectable

IMailManagerRelayRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnMailManagerRelay : CfnResource, IInspectable, IMailManagerRelayRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnMailManagerRelay Inherits CfnResource Implements IInspectable, IMailManagerRelayRef, IConstruct, IDependable, IEnvironmentAware, 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(Construct, string, ICfnMailManagerRelayProps)

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

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.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Resource to create an SMTP relay, which can be used within a Mail Manager rule set to forward incoming emails to defined relay destinations.
MailManagerRelayRef	A reference to a MailManagerRelay resource.
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

FromRelayId(Construct, string, string)	Creates a new IMailManagerRelayRef from a relayId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Resource to create an SMTP relay, which can be used within a Mail Manager rule set to forward incoming emails to defined relay destinations.

Constructors

CfnMailManagerRelay(Construct, string, ICfnMailManagerRelayProps)

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

public CfnMailManagerRelay(Construct scope, string id, ICfnMailManagerRelayProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnMailManagerRelayProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

Properties

AttrRelayArn

The Amazon Resource Name (ARN) of the relay.

public virtual string AttrRelayArn { get; }

Property Value

string

Remarks

CloudformationAttribute: RelayArn

AttrRelayId

The unique relay identifier.

public virtual string AttrRelayId { get; }

Property Value

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

object

Remarks

Type union: either IResolvable or CfnMailManagerRelay.IRelayAuthenticationProperty

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

MailManagerRelayRef

A reference to a MailManagerRelay resource.

public virtual IMailManagerRelayReference MailManagerRelayRef { get; }

Property Value

IMailManagerRelayReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

RelayName

The unique relay name.

public virtual string? RelayName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

ServerName

The destination relay server address.

public virtual string ServerName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

ServerPort

The destination relay server port.

public virtual double ServerPort { get; set; }

Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

Methods

FromRelayId(Construct, string, string)

Creates a new IMailManagerRelayRef from a relayId.

public static IMailManagerRelayRef FromRelayId(Construct scope, string id, string relayId)

Parameters

scope Construct
id string
relayId string

Returns

IMailManagerRelayRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html

CloudformationResource: AWS::SES::MailManagerRelay

ExampleMetadata: fixture=_generated

Implements

IInspectable

IMailManagerRelayRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2