software.amazon.awscdk.services.ses

Class CfnContactList

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.CfnContactList

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.183Z")
 @Stability(value=Stable)
public class CfnContactList
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SES::ContactList`.

A list that contains contacts that have subscribed to a particular topic or topics.

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.*;
 CfnContactList cfnContactList = CfnContactList.Builder.create(this, "MyCfnContactList")
         .contactListName("contactListName")
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .topics(List.of(TopicProperty.builder()
                 .defaultSubscriptionStatus("defaultSubscriptionStatus")
                 .displayName("displayName")
                 .topicName("topicName")
                 // the properties below are optional
                 .description("description")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnContactList.Builder A fluent builder for CfnContactList.
static interface	CfnContactList.TopicProperty An interest group, theme, or label within a list.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnContactList(software.constructs.Construct scope, String id) Create a new `AWS::SES::ContactList`.
	CfnContactList(software.constructs.Construct scope, String id, CfnContactListProps props) Create a new `AWS::SES::ContactList`.
protected	CfnContactList(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnContactList(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getContactListName() The name of the contact list.
String	getDescription() A description of what the contact list is about.
TagManager	getTags() The tags associated with a contact list.
Object	getTopics() An interest group, theme, or label within a list.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContactListName(String value) The name of the contact list.
void	setDescription(String value) A description of what the contact list is about.
void	setTopics(IResolvable value) An interest group, theme, or label within a list.
void	setTopics(List<Object> value) An interest group, theme, or label within a list.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnContactList

protected CfnContactList(software.amazon.jsii.JsiiObjectRef objRef)

CfnContactList

protected CfnContactList(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnContactList

@Stability(value=Stable)
public CfnContactList(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @Nullable
                                               CfnContactListProps props)

Create a new `AWS::SES::ContactList`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnContactList

@Stability(value=Stable)
public CfnContactList(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id)

Create a new `AWS::SES::ContactList`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags associated with a contact list.

getContactListName

@Stability(value=Stable)
 @Nullable
public String getContactListName()

The name of the contact list.

setContactListName

@Stability(value=Stable)
public void setContactListName(@Nullable
                                                        String value)

The name of the contact list.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of what the contact list is about.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of what the contact list is about.

getTopics

@Stability(value=Stable)
 @Nullable
public Object getTopics()

An interest group, theme, or label within a list.

A contact list can have multiple topics.

setTopics

@Stability(value=Stable)
public void setTopics(@Nullable
                                               IResolvable value)

An interest group, theme, or label within a list.

A contact list can have multiple topics.

setTopics

@Stability(value=Stable)
public void setTopics(@Nullable
                                               List<Object> value)

An interest group, theme, or label within a list.

A contact list can have multiple topics.