Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data SubscriberResource = SubscriberResource' {
- accessTypes :: Maybe [AccessType]
- createdAt :: Maybe ISO8601
- externalId :: Maybe Text
- roleArn :: Maybe Text
- s3BucketArn :: Maybe Text
- snsArn :: Maybe Text
- subscriberDescription :: Maybe Text
- subscriberName :: Maybe Text
- subscriptionEndpoint :: Maybe Text
- subscriptionProtocol :: Maybe EndpointProtocol
- subscriptionStatus :: Maybe SubscriptionStatus
- updatedAt :: Maybe ISO8601
- accountId :: Text
- sourceTypes :: [SourceType]
- subscriptionId :: Text
- newSubscriberResource :: Text -> Text -> SubscriberResource
- subscriberResource_accessTypes :: Lens' SubscriberResource (Maybe [AccessType])
- subscriberResource_createdAt :: Lens' SubscriberResource (Maybe UTCTime)
- subscriberResource_externalId :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_roleArn :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_s3BucketArn :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_snsArn :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriberDescription :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriberName :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriptionEndpoint :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriptionProtocol :: Lens' SubscriberResource (Maybe EndpointProtocol)
- subscriberResource_subscriptionStatus :: Lens' SubscriberResource (Maybe SubscriptionStatus)
- subscriberResource_updatedAt :: Lens' SubscriberResource (Maybe UTCTime)
- subscriberResource_accountId :: Lens' SubscriberResource Text
- subscriberResource_sourceTypes :: Lens' SubscriberResource [SourceType]
- subscriberResource_subscriptionId :: Lens' SubscriberResource Text
Documentation
data SubscriberResource Source #
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.
SubscriberResource' | |
|
Instances
newSubscriberResource Source #
:: Text | |
-> Text | |
-> SubscriberResource |
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.
subscriberResource_accessTypes :: Lens' SubscriberResource (Maybe [AccessType]) Source #
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
.
subscriberResource_createdAt :: Lens' SubscriberResource (Maybe UTCTime) Source #
The date and time when the subscription was created.
subscriberResource_externalId :: Lens' SubscriberResource (Maybe Text) Source #
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.
subscriberResource_roleArn :: Lens' SubscriberResource (Maybe Text) Source #
The Amazon Resource Name (ARN) specifying the role of the subscriber.
subscriberResource_s3BucketArn :: Lens' SubscriberResource (Maybe Text) Source #
The ARN for the Amazon S3 bucket.
subscriberResource_snsArn :: Lens' SubscriberResource (Maybe Text) Source #
The ARN for the Amazon Simple Notification Service.
subscriberResource_subscriberDescription :: Lens' SubscriberResource (Maybe Text) Source #
The subscriber descriptions for a subscriber account. The description
for a subscriber includes subscriberName
, accountID
, externalID
,
and subscriptionId
.
subscriberResource_subscriberName :: Lens' SubscriberResource (Maybe Text) Source #
The name of your Amazon Security Lake subscriber account.
subscriberResource_subscriptionEndpoint :: Lens' SubscriberResource (Maybe Text) Source #
The subscription endpoint to which exception messages are posted.
subscriberResource_subscriptionProtocol :: Lens' SubscriberResource (Maybe EndpointProtocol) Source #
The subscription protocol to which exception messages are posted.
subscriberResource_subscriptionStatus :: Lens' SubscriberResource (Maybe SubscriptionStatus) Source #
The subscription status of the Amazon Security Lake subscriber account.
subscriberResource_updatedAt :: Lens' SubscriberResource (Maybe UTCTime) Source #
The date and time when the subscription was created.
subscriberResource_accountId :: Lens' SubscriberResource Text Source #
The Amazon Web Services account ID you are using to create your Amazon Security Lake account.
subscriberResource_sourceTypes :: Lens' SubscriberResource [SourceType] Source #
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
subscriberResource_subscriptionId :: Lens' SubscriberResource Text Source #
The subscription ID of the Amazon Security Lake subscriber account.