ConfigurationSet L2 construct
A configuration set.
Example
new ses.ConfigurationSet(this, 'ConfigurationSet', {
customTrackingRedirectDomain: 'track.cdk.dev',
customTrackingHttpsPolicy: ses.HttpsPolicy.REQUIRE,
});
ses.ConfigurationSet(self, "ConfigurationSet",
custom_tracking_redirect_domain="track.cdk.dev",
custom_tracking_https_policy=ses.HttpsPolicy.REQUIRE
)
ConfigurationSet.Builder.create(this, "ConfigurationSet")
.customTrackingRedirectDomain("track.cdk.dev")
.customTrackingHttpsPolicy(HttpsPolicy.REQUIRE)
.build();
// Install: dotnet add package Amazon.CDK.Lib
new ConfigurationSet(this, "ConfigurationSet", new ConfigurationSetProps {
CustomTrackingRedirectDomain = "track.cdk.dev",
CustomTrackingHttpsPolicy = HttpsPolicy.REQUIRE
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
ses.NewConfigurationSet(this, jsii.String("ConfigurationSet"), &ConfigurationSetProps{
CustomTrackingRedirectDomain: jsii.String("track.cdk.dev"),
CustomTrackingHttpsPolicy: ses.HttpsPolicy_REQUIRE,
})
Initializer
new ConfigurationSet(scope: Construct, id: string, props?: ConfigurationSetProps)
ConfigurationSet(scope: Construct, id: str, props: typing.Optional[ConfigurationSetProps] = None)
new ConfigurationSet(Construct scope, String id, ConfigurationSetProps props)
new ConfigurationSet(Construct scope, string id, ConfigurationSetProps? props = null)
NewConfigurationSet(Scope Construct, Id *string, Props ConfigurationSetProps)
Construct Props
autoValidationThresholdoptionalAutoValidationThresholdauto_validation_thresholdoptionalAutoValidationThresholdautoValidationThresholdoptionalAutoValidationThresholdAutoValidationThresholdoptionalAutoValidationThresholdAutoValidationThresholdoptionalAutoValidationThreshold#Default: inherit the account-level Auto Validation settings
When set, Auto Validation is enabled for this configuration set with the specified confidence threshold. Cannot be combined with disableAutoValidation: true.
configurationSetNameoptionalstringconfiguration_set_nameoptionalstrconfigurationSetNameoptionalStringConfigurationSetNameoptionalstringConfigurationSetNameoptional*string#Default: a CloudFormation generated name
customTrackingHttpsPolicyoptionalHttpsPolicycustom_tracking_https_policyoptionalHttpsPolicycustomTrackingHttpsPolicyoptionalHttpsPolicyCustomTrackingHttpsPolicyoptionalHttpsPolicyCustomTrackingHttpsPolicyoptionalHttpsPolicy#Default: HttpsPolicy.OPTIONAL if customTrackingRedirectDomain is set, otherwise undefined
customTrackingRedirectDomainoptionalstringcustom_tracking_redirect_domainoptionalstrcustomTrackingRedirectDomainoptionalStringCustomTrackingRedirectDomainoptionalstringCustomTrackingRedirectDomainoptional*string#Default: use the default awstrack.me domain
dedicatedIpPooloptionalIDedicatedIpPoolRefdedicated_ip_pooloptionalIDedicatedIpPoolRefdedicatedIpPooloptionalIDedicatedIpPoolRefDedicatedIpPooloptionalIDedicatedIpPoolRefDedicatedIpPooloptionalIDedicatedIpPoolRef#Default: do not use a dedicated IP pool
disableAutoValidationoptionalbooleandisable_auto_validationoptionalbooldisableAutoValidationoptionalBooleanDisableAutoValidationoptionalboolDisableAutoValidationoptional*bool#Default: inherit the account-level Auto Validation settings when autoValidationThreshold is also unspecified
notes
true: explicitly disable Auto Validation for this configuration set. Cannot be combined withautoValidationThreshold.false: explicitly enable Auto Validation for this configuration set even if it is disabled at the account level. The threshold falls back to the SES default unlessautoValidationThresholdis also specified.undefined: inherit the account-level setting whenautoValidationThresholdis also not specified.
disableSuppressionListoptionalbooleandisable_suppression_listoptionalbooldisableSuppressionListoptionalBooleanDisableSuppressionListoptionalboolDisableSuppressionListoptional*bool= false#email sent with this configuration set will not use any suppression settings at all
maxDeliveryDurationoptionalDurationmax_delivery_durationoptionalDurationmaxDeliveryDurationoptionalDurationMaxDeliveryDurationoptionalDurationMaxDeliveryDurationoptionalDuration#Default: undefined - SES defaults to 14 hours
This value must be greater than or equal to 5 minutes and less than or equal to 14 hours.
reputationMetricsoptionalbooleanreputation_metricsoptionalboolreputationMetricsoptionalBooleanReputationMetricsoptionalboolReputationMetricsoptional*bool= true#sendingEnabledoptionalbooleansending_enabledoptionalboolsendingEnabledoptionalBooleanSendingEnabledoptionalboolSendingEnabledoptional*bool= true#suppressionReasonsoptionalSuppressionReasonssuppression_reasonsoptionalSuppressionReasonssuppressionReasonsoptionalSuppressionReasonsSuppressionReasonsoptionalSuppressionReasonsSuppressionReasonsoptionalSuppressionReasons#Default: use account level settings
tlsPolicyoptionalConfigurationSetTlsPolicytls_policyoptionalConfigurationSetTlsPolicytlsPolicyoptionalConfigurationSetTlsPolicyTlsPolicyoptionalConfigurationSetTlsPolicyTlsPolicyoptionalConfigurationSetTlsPolicy#Default: ConfigurationSetTlsPolicy.OPTIONAL
vdmOptionsoptionalVdmOptionsvdm_optionsoptionalVdmOptionsvdmOptionsoptionalVdmOptionsVdmOptionsoptionalVdmOptionsVdmOptionsoptionalVdmOptions#Default: VDM options not configured at the configuration set level. In this case, use account level settings. (To set the account level settings using CDK, use the VdmAttributes Construct.)
Properties
configurationSetNamestringconfiguration_set_namestrconfigurationSetNameStringConfigurationSetNamestringConfigurationSetName*string#configurationSetRefConfigurationSetReferenceconfiguration_set_refConfigurationSetReferenceconfigurationSetRefConfigurationSetReferenceConfigurationSetRefConfigurationSetReferenceConfigurationSetRefConfigurationSetReference#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#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*stringstatic#Methods
addEventDestination(id: string, options: ConfigurationSetEventDestinationOptions): ConfigurationSetEventDestinationdef add_event_destination(self, id: str, options: ConfigurationSetEventDestinationOptions) -> ConfigurationSetEventDestinationpublic ConfigurationSetEventDestination addEventDestination(String id, ConfigurationSetEventDestinationOptions options)public ConfigurationSetEventDestination AddEventDestination(string id, ConfigurationSetEventDestinationOptions options)func AddEventDestination(Id *string, Options ConfigurationSetEventDestinationOptions) ConfigurationSetEventDestination#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)#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)#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).
fromConfigurationSetName(scope: Construct, id: string, configurationSetName: string): IConfigurationSet@staticmethod def from_configuration_set_name(scope: Construct, id: str, configuration_set_name: str) -> IConfigurationSetpublic static IConfigurationSet fromConfigurationSetName(Construct scope, String id, String configurationSetName)public static IConfigurationSet FromConfigurationSetName(Construct scope, string id, string configurationSetName)func FromConfigurationSetName(Scope Construct, Id *string, ConfigurationSetName *string) IConfigurationSetstatic#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#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#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#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.