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.CreateCustomLogSource

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source in addition to an associated Glue table and an Glue crawler.

Synopsis

Creating a Request

data CreateCustomLogSource Source #

See: newCreateCustomLogSource smart constructor.

Constructors

CreateCustomLogSource'

Fields

customSourceName :: Text
The name for a third-party custom source. This must be a Regionally unique value.
eventClass :: OcsfEventClass
The Open Cybersecurity Schema Framework (OCSF) event class which describes the type of data that the custom source will send to Security Lake.
glueInvocationRoleArn :: Text
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are:
- The managed policy AWSGlueServiceRole
- A custom policy granting access to your Amazon S3 Data Lake
logProviderAccountId :: Text
The Amazon Web Services account ID of the custom source that will write logs and events into the Amazon S3 Data Lake.

Instances

Instances details

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

newCreateCustomLogSource Source #

Arguments

:: Text	`$sel:customSourceName:CreateCustomLogSource'`
-> OcsfEventClass	`CreateCustomLogSource`
-> Text	`$sel:glueInvocationRoleArn:CreateCustomLogSource'`
-> Text	`$sel:logProviderAccountId:CreateCustomLogSource'`
-> CreateCustomLogSource

Create a value of CreateCustomLogSource 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:customSourceName:CreateCustomLogSource', createCustomLogSource_customSourceName - The name for a third-party custom source. This must be a Regionally unique value.

CreateCustomLogSource, createCustomLogSource_eventClass - The Open Cybersecurity Schema Framework (OCSF) event class which describes the type of data that the custom source will send to Security Lake.

$sel:glueInvocationRoleArn:CreateCustomLogSource', createCustomLogSource_glueInvocationRoleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are:

The managed policy AWSGlueServiceRole
A custom policy granting access to your Amazon S3 Data Lake

$sel:logProviderAccountId:CreateCustomLogSource', createCustomLogSource_logProviderAccountId - The Amazon Web Services account ID of the custom source that will write logs and events into the Amazon S3 Data Lake.

Request Lenses

createCustomLogSource_customSourceName :: Lens' CreateCustomLogSource Text Source #

The name for a third-party custom source. This must be a Regionally unique value.

createCustomLogSource_eventClass :: Lens' CreateCustomLogSource OcsfEventClass Source #

The Open Cybersecurity Schema Framework (OCSF) event class which describes the type of data that the custom source will send to Security Lake.

createCustomLogSource_glueInvocationRoleArn :: Lens' CreateCustomLogSource Text Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are:

The managed policy AWSGlueServiceRole
A custom policy granting access to your Amazon S3 Data Lake

createCustomLogSource_logProviderAccountId :: Lens' CreateCustomLogSource Text Source #

The Amazon Web Services account ID of the custom source that will write logs and events into the Amazon S3 Data Lake.

Destructuring the Response

data CreateCustomLogSourceResponse Source #

See: newCreateCustomLogSourceResponse smart constructor.

Constructors

CreateCustomLogSourceResponse'

Fields

httpStatus :: Int
The response's http status code.
customDataLocation :: Text
The location of the partition in the Amazon S3 bucket for Security Lake.
glueCrawlerName :: Text
The name of the Glue crawler.
glueDatabaseName :: Text
The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
glueTableName :: Text
The table name of the Glue crawler.
logProviderAccessRoleArn :: Text
The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

Instances

Instances details

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

newCreateCustomLogSourceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateCustomLogSourceResponse'`
-> Text	`$sel:customDataLocation:CreateCustomLogSourceResponse'`
-> Text	`$sel:glueCrawlerName:CreateCustomLogSourceResponse'`
-> Text	`$sel:glueDatabaseName:CreateCustomLogSourceResponse'`
-> Text	`$sel:glueTableName:CreateCustomLogSourceResponse'`
-> Text	`$sel:logProviderAccessRoleArn:CreateCustomLogSourceResponse'`
-> CreateCustomLogSourceResponse

Create a value of CreateCustomLogSourceResponse 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:httpStatus:CreateCustomLogSourceResponse', createCustomLogSourceResponse_httpStatus - The response's http status code.

$sel:customDataLocation:CreateCustomLogSourceResponse', createCustomLogSourceResponse_customDataLocation - The location of the partition in the Amazon S3 bucket for Security Lake.

$sel:glueCrawlerName:CreateCustomLogSourceResponse', createCustomLogSourceResponse_glueCrawlerName - The name of the Glue crawler.

$sel:glueDatabaseName:CreateCustomLogSourceResponse', createCustomLogSourceResponse_glueDatabaseName - The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

$sel:glueTableName:CreateCustomLogSourceResponse', createCustomLogSourceResponse_glueTableName - The table name of the Glue crawler.

$sel:logProviderAccessRoleArn:CreateCustomLogSourceResponse', createCustomLogSourceResponse_logProviderAccessRoleArn - The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

Response Lenses

createCustomLogSourceResponse_httpStatus :: Lens' CreateCustomLogSourceResponse Int Source #

The response's http status code.

createCustomLogSourceResponse_customDataLocation :: Lens' CreateCustomLogSourceResponse Text Source #

The location of the partition in the Amazon S3 bucket for Security Lake.

createCustomLogSourceResponse_glueCrawlerName :: Lens' CreateCustomLogSourceResponse Text Source #

The name of the Glue crawler.

createCustomLogSourceResponse_glueDatabaseName :: Lens' CreateCustomLogSourceResponse Text Source #

The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

createCustomLogSourceResponse_glueTableName :: Lens' CreateCustomLogSourceResponse Text Source #

The table name of the Glue crawler.

createCustomLogSourceResponse_logProviderAccessRoleArn :: Lens' CreateCustomLogSourceResponse Text Source #

The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.