ConfigurationSetEventDestination L2 construct
A configuration set event destination.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ses as ses } from 'aws-cdk-lib';
import { aws_ses as interfaces_ses } from 'aws-cdk-lib/interfaces';
declare const configurationSetRef: interfaces_ses.IConfigurationSetRef;
declare const eventDestination: ses.EventDestination;
const configurationSetEventDestination = new ses.ConfigurationSetEventDestination(this, 'MyConfigurationSetEventDestination', {
configurationSet: configurationSetRef,
destination: eventDestination,
// the properties below are optional
configurationSetEventDestinationName: 'configurationSetEventDestinationName',
enabled: false,
events: [ses.EmailSendingEvent.SEND],
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ses as ses
from aws_cdk.interfaces import aws_ses as interfaces_ses
# configuration_set_ref: interfaces_ses.IConfigurationSetRef
# event_destination: ses.EventDestination
configuration_set_event_destination = ses.ConfigurationSetEventDestination(self, "MyConfigurationSetEventDestination",
configuration_set=configuration_set_ref,
destination=event_destination,
# the properties below are optional
configuration_set_event_destination_name="configurationSetEventDestinationName",
enabled=False,
events=[ses.EmailSendingEvent.SEND]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ses.*;
import software.amazon.awscdk.interfaces.ses.*;
IConfigurationSetRef configurationSetRef;
EventDestination eventDestination;
ConfigurationSetEventDestination configurationSetEventDestination = ConfigurationSetEventDestination.Builder.create(this, "MyConfigurationSetEventDestination")
.configurationSet(configurationSetRef)
.destination(eventDestination)
// the properties below are optional
.configurationSetEventDestinationName("configurationSetEventDestinationName")
.enabled(false)
.events(List.of(EmailSendingEvent.SEND))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SES;
using Amazon.CDK.Interfaces.SES;
IConfigurationSetRef configurationSetRef;
EventDestination eventDestination;
var configurationSetEventDestination = new ConfigurationSetEventDestination(this, "MyConfigurationSetEventDestination", new ConfigurationSetEventDestinationProps {
ConfigurationSet = configurationSetRef,
Destination = eventDestination,
// the properties below are optional
ConfigurationSetEventDestinationName = "configurationSetEventDestinationName",
Enabled = false,
Events = new [] { EmailSendingEvent.SEND }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var configurationSetRef IConfigurationSetRef
var eventDestination EventDestination
configurationSetEventDestination := awscdk.Aws_ses.NewConfigurationSetEventDestination(this, jsii.String("MyConfigurationSetEventDestination"), &ConfigurationSetEventDestinationProps{
ConfigurationSet: configurationSetRef,
Destination: eventDestination,
// the properties below are optional
ConfigurationSetEventDestinationName: jsii.String("configurationSetEventDestinationName"),
Enabled: jsii.Boolean(false),
Events: []EmailSendingEvent{
awscdk.*Aws_ses.EmailSendingEvent_SEND,
},
})
Initializer
ts
new ConfigurationSetEventDestination(scope: Construct, id: string, props: ConfigurationSetEventDestinationProps)
python
ConfigurationSetEventDestination(scope: Construct, id: str, props: ConfigurationSetEventDestinationProps)
java
new ConfigurationSetEventDestination(Construct scope, String id, ConfigurationSetEventDestinationProps props)
csharp
new ConfigurationSetEventDestination(Construct scope, string id, ConfigurationSetEventDestinationProps props)
go
NewConfigurationSetEventDestination(Scope Construct, Id *string, Props ConfigurationSetEventDestinationProps)
Construct Props
configurationSetIConfigurationSetRefconfiguration_setIConfigurationSetRefconfigurationSetIConfigurationSetRefConfigurationSetIConfigurationSetRefConfigurationSetIConfigurationSetRefrequired#The configuration set that contains the event destination.
configurationSetEventDestinationNamestringconfiguration_set_event_destination_namestrconfigurationSetEventDestinationNameStringConfigurationSetEventDestinationNamestringConfigurationSetEventDestinationName*string= a CloudFormation generated name#A name for the configuration set event destination.
destinationEventDestinationdestinationEventDestinationdestinationEventDestinationDestinationEventDestinationDestinationEventDestinationrequired#The event destination.
Whether Amazon SES publishes events to this destination.
eventsEmailSendingEvent[]eventstyping.List[EmailSendingEvent]eventsList<EmailSendingEvent>EventsEmailSendingEvent[]Events*[]EmailSendingEvent= send all event types#The type of email sending events to publish to the event destination.
Properties
configurationSetEventDestinationIdstringconfiguration_set_event_destination_idstrconfigurationSetEventDestinationIdStringConfigurationSetEventDestinationIdstringConfigurationSetEventDestinationId*stringrequired#The ID of the configuration set event destination.
configurationSetEventDestinationRefConfigurationSetEventDestinationReferenceconfiguration_set_event_destination_refConfigurationSetEventDestinationReferenceconfigurationSetEventDestinationRefConfigurationSetEventDestinationReferenceConfigurationSetEventDestinationRefConfigurationSetEventDestinationReferenceConfigurationSetEventDestinationRefConfigurationSetEventDestinationReferencerequired#A reference to a ConfigurationSetEventDestination resource.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
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.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
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.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
fromConfigurationSetEventDestinationAttributes(scope: Construct, id: string, attrs: ConfigurationSetEventDestinationAttributes): IConfigurationSetEventDestination@staticmethod def from_configuration_set_event_destination_attributes(scope: Construct, id: str, attrs: ConfigurationSetEventDestinationAttributes) -> IConfigurationSetEventDestinationpublic static IConfigurationSetEventDestination fromConfigurationSetEventDestinationAttributes(Construct scope, String id, ConfigurationSetEventDestinationAttributes attrs)public static IConfigurationSetEventDestination FromConfigurationSetEventDestinationAttributes(Construct scope, string id, ConfigurationSetEventDestinationAttributes attrs)func FromConfigurationSetEventDestinationAttributes(Scope Construct, Id *string, Attrs ConfigurationSetEventDestinationAttributes) IConfigurationSetEventDestinationstatic#Import an existing event destination from its attributes.
fromConfigurationSetEventDestinationId(scope: Construct, id: string, configurationSetEventDestinationId: string): IConfigurationSetEventDestination@staticmethod def from_configuration_set_event_destination_id(scope: Construct, id: str, configuration_set_event_destination_id: str) -> IConfigurationSetEventDestinationpublic static IConfigurationSetEventDestination fromConfigurationSetEventDestinationId(Construct scope, String id, String configurationSetEventDestinationId)public static IConfigurationSetEventDestination FromConfigurationSetEventDestinationId(Construct scope, string id, string configurationSetEventDestinationId)func FromConfigurationSetEventDestinationId(Scope Construct, Id *string, ConfigurationSetEventDestinationId *string) IConfigurationSetEventDestinationstatic#Import an existing event destination by its ID.
An ID alone does not identify the configuration set the destination belongs to, so configurationSetName is not available on the returned reference. Use fromConfigurationSetEventDestinationAttributes() if you need it.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) 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.