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 |
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.
Synopsis
- data CreateSubscriber = CreateSubscriber' {}
- newCreateSubscriber :: Text -> Text -> Text -> CreateSubscriber
- createSubscriber_accessTypes :: Lens' CreateSubscriber (Maybe [AccessType])
- createSubscriber_subscriberDescription :: Lens' CreateSubscriber (Maybe Text)
- createSubscriber_accountId :: Lens' CreateSubscriber Text
- createSubscriber_externalId :: Lens' CreateSubscriber Text
- createSubscriber_sourceTypes :: Lens' CreateSubscriber [SourceType]
- createSubscriber_subscriberName :: Lens' CreateSubscriber Text
- data CreateSubscriberResponse = CreateSubscriberResponse' {
- roleArn :: Maybe Text
- s3BucketArn :: Maybe Text
- snsArn :: Maybe Text
- httpStatus :: Int
- subscriptionId :: Text
- newCreateSubscriberResponse :: Int -> Text -> CreateSubscriberResponse
- createSubscriberResponse_roleArn :: Lens' CreateSubscriberResponse (Maybe Text)
- createSubscriberResponse_s3BucketArn :: Lens' CreateSubscriberResponse (Maybe Text)
- createSubscriberResponse_snsArn :: Lens' CreateSubscriberResponse (Maybe Text)
- createSubscriberResponse_httpStatus :: Lens' CreateSubscriberResponse Int
- createSubscriberResponse_subscriptionId :: Lens' CreateSubscriberResponse Text
Creating a Request
data CreateSubscriber Source #
See: newCreateSubscriber
smart constructor.
CreateSubscriber' | |
|
Instances
Create a value of CreateSubscriber
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:
CreateSubscriber
, createSubscriber_accessTypes
- The Amazon S3 or Lake Formation access type.
CreateSubscriber
, createSubscriber_subscriberDescription
- The description for your subscriber account in Security Lake.
CreateSubscriber
, createSubscriber_accountId
- The Amazon Web Services account ID used to access your data.
CreateSubscriber
, createSubscriber_externalId
- The external ID of the subscriber. This 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.
CreateSubscriber
, createSubscriber_sourceTypes
- The supported Amazon Web Services from which logs and events are
collected. Security Lake supports log and event collection for natively
supported Amazon Web Services.
CreateSubscriber
, createSubscriber_subscriberName
- The name of your Security Lake subscriber account.
Request Lenses
createSubscriber_accessTypes :: Lens' CreateSubscriber (Maybe [AccessType]) Source #
The Amazon S3 or Lake Formation access type.
createSubscriber_subscriberDescription :: Lens' CreateSubscriber (Maybe Text) Source #
The description for your subscriber account in Security Lake.
createSubscriber_accountId :: Lens' CreateSubscriber Text Source #
The Amazon Web Services account ID used to access your data.
createSubscriber_externalId :: Lens' CreateSubscriber Text Source #
The external ID of the subscriber. This 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.
createSubscriber_sourceTypes :: Lens' CreateSubscriber [SourceType] Source #
The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.
createSubscriber_subscriberName :: Lens' CreateSubscriber Text Source #
The name of your Security Lake subscriber account.
Destructuring the Response
data CreateSubscriberResponse Source #
See: newCreateSubscriberResponse
smart constructor.
CreateSubscriberResponse' | |
|
Instances
newCreateSubscriberResponse Source #
:: Int | |
-> Text | |
-> CreateSubscriberResponse |
Create a value of CreateSubscriberResponse
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:
CreateSubscriberResponse
, createSubscriberResponse_roleArn
- The Amazon Resource Name (ARN) created by you to provide to the
subscriber. For more information about ARNs and how to use them in
policies, see
IAM identifiers in the Identity and Access Management (IAM) User Guide.
.
CreateSubscriberResponse
, createSubscriberResponse_s3BucketArn
- The ARN for the Amazon S3 bucket.
CreateSubscriberResponse
, createSubscriberResponse_snsArn
- The ARN for the Amazon Simple Notification Service.
$sel:httpStatus:CreateSubscriberResponse'
, createSubscriberResponse_httpStatus
- The response's http status code.
CreateSubscriberResponse
, createSubscriberResponse_subscriptionId
- The subscriptionId
created by the CreateSubscriber
API call.
Response Lenses
createSubscriberResponse_roleArn :: Lens' CreateSubscriberResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see IAM identifiers in the Identity and Access Management (IAM) User Guide. .
createSubscriberResponse_s3BucketArn :: Lens' CreateSubscriberResponse (Maybe Text) Source #
The ARN for the Amazon S3 bucket.
createSubscriberResponse_snsArn :: Lens' CreateSubscriberResponse (Maybe Text) Source #
The ARN for the Amazon Simple Notification Service.
createSubscriberResponse_httpStatus :: Lens' CreateSubscriberResponse Int Source #
The response's http status code.
createSubscriberResponse_subscriptionId :: Lens' CreateSubscriberResponse Text Source #
The subscriptionId
created by the CreateSubscriber
API call.