This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-ses

The CDK Construct Library for AWS Simple Email Service

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.SES" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.SES --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.SES" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:ses:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="ses" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>ses</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:ses:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='ses', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-ses@0.25.3

package.json:

{
  "@aws-cdk/aws-ses": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-ses@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-ses@0.25.3

package.json:

{
  "@aws-cdk/aws-ses": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-ses@0.25.3

CfnConfigurationSet

class @aws-cdk/aws-ses.CfnConfigurationSet(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnConfigurationSet;
const { CfnConfigurationSet } = require('@aws-cdk/aws-ses');
import { CfnConfigurationSet } from '@aws-cdk/aws-ses';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
configurationSetName
Type:string (readonly)
propertyOverrides
Type:CfnConfigurationSetProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnConfigurationSetEventDestination

class @aws-cdk/aws-ses.CfnConfigurationSetEventDestination(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnConfigurationSetEventDestination;
const { CfnConfigurationSetEventDestination } = require('@aws-cdk/aws-ses');
import { CfnConfigurationSetEventDestination } from '@aws-cdk/aws-ses';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnConfigurationSetEventDestinationProps (readonly)
class CloudWatchDestinationProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty;
// CfnConfigurationSetEventDestination.CloudWatchDestinationProperty is an interface
import { CfnConfigurationSetEventDestination.CloudWatchDestinationProperty } from '@aws-cdk/aws-ses';
dimensionConfigurations

CfnConfigurationSetEventDestination.CloudWatchDestinationProperty.DimensionConfigurations

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-cloudwatchdestination.html#cfn-ses-configurationseteventdestination-cloudwatchdestination-dimensionconfigurations

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or DimensionConfigurationProperty)[] (optional)
class DimensionConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty;
// CfnConfigurationSetEventDestination.DimensionConfigurationProperty is an interface
import { CfnConfigurationSetEventDestination.DimensionConfigurationProperty } from '@aws-cdk/aws-ses';
defaultDimensionValue

CfnConfigurationSetEventDestination.DimensionConfigurationProperty.DefaultDimensionValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-defaultdimensionvalue

Type:string
dimensionName

CfnConfigurationSetEventDestination.DimensionConfigurationProperty.DimensionName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionname

Type:string
dimensionValueSource

CfnConfigurationSetEventDestination.DimensionConfigurationProperty.DimensionValueSource

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionvaluesource

Type:string
class EventDestinationProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnConfigurationSetEventDestination.EventDestinationProperty;
// CfnConfigurationSetEventDestination.EventDestinationProperty is an interface
import { CfnConfigurationSetEventDestination.EventDestinationProperty } from '@aws-cdk/aws-ses';
matchingEventTypes

CfnConfigurationSetEventDestination.EventDestinationProperty.MatchingEventTypes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-matchingeventtypes

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
cloudWatchDestination

CfnConfigurationSetEventDestination.EventDestinationProperty.CloudWatchDestination

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-cloudwatchdestination

Type:@aws-cdk/cdk.Token or CloudWatchDestinationProperty (optional)
enabled

CfnConfigurationSetEventDestination.EventDestinationProperty.Enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-enabled

Type:boolean or @aws-cdk/cdk.Token (optional)
kinesisFirehoseDestination

CfnConfigurationSetEventDestination.EventDestinationProperty.KinesisFirehoseDestination

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-kinesisfirehosedestination

Type:@aws-cdk/cdk.Token or KinesisFirehoseDestinationProperty (optional)
name

CfnConfigurationSetEventDestination.EventDestinationProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-name

Type:string (optional)
class KinesisFirehoseDestinationProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty;
// CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty is an interface
import { CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty } from '@aws-cdk/aws-ses';
deliveryStreamArn

CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty.DeliveryStreamARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-deliverystreamarn

Type:string
iamRoleArn

CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty.IAMRoleARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-iamrolearn

Type:string
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnConfigurationSetEventDestinationProps (interface)

class @aws-cdk/aws-ses.CfnConfigurationSetEventDestinationProps

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnConfigurationSetEventDestinationProps;
// CfnConfigurationSetEventDestinationProps is an interface
import { CfnConfigurationSetEventDestinationProps } from '@aws-cdk/aws-ses';
configurationSetName

AWS::SES::ConfigurationSetEventDestination.ConfigurationSetName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html#cfn-ses-configurationseteventdestination-configurationsetname

Type:string
eventDestination

AWS::SES::ConfigurationSetEventDestination.EventDestination

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html#cfn-ses-configurationseteventdestination-eventdestination

Type:EventDestinationProperty or @aws-cdk/cdk.Token

CfnConfigurationSetProps (interface)

class @aws-cdk/aws-ses.CfnConfigurationSetProps

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnConfigurationSetProps;
// CfnConfigurationSetProps is an interface
import { CfnConfigurationSetProps } from '@aws-cdk/aws-ses';
name

AWS::SES::ConfigurationSet.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-name

Type:string (optional)

CfnReceiptFilter

class @aws-cdk/aws-ses.CfnReceiptFilter(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptFilter;
const { CfnReceiptFilter } = require('@aws-cdk/aws-ses');
import { CfnReceiptFilter } from '@aws-cdk/aws-ses';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnReceiptFilterProps (readonly)
receiptFilterName
Type:string (readonly)
class FilterProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptFilter.FilterProperty;
// CfnReceiptFilter.FilterProperty is an interface
import { CfnReceiptFilter.FilterProperty } from '@aws-cdk/aws-ses';
ipFilter

CfnReceiptFilter.FilterProperty.IpFilter

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html#cfn-ses-receiptfilter-filter-ipfilter

Type:@aws-cdk/cdk.Token or IpFilterProperty
name

CfnReceiptFilter.FilterProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html#cfn-ses-receiptfilter-filter-name

Type:string (optional)
class IpFilterProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptFilter.IpFilterProperty;
// CfnReceiptFilter.IpFilterProperty is an interface
import { CfnReceiptFilter.IpFilterProperty } from '@aws-cdk/aws-ses';
cidr

CfnReceiptFilter.IpFilterProperty.Cidr

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-ipfilter.html#cfn-ses-receiptfilter-ipfilter-cidr

Type:string
policy

CfnReceiptFilter.IpFilterProperty.Policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-ipfilter.html#cfn-ses-receiptfilter-ipfilter-policy

Type:string
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnReceiptFilterProps (interface)

class @aws-cdk/aws-ses.CfnReceiptFilterProps

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptFilterProps;
// CfnReceiptFilterProps is an interface
import { CfnReceiptFilterProps } from '@aws-cdk/aws-ses';
filter

AWS::SES::ReceiptFilter.Filter

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptfilter.html#cfn-ses-receiptfilter-filter

Type:@aws-cdk/cdk.Token or FilterProperty

CfnReceiptRule

class @aws-cdk/aws-ses.CfnReceiptRule(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRule;
const { CfnReceiptRule } = require('@aws-cdk/aws-ses');
import { CfnReceiptRule } from '@aws-cdk/aws-ses';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnReceiptRuleProps (readonly)
receiptRuleName
Type:string (readonly)
class ActionProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRule.ActionProperty;
// CfnReceiptRule.ActionProperty is an interface
import { CfnReceiptRule.ActionProperty } from '@aws-cdk/aws-ses';
addHeaderAction

CfnReceiptRule.ActionProperty.AddHeaderAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-addheaderaction

Type:@aws-cdk/cdk.Token or AddHeaderActionProperty (optional)
bounceAction

CfnReceiptRule.ActionProperty.BounceAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-bounceaction

Type:@aws-cdk/cdk.Token or BounceActionProperty (optional)
lambdaAction

CfnReceiptRule.ActionProperty.LambdaAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-lambdaaction

Type:@aws-cdk/cdk.Token or LambdaActionProperty (optional)
s3Action

CfnReceiptRule.ActionProperty.S3Action

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-s3action

Type:@aws-cdk/cdk.Token or S3ActionProperty (optional)
snsAction

CfnReceiptRule.ActionProperty.SNSAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-snsaction

Type:@aws-cdk/cdk.Token or SNSActionProperty (optional)
stopAction

CfnReceiptRule.ActionProperty.StopAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-stopaction

Type:@aws-cdk/cdk.Token or StopActionProperty (optional)
workmailAction

CfnReceiptRule.ActionProperty.WorkmailAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-workmailaction

Type:@aws-cdk/cdk.Token or WorkmailActionProperty (optional)
class AddHeaderActionProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRule.AddHeaderActionProperty;
// CfnReceiptRule.AddHeaderActionProperty is an interface
import { CfnReceiptRule.AddHeaderActionProperty } from '@aws-cdk/aws-ses';
headerName

CfnReceiptRule.AddHeaderActionProperty.HeaderName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headername

Type:string
headerValue

CfnReceiptRule.AddHeaderActionProperty.HeaderValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headervalue

Type:string
class BounceActionProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRule.BounceActionProperty;
// CfnReceiptRule.BounceActionProperty is an interface
import { CfnReceiptRule.BounceActionProperty } from '@aws-cdk/aws-ses';
message

CfnReceiptRule.BounceActionProperty.Message

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-message

Type:string
sender

CfnReceiptRule.BounceActionProperty.Sender

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-sender

Type:string
smtpReplyCode

CfnReceiptRule.BounceActionProperty.SmtpReplyCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-smtpreplycode

Type:string
statusCode

CfnReceiptRule.BounceActionProperty.StatusCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-statuscode

Type:string (optional)
topicArn

CfnReceiptRule.BounceActionProperty.TopicArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-topicarn

Type:string (optional)
class LambdaActionProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRule.LambdaActionProperty;
// CfnReceiptRule.LambdaActionProperty is an interface
import { CfnReceiptRule.LambdaActionProperty } from '@aws-cdk/aws-ses';
functionArn

CfnReceiptRule.LambdaActionProperty.FunctionArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-functionarn

Type:string
invocationType

CfnReceiptRule.LambdaActionProperty.InvocationType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-invocationtype

Type:string (optional)
topicArn

CfnReceiptRule.LambdaActionProperty.TopicArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-topicarn

Type:string (optional)
class RuleProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRule.RuleProperty;
// CfnReceiptRule.RuleProperty is an interface
import { CfnReceiptRule.RuleProperty } from '@aws-cdk/aws-ses';
actions

CfnReceiptRule.RuleProperty.Actions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-actions

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ActionProperty)[] (optional)
enabled

CfnReceiptRule.RuleProperty.Enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-enabled

Type:boolean or @aws-cdk/cdk.Token (optional)
name

CfnReceiptRule.RuleProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-name

Type:string (optional)
recipients

CfnReceiptRule.RuleProperty.Recipients

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-recipients

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
scanEnabled

CfnReceiptRule.RuleProperty.ScanEnabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-scanenabled

Type:boolean or @aws-cdk/cdk.Token (optional)
tlsPolicy

CfnReceiptRule.RuleProperty.TlsPolicy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-tlspolicy

Type:string (optional)
class S3ActionProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRule.S3ActionProperty;
// CfnReceiptRule.S3ActionProperty is an interface
import { CfnReceiptRule.S3ActionProperty } from '@aws-cdk/aws-ses';
bucketName

CfnReceiptRule.S3ActionProperty.BucketName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-bucketname

Type:string
kmsKeyArn

CfnReceiptRule.S3ActionProperty.KmsKeyArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-kmskeyarn

Type:string (optional)
objectKeyPrefix

CfnReceiptRule.S3ActionProperty.ObjectKeyPrefix

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-objectkeyprefix

Type:string (optional)
topicArn

CfnReceiptRule.S3ActionProperty.TopicArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-topicarn

Type:string (optional)
class SNSActionProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRule.SNSActionProperty;
// CfnReceiptRule.SNSActionProperty is an interface
import { CfnReceiptRule.SNSActionProperty } from '@aws-cdk/aws-ses';
encoding

CfnReceiptRule.SNSActionProperty.Encoding

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-encoding

Type:string (optional)
topicArn

CfnReceiptRule.SNSActionProperty.TopicArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-topicarn

Type:string (optional)
class StopActionProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRule.StopActionProperty;
// CfnReceiptRule.StopActionProperty is an interface
import { CfnReceiptRule.StopActionProperty } from '@aws-cdk/aws-ses';
scope

CfnReceiptRule.StopActionProperty.Scope

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-scope

Type:string
topicArn

CfnReceiptRule.StopActionProperty.TopicArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-topicarn

Type:string (optional)
class WorkmailActionProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRule.WorkmailActionProperty;
// CfnReceiptRule.WorkmailActionProperty is an interface
import { CfnReceiptRule.WorkmailActionProperty } from '@aws-cdk/aws-ses';
organizationArn

CfnReceiptRule.WorkmailActionProperty.OrganizationArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-organizationarn

Type:string
topicArn

CfnReceiptRule.WorkmailActionProperty.TopicArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-topicarn

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnReceiptRuleProps (interface)

class @aws-cdk/aws-ses.CfnReceiptRuleProps

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRuleProps;
// CfnReceiptRuleProps is an interface
import { CfnReceiptRuleProps } from '@aws-cdk/aws-ses';
rule

AWS::SES::ReceiptRule.Rule

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rule

Type:@aws-cdk/cdk.Token or RuleProperty
ruleSetName

AWS::SES::ReceiptRule.RuleSetName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rulesetname

Type:string
after

AWS::SES::ReceiptRule.After

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-after

Type:string (optional)

CfnReceiptRuleSet

class @aws-cdk/aws-ses.CfnReceiptRuleSet(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRuleSet;
const { CfnReceiptRuleSet } = require('@aws-cdk/aws-ses');
import { CfnReceiptRuleSet } from '@aws-cdk/aws-ses';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnReceiptRuleSetProps (readonly)
receiptRuleSetName
Type:string (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnReceiptRuleSetProps (interface)

class @aws-cdk/aws-ses.CfnReceiptRuleSetProps

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnReceiptRuleSetProps;
// CfnReceiptRuleSetProps is an interface
import { CfnReceiptRuleSetProps } from '@aws-cdk/aws-ses';
ruleSetName

AWS::SES::ReceiptRuleSet.RuleSetName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptruleset.html#cfn-ses-receiptruleset-rulesetname

Type:string (optional)

CfnTemplate

class @aws-cdk/aws-ses.CfnTemplate(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnTemplate;
const { CfnTemplate } = require('@aws-cdk/aws-ses');
import { CfnTemplate } from '@aws-cdk/aws-ses';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnTemplateProps (readonly)
templateId
Type:string (readonly)
class TemplateProperty

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnTemplate.TemplateProperty;
// CfnTemplate.TemplateProperty is an interface
import { CfnTemplate.TemplateProperty } from '@aws-cdk/aws-ses';
htmlPart

CfnTemplate.TemplateProperty.HtmlPart

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-htmlpart

Type:string (optional)
subjectPart

CfnTemplate.TemplateProperty.SubjectPart

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-subjectpart

Type:string (optional)
templateName

CfnTemplate.TemplateProperty.TemplateName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-templatename

Type:string (optional)
textPart

CfnTemplate.TemplateProperty.TextPart

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-textpart

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnTemplateProps (interface)

class @aws-cdk/aws-ses.CfnTemplateProps

Language-specific names:

using Amazon.CDK.AWS.SES;
import software.amazon.awscdk.services.ses.CfnTemplateProps;
// CfnTemplateProps is an interface
import { CfnTemplateProps } from '@aws-cdk/aws-ses';
template

AWS::SES::Template.Template

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-template.html#cfn-ses-template-template

Type:@aws-cdk/cdk.Token or TemplateProperty (optional)