class VdmAttributes (construct)

Language	Type name
.NET	Amazon.CDK.AWS.SES.VdmAttributes
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsses#VdmAttributes
Java	software.amazon.awscdk.services.ses.VdmAttributes
Python	aws_cdk.aws_ses.VdmAttributes
TypeScript (source)	aws-cdk-lib » aws_ses » VdmAttributes

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IVdmAttributes, IVdmAttributesRef

Virtual Deliverability 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

Name	Type	Description
engagementMetrics?	boolean	Whether engagement metrics are enabled for your account.
optimizedSharedDelivery?	boolean	Whether 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

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
vdmAttributesName	string	The name of the resource behind the Virtual Deliverability Manager attributes.
vdmAttributesRef	VdmAttributesReference	A reference to a VdmAttributes resource.
vdmAttributesResourceId	string	Resource ID for the Virtual Deliverability Manager attributes.
static PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they 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 Deliverability Manager attributes.

---

vdmAttributesRef

Type: VdmAttributesReference

A reference to a VdmAttributes resource.

---

vdmAttributesResourceId

Type: string

Resource ID for the Virtual Deliverability Manager attributes.

---

static PROPERTY_INJECTION_ID

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyCrossStackReferenceStrength(strength)	Override the cross-stack reference strength for this resource.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.
static fromVdmAttributesName(scope, id, vdmAttributesName)	Use an existing Virtual Deliverability Manager attributes resource.

---

applyCrossStackReferenceStrength(strength)

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

---

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.

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

---

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 Deliverability Manager attributes resource.