Skip to content

HttpsNotificationConfiguration

Source code in docs_src/capo_securitylake/types/https_notification_configuration.py
class HttpsNotificationConfiguration(TypedDict, closed=True):
    endpoint: "str"
    """<p>The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.</p>"""
    authorization_api_key_name: NotRequired["str"]
    """<p>The key name for the notification subscription.</p>"""
    authorization_api_key_value: NotRequired["str"]
    """<p>The key value for the notification subscription.</p>"""
    http_method: NotRequired["capo_securitylake.types.http_method.HttpMethod"]
    """<p>The HTTPS method used for the notification subscription.</p>"""
    target_role_arn: "capo_securitylake.types.role_arn.RoleArn"
    """<p>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 <a href="https://docs.aws.amazon.com//security-lake/latest/userguide/subscriber-data-access.html">Managing data access</a> and <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/security-iam-awsmanpol.html">Amazon Web Services Managed Policies</a> in the <i>Amazon Security Lake User Guide</i>.</p>"""

authorization_api_key_name instance-attribute

authorization_api_key_name: NotRequired[str]

The key name for the notification subscription.

authorization_api_key_value instance-attribute

authorization_api_key_value: NotRequired[str]

The key value for the notification subscription.

endpoint instance-attribute

endpoint: str

The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.

http_method instance-attribute

http_method: NotRequired[HttpMethod]

The HTTPS method used for the notification subscription.

target_role_arn instance-attribute

target_role_arn: RoleArn

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 Amazon Web Services Managed Policies in the Amazon Security Lake User Guide.