amazonka-securitylake-2.0: Amazon Security Lake SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SecurityLake.CreateAwsLogSource

Description

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

Creating a Request

data CreateAwsLogSource Source #

See: newCreateAwsLogSource smart constructor.

Constructors

CreateAwsLogSource' 

Fields

Instances

Instances details
ToJSON CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

ToHeaders CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

ToPath CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

ToQuery CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

AWSRequest CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

Associated Types

type AWSResponse CreateAwsLogSource #

Generic CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

Associated Types

type Rep CreateAwsLogSource :: Type -> Type #

Read CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

Show CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

NFData CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

Methods

rnf :: CreateAwsLogSource -> () #

Eq CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

Hashable CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

type AWSResponse CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

type Rep CreateAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

type Rep CreateAwsLogSource = D1 ('MetaData "CreateAwsLogSource" "Amazonka.SecurityLake.CreateAwsLogSource" "amazonka-securitylake-2.0-4WRm07ESU278sNrKhxoCOb" 'False) (C1 ('MetaCons "CreateAwsLogSource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enableAllDimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text [Text])))) :*: S1 ('MetaSel ('Just "enableSingleDimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "enableTwoDimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "inputOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Dimension]))))

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.

Constructors

CreateAwsLogSourceResponse' 

Fields

  • failed :: Maybe [Text]

    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.

  • processing :: Maybe [Text]

    Lists the accounts that are in the process of enabling a natively supported Amazon Web Service as a Security Lake source.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

Associated Types

type Rep CreateAwsLogSourceResponse :: Type -> Type #

Read CreateAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

Show CreateAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

NFData CreateAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

Eq CreateAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

type Rep CreateAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateAwsLogSource

type Rep CreateAwsLogSourceResponse = D1 ('MetaData "CreateAwsLogSourceResponse" "Amazonka.SecurityLake.CreateAwsLogSource" "amazonka-securitylake-2.0-4WRm07ESU278sNrKhxoCOb" 'False) (C1 ('MetaCons "CreateAwsLogSourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "processing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.