This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::SecurityLake::SubscriberNotification
<a name="aws-resource-securitylake-subscribernotification"></a>

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.

## Syntax
<a name="aws-resource-securitylake-subscribernotification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-securitylake-subscribernotification-syntax.json"></a>

```
{
  "Type" : "AWS::SecurityLake::SubscriberNotification",
  "Properties" : {
      "[NotificationConfiguration](#cfn-securitylake-subscribernotification-notificationconfiguration)" : NotificationConfiguration,
      "[SubscriberArn](#cfn-securitylake-subscribernotification-subscriberarn)" : String
    }
}
```

### YAML
<a name="aws-resource-securitylake-subscribernotification-syntax.yaml"></a>

```
Type: AWS::SecurityLake::SubscriberNotification
Properties:
  [NotificationConfiguration](#cfn-securitylake-subscribernotification-notificationconfiguration): 
    NotificationConfiguration
  [SubscriberArn](#cfn-securitylake-subscribernotification-subscriberarn): String
```

## Properties
<a name="aws-resource-securitylake-subscribernotification-properties"></a>

`NotificationConfiguration`  <a name="cfn-securitylake-subscribernotification-notificationconfiguration"></a>
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.   
*Required*: Yes  
*Type*: [NotificationConfiguration](aws-properties-securitylake-subscribernotification-notificationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubscriberArn`  <a name="cfn-securitylake-subscribernotification-subscriberarn"></a>
The Amazon Resource Name (ARN) of the Security Lake subscriber.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:.*$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-securitylake-subscribernotification-return-values"></a>

### Ref
<a name="aws-resource-securitylake-subscribernotification-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `ref` function, `ref` returns the type of `SubscriberArn`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-securitylake-subscribernotification-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-securitylake-subscribernotification-return-values-fn--getatt-fn--getatt"></a>

`SubscriberEndpoint`  <a name="SubscriberEndpoint-fn::getatt"></a>
Property description not available.

# AWS::SecurityLake::SubscriberNotification HttpsNotificationConfiguration
<a name="aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration"></a>

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

## Syntax
<a name="aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration-syntax.json"></a>

```
{
  "[AuthorizationApiKeyName](#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-authorizationapikeyname)" : String,
  "[AuthorizationApiKeyValue](#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-authorizationapikeyvalue)" : String,
  "[Endpoint](#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-endpoint)" : String,
  "[HttpMethod](#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-httpmethod)" : String,
  "[TargetRoleArn](#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-targetrolearn)" : String
}
```

### YAML
<a name="aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration-syntax.yaml"></a>

```
  [AuthorizationApiKeyName](#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-authorizationapikeyname): String
  [AuthorizationApiKeyValue](#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-authorizationapikeyvalue): String
  [Endpoint](#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-endpoint): String
  [HttpMethod](#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-httpmethod): String
  [TargetRoleArn](#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-targetrolearn): String
```

## Properties
<a name="aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration-properties"></a>

`AuthorizationApiKeyName`  <a name="cfn-securitylake-subscribernotification-httpsnotificationconfiguration-authorizationapikeyname"></a>
The key name for the notification subscription.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AuthorizationApiKeyValue`  <a name="cfn-securitylake-subscribernotification-httpsnotificationconfiguration-authorizationapikeyvalue"></a>
The key value for the notification subscription.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Endpoint`  <a name="cfn-securitylake-subscribernotification-httpsnotificationconfiguration-endpoint"></a>
The subscription endpoint in Security Lake. If you prefer notification with an HTTPS endpoint, populate this field.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^https?://.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HttpMethod`  <a name="cfn-securitylake-subscribernotification-httpsnotificationconfiguration-httpmethod"></a>
The HTTPS method used for the notification subscription.  
*Required*: No  
*Type*: String  
*Allowed values*: `POST | PUT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetRoleArn`  <a name="cfn-securitylake-subscribernotification-httpsnotificationconfiguration-targetrolearn"></a>
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](https://docs.aws.amazon.com///security-lake/latest/userguide/subscriber-data-access.html) and [AWS Managed Policies](https://docs.aws.amazon.com//security-lake/latest/userguide/security-iam-awsmanpol.html) in the *Amazon Security Lake User Guide*.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:.*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SecurityLake::SubscriberNotification NotificationConfiguration
<a name="aws-properties-securitylake-subscribernotification-notificationconfiguration"></a>

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. 

## Syntax
<a name="aws-properties-securitylake-subscribernotification-notificationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-securitylake-subscribernotification-notificationconfiguration-syntax.json"></a>

```
{
  "[HttpsNotificationConfiguration](#cfn-securitylake-subscribernotification-notificationconfiguration-httpsnotificationconfiguration)" : HttpsNotificationConfiguration,
  "[SqsNotificationConfiguration](#cfn-securitylake-subscribernotification-notificationconfiguration-sqsnotificationconfiguration)" : Json
}
```

### YAML
<a name="aws-properties-securitylake-subscribernotification-notificationconfiguration-syntax.yaml"></a>

```
  [HttpsNotificationConfiguration](#cfn-securitylake-subscribernotification-notificationconfiguration-httpsnotificationconfiguration): 
    HttpsNotificationConfiguration
  [SqsNotificationConfiguration](#cfn-securitylake-subscribernotification-notificationconfiguration-sqsnotificationconfiguration): Json
```

## Properties
<a name="aws-properties-securitylake-subscribernotification-notificationconfiguration-properties"></a>

`HttpsNotificationConfiguration`  <a name="cfn-securitylake-subscribernotification-notificationconfiguration-httpsnotificationconfiguration"></a>
The configurations used for HTTPS subscriber notification.  
*Required*: No  
*Type*: [HttpsNotificationConfiguration](aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SqsNotificationConfiguration`  <a name="cfn-securitylake-subscribernotification-notificationconfiguration-sqsnotificationconfiguration"></a>
The configurations for SQS subscriber notification. The members of this structure are context-dependent.  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)