Documentation

Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.

See: newSubscriberResource smart constructor.

Create a value of SubscriberResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessTypes:SubscriberResource', subscriberResource_accessTypes - You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION.

$sel:createdAt:SubscriberResource', subscriberResource_createdAt - The date and time when the subscription was created.

$sel:externalId:SubscriberResource', subscriberResource_externalId - The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

$sel:roleArn:SubscriberResource', subscriberResource_roleArn - The Amazon Resource Name (ARN) specifying the role of the subscriber.

$sel:s3BucketArn:SubscriberResource', subscriberResource_s3BucketArn - The ARN for the Amazon S3 bucket.

$sel:snsArn:SubscriberResource', subscriberResource_snsArn - The ARN for the Amazon Simple Notification Service.

$sel:subscriberDescription:SubscriberResource', subscriberResource_subscriberDescription - The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriptionId.

$sel:subscriberName:SubscriberResource', subscriberResource_subscriberName - The name of your Amazon Security Lake subscriber account.

$sel:subscriptionEndpoint:SubscriberResource', subscriberResource_subscriptionEndpoint - The subscription endpoint to which exception messages are posted.

$sel:subscriptionProtocol:SubscriberResource', subscriberResource_subscriptionProtocol - The subscription protocol to which exception messages are posted.

$sel:subscriptionStatus:SubscriberResource', subscriberResource_subscriptionStatus - The subscription status of the Amazon Security Lake subscriber account.

$sel:updatedAt:SubscriberResource', subscriberResource_updatedAt - The date and time when the subscription was created.

$sel:accountId:SubscriberResource', subscriberResource_accountId - The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

$sel:sourceTypes:SubscriberResource', subscriberResource_sourceTypes - Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

$sel:subscriptionId:SubscriberResource', subscriberResource_subscriptionId - The subscription ID of the Amazon Security Lake subscriber account.

You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION.

The date and time when the subscription was created.

The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

The Amazon Resource Name (ARN) specifying the role of the subscriber.

The ARN for the Amazon S3 bucket.

The ARN for the Amazon Simple Notification Service.

The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriptionId.

The name of your Amazon Security Lake subscriber account.

The subscription endpoint to which exception messages are posted.

The subscription protocol to which exception messages are posted.

The subscription status of the Amazon Security Lake subscriber account.

The date and time when the subscription was created.

The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

The subscription ID of the Amazon Security Lake subscriber account.