Class CfnMailManagerArchive
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ses.CfnMailManagerArchive
- All Implemented Interfaces:
IEnvironmentAware,IInspectable,ITaggableV2,IMailManagerArchiveRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
date="2025-11-04T09:27:50.597Z")
@Stability(Stable)
public class CfnMailManagerArchive
extends CfnResource
implements IInspectable, IMailManagerArchiveRef, ITaggableV2
Creates a new email archive resource for storing and retaining emails.
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.*;
CfnMailManagerArchive cfnMailManagerArchive = CfnMailManagerArchive.Builder.create(this, "MyCfnMailManagerArchive")
.archiveName("archiveName")
.kmsKeyArn("kmsKeyArn")
.retention(ArchiveRetentionProperty.builder()
.retentionPeriod("retentionPeriod")
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceThe retention policy for an email archive that specifies how long emails are kept before being automatically deleted.static final classA fluent builder forCfnMailManagerArchive.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.ses.IMailManagerArchiveRef
IMailManagerArchiveRef.Jsii$Default, IMailManagerArchiveRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnMailManagerArchive(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnMailManagerArchive(software.amazon.jsii.JsiiObjectRef objRef) CfnMailManagerArchive(software.constructs.Construct scope, String id) CfnMailManagerArchive(software.constructs.Construct scope, String id, CfnMailManagerArchiveProps props) -
Method Summary
Modifier and TypeMethodDescriptionstatic IMailManagerArchiveReffromArchiveId(software.constructs.Construct scope, String id, String archiveId) Creates a new IMailManagerArchiveRef from a archiveId.A unique name for the new archive.The Amazon Resource Name (ARN) of the archive.The unique identifier of the archive.The current state of the archive:.Tag Manager which manages the tags for this resource.The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.A reference to a MailManagerArchive resource.The period for retaining emails in the archive before automatic deletion.getTags()The tags used to organize, track, or control access for the resource.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetArchiveName(String value) A unique name for the new archive.voidsetKmsKeyArn(String value) The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.voidsetRetention(IResolvable value) The period for retaining emails in the archive before automatic deletion.voidThe period for retaining emails in the archive before automatic deletion.voidThe tags used to organize, track, or control access for the resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnMailManagerArchive
protected CfnMailManagerArchive(software.amazon.jsii.JsiiObjectRef objRef) -
CfnMailManagerArchive
protected CfnMailManagerArchive(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnMailManagerArchive
@Stability(Stable) public CfnMailManagerArchive(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnMailManagerArchiveProps props) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties.
-
CfnMailManagerArchive
@Stability(Stable) public CfnMailManagerArchive(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
fromArchiveId
@Stability(Stable) @NotNull public static IMailManagerArchiveRef fromArchiveId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String archiveId) Creates a new IMailManagerArchiveRef from a archiveId.- Parameters:
scope- This parameter is required.id- This parameter is required.archiveId- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArchiveArn
The Amazon Resource Name (ARN) of the archive. -
getAttrArchiveId
The unique identifier of the archive. -
getAttrArchiveState
The current state of the archive:.ACTIVE– The archive is ready and available for use.PENDING_DELETION– The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
-
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManagerin interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getMailManagerArchiveRef
A reference to a MailManagerArchive resource.- Specified by:
getMailManagerArchiveRefin interfaceIMailManagerArchiveRef
-
getArchiveName
A unique name for the new archive. -
setArchiveName
A unique name for the new archive. -
getKmsKeyArn
The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive. -
setKmsKeyArn
The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive. -
getRetention
The period for retaining emails in the archive before automatic deletion.Returns union: either
IResolvableorCfnMailManagerArchive.ArchiveRetentionProperty -
setRetention
The period for retaining emails in the archive before automatic deletion. -
setRetention
@Stability(Stable) public void setRetention(@Nullable CfnMailManagerArchive.ArchiveRetentionProperty value) The period for retaining emails in the archive before automatic deletion. -
getTags
The tags used to organize, track, or control access for the resource. -
setTags
The tags used to organize, track, or control access for the resource.
-