Package software.amazon.awscdk.services.ses.actions

Interface WorkMailProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WorkMailProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.839Z")
@Stability(Stable)
public interface WorkMailProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for a WorkMail action.

Example:

 // 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.actions.*;
 import software.amazon.awscdk.services.sns.*;
 Topic topic;
 WorkMailProps workMailProps = WorkMailProps.builder()
         .organizationArn("organizationArn")
         // the properties below are optional
         .topic(topic)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WorkMailProps.Builder	A builder for WorkMailProps
static final class	WorkMailProps.Jsii$Proxy	An implementation for WorkMailProps

Method Summary

Modifier and Type	Method	Description
static WorkMailProps.Builder	builder()
String	getOrganizationArn()	The WorkMail organization ARN.
default ITopic	getTopic()	The SNS topic to notify when the WorkMail action is taken.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOrganizationArn

@Stability(Stable)
@NotNull
String getOrganizationArn()

The WorkMail organization ARN.

Amazon WorkMail organization ARNs are in the form arn:aws:workmail:region:account_ID:organization/organization_ID

Example:

 "arn:aws:workmail:us-east-1:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7";
 

getTopic

@Stability(Stable)
@Nullable
default ITopic getTopic()

The SNS topic to notify when the WorkMail action is taken.

Default: - no topic will be attached to the action

builder

@Stability(Stable)
static WorkMailProps.Builder builder()

Returns:

a WorkMailProps.Builder of WorkMailProps