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 |
Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.
By default, a dimension refers to the entire set. When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API enables all Security Lake member accounts for all sources. Similarly, when you do not specify Regions, Security Lake is enabled for all the Regions where Security Lake is available as a service.
You can use this API only to enable natively supported Amazon Web
Services as a source. Use CreateCustomLogSource
to enable data
collection from a custom source.
Synopsis
- data CreateAwsLogSource = CreateAwsLogSource' {
- enableAllDimensions :: Maybe (HashMap Text (HashMap Text [Text]))
- enableSingleDimension :: Maybe [Text]
- enableTwoDimensions :: Maybe (HashMap Text [Text])
- inputOrder :: [Dimension]
- newCreateAwsLogSource :: CreateAwsLogSource
- createAwsLogSource_enableAllDimensions :: Lens' CreateAwsLogSource (Maybe (HashMap Text (HashMap Text [Text])))
- createAwsLogSource_enableSingleDimension :: Lens' CreateAwsLogSource (Maybe [Text])
- createAwsLogSource_enableTwoDimensions :: Lens' CreateAwsLogSource (Maybe (HashMap Text [Text]))
- createAwsLogSource_inputOrder :: Lens' CreateAwsLogSource [Dimension]
- data CreateAwsLogSourceResponse = CreateAwsLogSourceResponse' {
- failed :: Maybe [Text]
- processing :: Maybe [Text]
- httpStatus :: Int
- newCreateAwsLogSourceResponse :: Int -> CreateAwsLogSourceResponse
- createAwsLogSourceResponse_failed :: Lens' CreateAwsLogSourceResponse (Maybe [Text])
- createAwsLogSourceResponse_processing :: Lens' CreateAwsLogSourceResponse (Maybe [Text])
- createAwsLogSourceResponse_httpStatus :: Lens' CreateAwsLogSourceResponse Int
Creating a Request
data CreateAwsLogSource Source #
See: newCreateAwsLogSource
smart constructor.
CreateAwsLogSource' | |
|
Instances
newCreateAwsLogSource :: CreateAwsLogSource Source #
Create a value of CreateAwsLogSource
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:enableAllDimensions:CreateAwsLogSource'
, createAwsLogSource_enableAllDimensions
- Enables data collection from specific Amazon Web Services sources in all
specific accounts and specific Regions.
$sel:enableSingleDimension:CreateAwsLogSource'
, createAwsLogSource_enableSingleDimension
- Enables data collection from all Amazon Web Services sources in specific
accounts or Regions.
$sel:enableTwoDimensions:CreateAwsLogSource'
, createAwsLogSource_enableTwoDimensions
- Enables data collection from specific Amazon Web Services sources in
specific accounts or Regions.
$sel:inputOrder:CreateAwsLogSource'
, createAwsLogSource_inputOrder
- Specifies the input order to enable dimensions in Security Lake, namely
Region, source type, and member account.
Request Lenses
createAwsLogSource_enableAllDimensions :: Lens' CreateAwsLogSource (Maybe (HashMap Text (HashMap Text [Text]))) Source #
Enables data collection from specific Amazon Web Services sources in all specific accounts and specific Regions.
createAwsLogSource_enableSingleDimension :: Lens' CreateAwsLogSource (Maybe [Text]) Source #
Enables data collection from all Amazon Web Services sources in specific accounts or Regions.
createAwsLogSource_enableTwoDimensions :: Lens' CreateAwsLogSource (Maybe (HashMap Text [Text])) Source #
Enables data collection from specific Amazon Web Services sources in specific accounts or Regions.
createAwsLogSource_inputOrder :: Lens' CreateAwsLogSource [Dimension] Source #
Specifies the input order to enable dimensions in Security Lake, namely Region, source type, and member account.
Destructuring the Response
data CreateAwsLogSourceResponse Source #
See: newCreateAwsLogSourceResponse
smart constructor.
CreateAwsLogSourceResponse' | |
|
Instances
newCreateAwsLogSourceResponse Source #
Create a value of CreateAwsLogSourceResponse
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:failed:CreateAwsLogSourceResponse'
, createAwsLogSourceResponse_failed
- Lists all accounts in which enabling a natively supported Amazon Web
Service as a Security Lake source failed. The failure occurred as these
accounts are not part of an organization.
$sel:processing:CreateAwsLogSourceResponse'
, createAwsLogSourceResponse_processing
- Lists the accounts that are in the process of enabling a natively
supported Amazon Web Service as a Security Lake source.
$sel:httpStatus:CreateAwsLogSourceResponse'
, createAwsLogSourceResponse_httpStatus
- The response's http status code.
Response Lenses
createAwsLogSourceResponse_failed :: Lens' CreateAwsLogSourceResponse (Maybe [Text]) Source #
Lists all accounts in which enabling a natively supported Amazon Web Service as a Security Lake source failed. The failure occurred as these accounts are not part of an organization.
createAwsLogSourceResponse_processing :: Lens' CreateAwsLogSourceResponse (Maybe [Text]) Source #
Lists the accounts that are in the process of enabling a natively supported Amazon Web Service as a Security Lake source.
createAwsLogSourceResponse_httpStatus :: Lens' CreateAwsLogSourceResponse Int Source #
The response's http status code.