Package software.amazon.awscdk.services.securitylake

Class CfnSubscriberNotification

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.securitylake.CfnSubscriberNotification

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-27T17:02:10.117Z")
@Stability(Stable)
public class CfnSubscriberNotification
extends CfnResource
implements IInspectable

Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake.

You can create only one subscriber notification per subscriber.

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.securitylake.*;
 Object sqsNotificationConfiguration;
 CfnSubscriberNotification cfnSubscriberNotification = CfnSubscriberNotification.Builder.create(this, "MyCfnSubscriberNotification")
         .notificationConfiguration(NotificationConfigurationProperty.builder()
                 .httpsNotificationConfiguration(HttpsNotificationConfigurationProperty.builder()
                         .endpoint("endpoint")
                         .targetRoleArn("targetRoleArn")
                         // the properties below are optional
                         .authorizationApiKeyName("authorizationApiKeyName")
                         .authorizationApiKeyValue("authorizationApiKeyValue")
                         .httpMethod("httpMethod")
                         .build())
                 .sqsNotificationConfiguration(sqsNotificationConfiguration)
                 .build())
         .subscriberArn("subscriberArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscribernotification.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnSubscriberNotification.Builder	A fluent builder for CfnSubscriberNotification.
static interface	CfnSubscriberNotification.HttpsNotificationConfigurationProperty	Specify the configurations you want to use for HTTPS subscriber notification.
static interface	CfnSubscriberNotification.NotificationConfigurationProperty	Specify the configurations you want to use for subscriber notification.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSubscriberNotification(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSubscriberNotification(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSubscriberNotification(software.constructs.Construct scope, String id, CfnSubscriberNotificationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrSubscriberEndpoint()	The endpoint the subscriber should listen to for notifications.
protected Map<String,Object>	getCfnProperties()
Object	getNotificationConfiguration()	Specify the configurations you want to use for subscriber notification.
String	getSubscriberArn()	The Amazon Resource Name (ARN) of the Security Lake subscriber.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setNotificationConfiguration(IResolvable value)	Specify the configurations you want to use for subscriber notification.
void	setNotificationConfiguration(CfnSubscriberNotification.NotificationConfigurationProperty value)	Specify the configurations you want to use for subscriber notification.
void	setSubscriberArn(String value)	The Amazon Resource Name (ARN) of the Security Lake subscriber.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSubscriberNotification

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

CfnSubscriberNotification

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

CfnSubscriberNotification

@Stability(Stable)
public CfnSubscriberNotification(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSubscriberNotificationProps 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. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrSubscriberEndpoint

@Stability(Stable)
@NotNull
public String getAttrSubscriberEndpoint()

The endpoint the subscriber should listen to for notifications.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getNotificationConfiguration

@Stability(Stable)
@NotNull
public Object getNotificationConfiguration()

Specify the configurations you want to use for subscriber notification.

setNotificationConfiguration

@Stability(Stable)
public void setNotificationConfiguration(@NotNull
 IResolvable value)

Specify the configurations you want to use for subscriber notification.

setNotificationConfiguration

@Stability(Stable)
public void setNotificationConfiguration(@NotNull
 CfnSubscriberNotification.NotificationConfigurationProperty value)

Specify the configurations you want to use for subscriber notification.

getSubscriberArn

@Stability(Stable)
@NotNull
public String getSubscriberArn()

The Amazon Resource Name (ARN) of the Security Lake subscriber.

setSubscriberArn

@Stability(Stable)
public void setSubscriberArn(@NotNull
 String value)

The Amazon Resource Name (ARN) of the Security Lake subscriber.