aws-cdk-lib.aws_ses.VdmAttributes

class VdmAttributes (construct)

LanguageType name
.NETAmazon.CDK.AWS.SES.VdmAttributes
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsses#VdmAttributes
Javasoftware.amazon.awscdk.services.ses.VdmAttributes
Pythonaws_cdk.aws_ses.VdmAttributes
TypeScript (source)aws-cdk-lib » aws_ses » VdmAttributes

Implements IConstruct, IDependable, IResource, IVdmAttributes

Virtual Deliverablity Manager (VDM) attributes.

Example

// Enables engagement tracking and optimized shared delivery by default
new ses.VdmAttributes(this, 'Vdm');

Initializer

new VdmAttributes(scope: Construct, id: string, props?: VdmAttributesProps)

Parameters

  • scope Construct
  • id string
  • props VdmAttributesProps

Construct Props

NameTypeDescription
engagementMetrics?booleanWhether engagement metrics are enabled for your account.
optimizedSharedDelivery?booleanWhether optimized shared delivery is enabled for your account.

engagementMetrics?

Type: boolean (optional, default: true)

Whether engagement metrics are enabled for your account.


optimizedSharedDelivery?

Type: boolean (optional, default: true)

Whether optimized shared delivery is enabled for your account.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.
vdmAttributesNamestringThe name of the resource behind the Virtual Deliverablity Manager attributes.
vdmAttributesResourceIdstringResource ID for the Virtual Deliverablity Manager attributes.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.


vdmAttributesName

Type: string

The name of the resource behind the Virtual Deliverablity Manager attributes.


vdmAttributesResourceId

Type: string

Resource ID for the Virtual Deliverablity Manager attributes.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.
static fromVdmAttributesName(scope, id, vdmAttributesName)Use an existing Virtual Deliverablity Manager attributes resource.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromVdmAttributesName(scope, id, vdmAttributesName)

public static fromVdmAttributesName(scope: Construct, id: string, vdmAttributesName: string): IVdmAttributes

Parameters

  • scope Construct
  • id string
  • vdmAttributesName string

Returns

  • IVdmAttributes

Use an existing Virtual Deliverablity Manager attributes resource.