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

Amazonka.SecurityLake.CreateSubscriber

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- accessTypes :: Maybe [AccessType]
- subscriberDescription :: Maybe Text
- accountId :: Text
- externalId :: Text
- sourceTypes :: [SourceType]
- subscriberName :: Text
}
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.

Constructors

CreateSubscriber'

Fields

accessTypes :: Maybe [AccessType]
The Amazon S3 or Lake Formation access type.
subscriberDescription :: Maybe Text
The description for your subscriber account in Security Lake.
accountId :: Text
The Amazon Web Services account ID used to access your data.
externalId :: Text
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.
sourceTypes :: [SourceType]
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.
subscriberName :: Text
The name of your Security Lake subscriber account.

Instances

Instances details

ToJSON CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods toJSON :: CreateSubscriber -> Value # toEncoding :: CreateSubscriber -> Encoding # toJSONList :: [CreateSubscriber] -> Value # toEncodingList :: [CreateSubscriber] -> Encoding #
ToHeaders CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods toHeaders :: CreateSubscriber -> [Header] #
ToPath CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods toPath :: CreateSubscriber -> ByteString #
ToQuery CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods toQuery :: CreateSubscriber -> QueryString #
AWSRequest CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Associated Types type AWSResponse CreateSubscriber # Methods request :: (Service -> Service) -> CreateSubscriber -> Request CreateSubscriber # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSubscriber -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSubscriber))) #
Generic CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Associated Types type Rep CreateSubscriber :: Type -> Type # Methods from :: CreateSubscriber -> Rep CreateSubscriber x # to :: Rep CreateSubscriber x -> CreateSubscriber #
Read CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods readsPrec :: Int -> ReadS CreateSubscriber # readList :: ReadS [CreateSubscriber] # readPrec :: ReadPrec CreateSubscriber # readListPrec :: ReadPrec [CreateSubscriber] #
Show CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods showsPrec :: Int -> CreateSubscriber -> ShowS # show :: CreateSubscriber -> String # showList :: [CreateSubscriber] -> ShowS #
NFData CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods rnf :: CreateSubscriber -> () #
Eq CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods (==) :: CreateSubscriber -> CreateSubscriber -> Bool # (/=) :: CreateSubscriber -> CreateSubscriber -> Bool #
Hashable CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods hashWithSalt :: Int -> CreateSubscriber -> Int # hash :: CreateSubscriber -> Int #
type AWSResponse CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber type AWSResponse CreateSubscriber = CreateSubscriberResponse
type Rep CreateSubscriber Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber type Rep CreateSubscriber = D1 ('MetaData "CreateSubscriber" "Amazonka.SecurityLake.CreateSubscriber" "amazonka-securitylake-2.0-4WRm07ESU278sNrKhxoCOb" 'False) (C1 ('MetaCons "CreateSubscriber'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AccessType])) :: (S1 ('MetaSel ('Just "subscriberDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "sourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SourceType]) :*: S1 ('MetaSel ('Just "subscriberName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateSubscriber Source #

Arguments

:: Text	`CreateSubscriber`
-> Text	`CreateSubscriber`
-> Text	`CreateSubscriber`
-> CreateSubscriber

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.

Constructors

CreateSubscriberResponse'

Fields

roleArn :: Maybe Text
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. .
s3BucketArn :: Maybe Text
The ARN for the Amazon S3 bucket.
snsArn :: Maybe Text
The ARN for the Amazon Simple Notification Service.
httpStatus :: Int
The response's http status code.
subscriptionId :: Text
The subscriptionId created by the CreateSubscriber API call.

Instances

Instances details

Generic CreateSubscriberResponse Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Associated Types type Rep CreateSubscriberResponse :: Type -> Type # Methods from :: CreateSubscriberResponse -> Rep CreateSubscriberResponse x # to :: Rep CreateSubscriberResponse x -> CreateSubscriberResponse #
Read CreateSubscriberResponse Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods readsPrec :: Int -> ReadS CreateSubscriberResponse # readList :: ReadS [CreateSubscriberResponse] # readPrec :: ReadPrec CreateSubscriberResponse # readListPrec :: ReadPrec [CreateSubscriberResponse] #
Show CreateSubscriberResponse Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods showsPrec :: Int -> CreateSubscriberResponse -> ShowS # show :: CreateSubscriberResponse -> String # showList :: [CreateSubscriberResponse] -> ShowS #
NFData CreateSubscriberResponse Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods rnf :: CreateSubscriberResponse -> () #
Eq CreateSubscriberResponse Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber Methods (==) :: CreateSubscriberResponse -> CreateSubscriberResponse -> Bool # (/=) :: CreateSubscriberResponse -> CreateSubscriberResponse -> Bool #
type Rep CreateSubscriberResponse Source #
Instance details Defined in Amazonka.SecurityLake.CreateSubscriber type Rep CreateSubscriberResponse = D1 ('MetaData "CreateSubscriberResponse" "Amazonka.SecurityLake.CreateSubscriber" "amazonka-securitylake-2.0-4WRm07ESU278sNrKhxoCOb" 'False) (C1 ('MetaCons "CreateSubscriberResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "s3BucketArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "snsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "subscriptionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateSubscriberResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateSubscriberResponse'`
-> Text	`CreateSubscriberResponse`
-> 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.