CfnSubscriberNotificationPropsMixin

class aws_cdk.mixins_preview.aws_securitylake.mixins.CfnSubscriberNotificationPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscribernotification.html
CloudformationResource:: AWS::SecurityLake::SubscriberNotification
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_securitylake import mixins as securitylake_mixins

# sqs_notification_configuration: Any

cfn_subscriber_notification_props_mixin = securitylake_mixins.CfnSubscriberNotificationPropsMixin(securitylake_mixins.CfnSubscriberNotificationMixinProps(
    notification_configuration=securitylake_mixins.CfnSubscriberNotificationPropsMixin.NotificationConfigurationProperty(
        https_notification_configuration=securitylake_mixins.CfnSubscriberNotificationPropsMixin.HttpsNotificationConfigurationProperty(
            authorization_api_key_name="authorizationApiKeyName",
            authorization_api_key_value="authorizationApiKeyValue",
            endpoint="endpoint",
            http_method="httpMethod",
            target_role_arn="targetRoleArn"
        ),
        sqs_notification_configuration=sqs_notification_configuration
    ),
    subscriber_arn="subscriberArn"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SecurityLake::SubscriberNotification.

Parameters:

props (Union[CfnSubscriberNotificationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['notificationConfiguration', 'subscriberArn']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

HttpsNotificationConfigurationProperty

class CfnSubscriberNotificationPropsMixin.HttpsNotificationConfigurationProperty(*, authorization_api_key_name=None, authorization_api_key_value=None, endpoint=None, http_method=None, target_role_arn=None)

Bases: object

Specify the configurations you want to use for HTTPS subscriber notification.

Parameters:

authorization_api_key_name (Optional[str]) – The key name for the notification subscription.
authorization_api_key_value (Optional[str]) – The key value for the notification subscription.
endpoint (Optional[str]) – The subscription endpoint in Security Lake . If you prefer notification with an HTTPS endpoint, populate this field.
http_method (Optional[str]) – The HTTPS method used for the notification subscription.
target_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and AWS Managed Policies in the Amazon Security Lake User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_securitylake import mixins as securitylake_mixins

https_notification_configuration_property = securitylake_mixins.CfnSubscriberNotificationPropsMixin.HttpsNotificationConfigurationProperty(
    authorization_api_key_name="authorizationApiKeyName",
    authorization_api_key_value="authorizationApiKeyValue",
    endpoint="endpoint",
    http_method="httpMethod",
    target_role_arn="targetRoleArn"
)

Attributes

authorization_api_key_name

The key name for the notification subscription.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-authorizationapikeyname

authorization_api_key_value

The key value for the notification subscription.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-authorizationapikeyvalue

endpoint

The subscription endpoint in Security Lake .

If you prefer notification with an HTTPS endpoint, populate this field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-endpoint

http_method

The HTTPS method used for the notification subscription.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-httpmethod

target_role_arn

The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created.

For more information about ARNs and how to use them in policies, see Managing data access and AWS Managed Policies in the Amazon Security Lake User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-targetrolearn

NotificationConfigurationProperty

class CfnSubscriberNotificationPropsMixin.NotificationConfigurationProperty(*, https_notification_configuration=None, sqs_notification_configuration=None)

Bases: object

Specify the configurations you want to use for subscriber notification.

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

Parameters:

https_notification_configuration (Union[IResolvable, HttpsNotificationConfigurationProperty, Dict[str, Any], None]) – The configurations used for HTTPS subscriber notification.
sqs_notification_configuration (Any) – The configurations for SQS subscriber notification. The members of this structure are context-dependent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-notificationconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_securitylake import mixins as securitylake_mixins

# sqs_notification_configuration: Any

notification_configuration_property = securitylake_mixins.CfnSubscriberNotificationPropsMixin.NotificationConfigurationProperty(
    https_notification_configuration=securitylake_mixins.CfnSubscriberNotificationPropsMixin.HttpsNotificationConfigurationProperty(
        authorization_api_key_name="authorizationApiKeyName",
        authorization_api_key_value="authorizationApiKeyValue",
        endpoint="endpoint",
        http_method="httpMethod",
        target_role_arn="targetRoleArn"
    ),
    sqs_notification_configuration=sqs_notification_configuration
)

Attributes

https_notification_configuration

The configurations used for HTTPS subscriber notification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-notificationconfiguration.html#cfn-securitylake-subscribernotification-notificationconfiguration-httpsnotificationconfiguration

sqs_notification_configuration

The configurations for SQS subscriber notification.

The members of this structure are context-dependent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-notificationconfiguration.html#cfn-securitylake-subscribernotification-notificationconfiguration-sqsnotificationconfiguration