| 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.Types
Contents
- Service Configuration
- Errors
- AccessType
- AwsLogSourceType
- Dimension
- EndpointProtocol
- HttpsMethod
- OcsfEventClass
- Region
- SettingsStatus
- SourceStatus
- StorageClass
- SubscriptionProtocolType
- SubscriptionStatus
- AccountSources
- AutoEnableNewRegionConfiguration
- Failures
- FailuresResponse
- LakeConfigurationRequest
- LakeConfigurationResponse
- LogsStatus
- ProtocolAndNotificationEndpoint
- RetentionSetting
- SourceType
- SubscriberResource
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _AccountNotFoundException :: AsError a => Fold a ServiceError
- _BucketNotFoundException :: AsError a => Fold a ServiceError
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _ConflictSourceNamesException :: AsError a => Fold a ServiceError
- _ConflictSubscriptionException :: AsError a => Fold a ServiceError
- _EventBridgeException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidInputException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _S3Exception :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype AccessType where
- AccessType' { }
- pattern AccessType_LAKEFORMATION :: AccessType
- pattern AccessType_S3 :: AccessType
- newtype AwsLogSourceType where
- AwsLogSourceType' { }
- pattern AwsLogSourceType_CLOUD_TRAIL :: AwsLogSourceType
- pattern AwsLogSourceType_ROUTE53 :: AwsLogSourceType
- pattern AwsLogSourceType_SH_FINDINGS :: AwsLogSourceType
- pattern AwsLogSourceType_VPC_FLOW :: AwsLogSourceType
- newtype Dimension where
- Dimension' { }
- pattern Dimension_MEMBER :: Dimension
- pattern Dimension_REGION :: Dimension
- pattern Dimension_SOURCE_TYPE :: Dimension
- newtype EndpointProtocol where
- EndpointProtocol' { }
- pattern EndpointProtocol_HTTPS :: EndpointProtocol
- pattern EndpointProtocol_SQS :: EndpointProtocol
- newtype HttpsMethod where
- HttpsMethod' { }
- pattern HttpsMethod_POST :: HttpsMethod
- pattern HttpsMethod_PUT :: HttpsMethod
- newtype OcsfEventClass where
- OcsfEventClass' { }
- pattern OcsfEventClass_ACCESS_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_ACCOUNT_CHANGE :: OcsfEventClass
- pattern OcsfEventClass_AUTHENTICATION :: OcsfEventClass
- pattern OcsfEventClass_AUTHORIZATION :: OcsfEventClass
- pattern OcsfEventClass_CLOUD_API :: OcsfEventClass
- pattern OcsfEventClass_CLOUD_STORAGE :: OcsfEventClass
- pattern OcsfEventClass_CONFIG_STATE :: OcsfEventClass
- pattern OcsfEventClass_CONTAINER_LIFECYCLE :: OcsfEventClass
- pattern OcsfEventClass_DATABASE_LIFECYCLE :: OcsfEventClass
- pattern OcsfEventClass_DHCP_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_DNS_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_ENTITY_MANAGEMENT_AUDIT :: OcsfEventClass
- pattern OcsfEventClass_FILE_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_FTP_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_HTTP_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_INVENTORY_INFO :: OcsfEventClass
- pattern OcsfEventClass_KERNEL_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_KERNEL_EXTENSION :: OcsfEventClass
- pattern OcsfEventClass_MEMORY_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_MODULE_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_NETWORK_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_PROCESS_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_RDP_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_REGISTRY_KEY_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_REGISTRY_VALUE_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_RESOURCE_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_RFB_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_SCHEDULED_JOB_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_SECURITY_FINDING :: OcsfEventClass
- pattern OcsfEventClass_SMB_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_SMTP_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_SSH_ACTIVITY :: OcsfEventClass
- pattern OcsfEventClass_VIRTUAL_MACHINE_ACTIVITY :: OcsfEventClass
- newtype Region where
- Region' {
- fromRegion :: Text
- pattern Region_Ap_northeast_1 :: Region
- pattern Region_Ap_southeast_2 :: Region
- pattern Region_Eu_central_1 :: Region
- pattern Region_Eu_west_1 :: Region
- pattern Region_Us_east_1 :: Region
- pattern Region_Us_east_2 :: Region
- pattern Region_Us_west_2 :: Region
- Region' {
- newtype SettingsStatus where
- SettingsStatus' { }
- pattern SettingsStatus_COMPLETED :: SettingsStatus
- pattern SettingsStatus_FAILED :: SettingsStatus
- pattern SettingsStatus_INITIALIZED :: SettingsStatus
- pattern SettingsStatus_PENDING :: SettingsStatus
- newtype SourceStatus where
- SourceStatus' { }
- pattern SourceStatus_ACTIVE :: SourceStatus
- pattern SourceStatus_DEACTIVATED :: SourceStatus
- pattern SourceStatus_PENDING :: SourceStatus
- newtype StorageClass where
- StorageClass' { }
- pattern StorageClass_DEEP_ARCHIVE :: StorageClass
- pattern StorageClass_EXPIRE :: StorageClass
- pattern StorageClass_GLACIER :: StorageClass
- pattern StorageClass_GLACIER_IR :: StorageClass
- pattern StorageClass_INTELLIGENT_TIERING :: StorageClass
- pattern StorageClass_ONEZONE_IA :: StorageClass
- pattern StorageClass_STANDARD_IA :: StorageClass
- newtype SubscriptionProtocolType where
- SubscriptionProtocolType' { }
- pattern SubscriptionProtocolType_APP :: SubscriptionProtocolType
- pattern SubscriptionProtocolType_EMAIL :: SubscriptionProtocolType
- pattern SubscriptionProtocolType_EMAIL_JSON :: SubscriptionProtocolType
- pattern SubscriptionProtocolType_FIREHOSE :: SubscriptionProtocolType
- pattern SubscriptionProtocolType_HTTP :: SubscriptionProtocolType
- pattern SubscriptionProtocolType_HTTPS :: SubscriptionProtocolType
- pattern SubscriptionProtocolType_LAMBDA :: SubscriptionProtocolType
- pattern SubscriptionProtocolType_SMS :: SubscriptionProtocolType
- pattern SubscriptionProtocolType_SQS :: SubscriptionProtocolType
- newtype SubscriptionStatus where
- SubscriptionStatus' { }
- pattern SubscriptionStatus_ACTIVE :: SubscriptionStatus
- pattern SubscriptionStatus_DEACTIVATED :: SubscriptionStatus
- pattern SubscriptionStatus_PENDING :: SubscriptionStatus
- pattern SubscriptionStatus_READY :: SubscriptionStatus
- data AccountSources = AccountSources' {
- eventClass :: Maybe OcsfEventClass
- logsStatus :: Maybe [LogsStatus]
- account :: Text
- sourceType :: Text
- newAccountSources :: Text -> Text -> AccountSources
- accountSources_eventClass :: Lens' AccountSources (Maybe OcsfEventClass)
- accountSources_logsStatus :: Lens' AccountSources (Maybe [LogsStatus])
- accountSources_account :: Lens' AccountSources Text
- accountSources_sourceType :: Lens' AccountSources Text
- data AutoEnableNewRegionConfiguration = AutoEnableNewRegionConfiguration' {
- region :: Region
- sources :: [AwsLogSourceType]
- newAutoEnableNewRegionConfiguration :: Region -> AutoEnableNewRegionConfiguration
- autoEnableNewRegionConfiguration_region :: Lens' AutoEnableNewRegionConfiguration Region
- autoEnableNewRegionConfiguration_sources :: Lens' AutoEnableNewRegionConfiguration [AwsLogSourceType]
- data Failures = Failures' {}
- newFailures :: Text -> Text -> UTCTime -> Failures
- failures_exceptionMessage :: Lens' Failures Text
- failures_remediation :: Lens' Failures Text
- failures_timestamp :: Lens' Failures UTCTime
- data FailuresResponse = FailuresResponse' {}
- newFailuresResponse :: FailuresResponse
- failuresResponse_failures :: Lens' FailuresResponse (Maybe [Failures])
- failuresResponse_region :: Lens' FailuresResponse (Maybe Text)
- data LakeConfigurationRequest = LakeConfigurationRequest' {}
- newLakeConfigurationRequest :: LakeConfigurationRequest
- lakeConfigurationRequest_encryptionKey :: Lens' LakeConfigurationRequest (Maybe Text)
- lakeConfigurationRequest_replicationDestinationRegions :: Lens' LakeConfigurationRequest (Maybe [Region])
- lakeConfigurationRequest_replicationRoleArn :: Lens' LakeConfigurationRequest (Maybe Text)
- lakeConfigurationRequest_retentionSettings :: Lens' LakeConfigurationRequest (Maybe [RetentionSetting])
- lakeConfigurationRequest_tagsMap :: Lens' LakeConfigurationRequest (Maybe (HashMap Text Text))
- data LakeConfigurationResponse = LakeConfigurationResponse' {}
- newLakeConfigurationResponse :: LakeConfigurationResponse
- lakeConfigurationResponse_encryptionKey :: Lens' LakeConfigurationResponse (Maybe Text)
- lakeConfigurationResponse_replicationDestinationRegions :: Lens' LakeConfigurationResponse (Maybe [Region])
- lakeConfigurationResponse_replicationRoleArn :: Lens' LakeConfigurationResponse (Maybe Text)
- lakeConfigurationResponse_retentionSettings :: Lens' LakeConfigurationResponse (Maybe [RetentionSetting])
- lakeConfigurationResponse_s3BucketArn :: Lens' LakeConfigurationResponse (Maybe Text)
- lakeConfigurationResponse_status :: Lens' LakeConfigurationResponse (Maybe SettingsStatus)
- lakeConfigurationResponse_tagsMap :: Lens' LakeConfigurationResponse (Maybe (HashMap Text Text))
- data LogsStatus = LogsStatus' {}
- newLogsStatus :: SourceStatus -> Text -> LogsStatus
- logsStatus_healthStatus :: Lens' LogsStatus SourceStatus
- logsStatus_pathToLogs :: Lens' LogsStatus Text
- data ProtocolAndNotificationEndpoint = ProtocolAndNotificationEndpoint' {}
- newProtocolAndNotificationEndpoint :: ProtocolAndNotificationEndpoint
- protocolAndNotificationEndpoint_endpoint :: Lens' ProtocolAndNotificationEndpoint (Maybe Text)
- protocolAndNotificationEndpoint_protocol :: Lens' ProtocolAndNotificationEndpoint (Maybe Text)
- data RetentionSetting = RetentionSetting' {}
- newRetentionSetting :: RetentionSetting
- retentionSetting_retentionPeriod :: Lens' RetentionSetting (Maybe Natural)
- retentionSetting_storageClass :: Lens' RetentionSetting (Maybe StorageClass)
- data SourceType = SourceType' {}
- newSourceType :: SourceType
- sourceType_awsSourceType :: Lens' SourceType (Maybe AwsLogSourceType)
- sourceType_customSourceType :: Lens' SourceType (Maybe Text)
- data SubscriberResource = SubscriberResource' {
- accessTypes :: Maybe [AccessType]
- createdAt :: Maybe ISO8601
- externalId :: Maybe Text
- roleArn :: Maybe Text
- s3BucketArn :: Maybe Text
- snsArn :: Maybe Text
- subscriberDescription :: Maybe Text
- subscriberName :: Maybe Text
- subscriptionEndpoint :: Maybe Text
- subscriptionProtocol :: Maybe EndpointProtocol
- subscriptionStatus :: Maybe SubscriptionStatus
- updatedAt :: Maybe ISO8601
- accountId :: Text
- sourceTypes :: [SourceType]
- subscriptionId :: Text
- newSubscriberResource :: Text -> Text -> SubscriberResource
- subscriberResource_accessTypes :: Lens' SubscriberResource (Maybe [AccessType])
- subscriberResource_createdAt :: Lens' SubscriberResource (Maybe UTCTime)
- subscriberResource_externalId :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_roleArn :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_s3BucketArn :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_snsArn :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriberDescription :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriberName :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriptionEndpoint :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriptionProtocol :: Lens' SubscriberResource (Maybe EndpointProtocol)
- subscriberResource_subscriptionStatus :: Lens' SubscriberResource (Maybe SubscriptionStatus)
- subscriberResource_updatedAt :: Lens' SubscriberResource (Maybe UTCTime)
- subscriberResource_accountId :: Lens' SubscriberResource Text
- subscriberResource_sourceTypes :: Lens' SubscriberResource [SourceType]
- subscriberResource_subscriptionId :: Lens' SubscriberResource Text
Service Configuration
defaultService :: Service Source #
API version 2018-05-10 of the Amazon Security Lake SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
_AccountNotFoundException :: AsError a => Fold a ServiceError Source #
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
_BucketNotFoundException :: AsError a => Fold a ServiceError Source #
Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
More than one process tried to modify a resource at the same time.
_ConflictException :: AsError a => Fold a ServiceError Source #
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
_ConflictSourceNamesException :: AsError a => Fold a ServiceError Source #
There was a conflict when you attempted to modify a Security Lake source name.
_ConflictSubscriptionException :: AsError a => Fold a ServiceError Source #
A conflicting subscription exception operation is in progress.
_EventBridgeException :: AsError a => Fold a ServiceError Source #
Represents an error interacting with the Amazon EventBridge service.
_InternalServerException :: AsError a => Fold a ServiceError Source #
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
_InvalidInputException :: AsError a => Fold a ServiceError Source #
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource could not be found.
_S3Exception :: AsError a => Fold a ServiceError Source #
Provides an extension of the AmazonServiceException for errors reported by Amazon S3 while processing a request. In particular, this class provides access to the Amazon S3 extended request ID. If Amazon S3 is incorrectly handling a request and you need to contact Amazon, this extended request ID may provide useful debugging information.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The limit on the number of requests per second was exceeded.
_ValidationException :: AsError a => Fold a ServiceError Source #
Your signing certificate could not be validated.
AccessType
newtype AccessType Source #
Constructors
| AccessType' | |
Fields | |
Bundled Patterns
| pattern AccessType_LAKEFORMATION :: AccessType | |
| pattern AccessType_S3 :: AccessType |
Instances
AwsLogSourceType
newtype AwsLogSourceType Source #
Constructors
| AwsLogSourceType' | |
Fields | |
Bundled Patterns
| pattern AwsLogSourceType_CLOUD_TRAIL :: AwsLogSourceType | |
| pattern AwsLogSourceType_ROUTE53 :: AwsLogSourceType | |
| pattern AwsLogSourceType_SH_FINDINGS :: AwsLogSourceType | |
| pattern AwsLogSourceType_VPC_FLOW :: AwsLogSourceType |
Instances
Dimension
Constructors
| Dimension' | |
Fields | |
Bundled Patterns
| pattern Dimension_MEMBER :: Dimension | |
| pattern Dimension_REGION :: Dimension | |
| pattern Dimension_SOURCE_TYPE :: Dimension |
Instances
EndpointProtocol
newtype EndpointProtocol Source #
Constructors
| EndpointProtocol' | |
Fields | |
Bundled Patterns
| pattern EndpointProtocol_HTTPS :: EndpointProtocol | |
| pattern EndpointProtocol_SQS :: EndpointProtocol |
Instances
HttpsMethod
newtype HttpsMethod Source #
Constructors
| HttpsMethod' | |
Fields | |
Bundled Patterns
| pattern HttpsMethod_POST :: HttpsMethod | |
| pattern HttpsMethod_PUT :: HttpsMethod |
Instances
OcsfEventClass
newtype OcsfEventClass Source #
Constructors
| OcsfEventClass' | |
Fields | |
Bundled Patterns
Instances
Region
Constructors
| Region' | |
Fields
| |
Bundled Patterns
| pattern Region_Ap_northeast_1 :: Region | |
| pattern Region_Ap_southeast_2 :: Region | |
| pattern Region_Eu_central_1 :: Region | |
| pattern Region_Eu_west_1 :: Region | |
| pattern Region_Us_east_1 :: Region | |
| pattern Region_Us_east_2 :: Region | |
| pattern Region_Us_west_2 :: Region |
Instances
SettingsStatus
newtype SettingsStatus Source #
Constructors
| SettingsStatus' | |
Fields | |
Bundled Patterns
| pattern SettingsStatus_COMPLETED :: SettingsStatus | |
| pattern SettingsStatus_FAILED :: SettingsStatus | |
| pattern SettingsStatus_INITIALIZED :: SettingsStatus | |
| pattern SettingsStatus_PENDING :: SettingsStatus |
Instances
SourceStatus
newtype SourceStatus Source #
Constructors
| SourceStatus' | |
Fields | |
Bundled Patterns
| pattern SourceStatus_ACTIVE :: SourceStatus | |
| pattern SourceStatus_DEACTIVATED :: SourceStatus | |
| pattern SourceStatus_PENDING :: SourceStatus |
Instances
StorageClass
newtype StorageClass Source #
Constructors
| StorageClass' | |
Fields | |
Bundled Patterns
| pattern StorageClass_DEEP_ARCHIVE :: StorageClass | |
| pattern StorageClass_EXPIRE :: StorageClass | |
| pattern StorageClass_GLACIER :: StorageClass | |
| pattern StorageClass_GLACIER_IR :: StorageClass | |
| pattern StorageClass_INTELLIGENT_TIERING :: StorageClass | |
| pattern StorageClass_ONEZONE_IA :: StorageClass | |
| pattern StorageClass_STANDARD_IA :: StorageClass |
Instances
SubscriptionProtocolType
newtype SubscriptionProtocolType Source #
Constructors
| SubscriptionProtocolType' | |
Fields | |
Bundled Patterns
Instances
SubscriptionStatus
newtype SubscriptionStatus Source #
Constructors
| SubscriptionStatus' | |
Fields | |
Bundled Patterns
| pattern SubscriptionStatus_ACTIVE :: SubscriptionStatus | |
| pattern SubscriptionStatus_DEACTIVATED :: SubscriptionStatus | |
| pattern SubscriptionStatus_PENDING :: SubscriptionStatus | |
| pattern SubscriptionStatus_READY :: SubscriptionStatus |
Instances
AccountSources
data AccountSources Source #
Amazon Security Lake collects logs and events from supported Amazon Web Services and custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
See: newAccountSources smart constructor.
Constructors
| AccountSources' | |
Fields
| |
Instances
Create a value of AccountSources 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:eventClass:AccountSources', accountSources_eventClass - Initializes a new instance of the Event class.
$sel:logsStatus:AccountSources', accountSources_logsStatus - The log status for the Security Lake account.
$sel:account:AccountSources', accountSources_account - The ID of the Security Lake account for which logs are collected.
$sel:sourceType:AccountSources', accountSources_sourceType - The supported Amazon Web Services from which logs and events are
collected. Amazon Security Lake supports log and event collection for
natively supported Amazon Web Services.
accountSources_eventClass :: Lens' AccountSources (Maybe OcsfEventClass) Source #
Initializes a new instance of the Event class.
accountSources_logsStatus :: Lens' AccountSources (Maybe [LogsStatus]) Source #
The log status for the Security Lake account.
accountSources_account :: Lens' AccountSources Text Source #
The ID of the Security Lake account for which logs are collected.
accountSources_sourceType :: Lens' AccountSources Text Source #
The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
AutoEnableNewRegionConfiguration
data AutoEnableNewRegionConfiguration Source #
Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.
See: newAutoEnableNewRegionConfiguration smart constructor.
Constructors
| AutoEnableNewRegionConfiguration' | |
Fields
| |
Instances
newAutoEnableNewRegionConfiguration Source #
Create a value of AutoEnableNewRegionConfiguration 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:region:AutoEnableNewRegionConfiguration', autoEnableNewRegionConfiguration_region - The Amazon Web Services Regions where Security Lake is automatically
enabled.
$sel:sources:AutoEnableNewRegionConfiguration', autoEnableNewRegionConfiguration_sources - The Amazon Web Services sources that are automatically enabled in
Security Lake.
autoEnableNewRegionConfiguration_region :: Lens' AutoEnableNewRegionConfiguration Region Source #
The Amazon Web Services Regions where Security Lake is automatically enabled.
autoEnableNewRegionConfiguration_sources :: Lens' AutoEnableNewRegionConfiguration [AwsLogSourceType] Source #
The Amazon Web Services sources that are automatically enabled in Security Lake.
Failures
List of all failures.
See: newFailures smart constructor.
Constructors
| Failures' | |
Fields
| |
Instances
| FromJSON Failures Source # | |
| Generic Failures Source # | |
| Read Failures Source # | |
| Show Failures Source # | |
| NFData Failures Source # | |
Defined in Amazonka.SecurityLake.Types.Failures | |
| Eq Failures Source # | |
| Hashable Failures Source # | |
Defined in Amazonka.SecurityLake.Types.Failures | |
| type Rep Failures Source # | |
Defined in Amazonka.SecurityLake.Types.Failures type Rep Failures = D1 ('MetaData "Failures" "Amazonka.SecurityLake.Types.Failures" "amazonka-securitylake-2.0-4WRm07ESU278sNrKhxoCOb" 'False) (C1 ('MetaCons "Failures'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exceptionMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "remediation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)))) | |
Create a value of Failures 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:exceptionMessage:Failures', failures_exceptionMessage - List of all exception messages.
$sel:remediation:Failures', failures_remediation - List of all remediation steps for failures.
$sel:timestamp:Failures', failures_timestamp - This error can occur if you configure the wrong timestamp format, or if
the subset of entries used for validation had errors or missing values.
failures_timestamp :: Lens' Failures UTCTime Source #
This error can occur if you configure the wrong timestamp format, or if the subset of entries used for validation had errors or missing values.
FailuresResponse
data FailuresResponse Source #
Response element for actions that make changes, namely create, update, or delete actions.
See: newFailuresResponse smart constructor.
Constructors
| FailuresResponse' | |
Instances
newFailuresResponse :: FailuresResponse Source #
Create a value of FailuresResponse 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:failures:FailuresResponse', failuresResponse_failures - List of all failures.
$sel:region:FailuresResponse', failuresResponse_region - List of Amazon Web Services Regions where the failure occurred.
failuresResponse_failures :: Lens' FailuresResponse (Maybe [Failures]) Source #
List of all failures.
failuresResponse_region :: Lens' FailuresResponse (Maybe Text) Source #
List of Amazon Web Services Regions where the failure occurred.
LakeConfigurationRequest
data LakeConfigurationRequest Source #
Provides details of Amazon Security Lake configuration object.
See: newLakeConfigurationRequest smart constructor.
Constructors
| LakeConfigurationRequest' | |
Fields
| |
Instances
newLakeConfigurationRequest :: LakeConfigurationRequest Source #
Create a value of LakeConfigurationRequest 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:encryptionKey:LakeConfigurationRequest', lakeConfigurationRequest_encryptionKey - The type of encryption key used by Amazon Security Lake to encrypt the
Security Lake configuration object.
$sel:replicationDestinationRegions:LakeConfigurationRequest', lakeConfigurationRequest_replicationDestinationRegions - Replication enables automatic, asynchronous copying of objects across
Amazon S3 buckets. Amazon S3 buckets that are configured for object
replication can be owned by the same Amazon Web Services account or by
different accounts. You can replicate objects to a single destination
bucket or to multiple destination buckets. The destination buckets can
be in different Amazon Web Services Regions or within the same Region as
the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
$sel:replicationRoleArn:LakeConfigurationRequest', lakeConfigurationRequest_replicationRoleArn - Replication settings for the Amazon S3 buckets. This parameter uses the
Identity and Access Management (IAM) role you created that is managed by
Security Lake, to ensure the replication setting is correct.
$sel:retentionSettings:LakeConfigurationRequest', lakeConfigurationRequest_retentionSettings - Retention settings for the destination Amazon S3 buckets.
$sel:tagsMap:LakeConfigurationRequest', lakeConfigurationRequest_tagsMap - A tag is a label that you assign to an Amazon Web Services resource.
Each tag consists of a key and an optional value, both of which you
define.
lakeConfigurationRequest_encryptionKey :: Lens' LakeConfigurationRequest (Maybe Text) Source #
The type of encryption key used by Amazon Security Lake to encrypt the Security Lake configuration object.
lakeConfigurationRequest_replicationDestinationRegions :: Lens' LakeConfigurationRequest (Maybe [Region]) Source #
Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
lakeConfigurationRequest_replicationRoleArn :: Lens' LakeConfigurationRequest (Maybe Text) Source #
Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.
lakeConfigurationRequest_retentionSettings :: Lens' LakeConfigurationRequest (Maybe [RetentionSetting]) Source #
Retention settings for the destination Amazon S3 buckets.
lakeConfigurationRequest_tagsMap :: Lens' LakeConfigurationRequest (Maybe (HashMap Text Text)) Source #
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
LakeConfigurationResponse
data LakeConfigurationResponse Source #
Provides details of Amazon Security Lake lake configuration object.
See: newLakeConfigurationResponse smart constructor.
Constructors
| LakeConfigurationResponse' | |
Fields
| |
Instances
newLakeConfigurationResponse :: LakeConfigurationResponse Source #
Create a value of LakeConfigurationResponse 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:encryptionKey:LakeConfigurationResponse', lakeConfigurationResponse_encryptionKey - The type of encryption key used by secure the Security Lake
configuration object.
$sel:replicationDestinationRegions:LakeConfigurationResponse', lakeConfigurationResponse_replicationDestinationRegions - Replication enables automatic, asynchronous copying of objects across
Amazon S3 buckets. Amazon S3 buckets that are configured for object
replication can be owned by the same Amazon Web Services account or by
different accounts. You can replicate objects to a single destination
bucket or to multiple destination buckets. The destination buckets can
be in different Amazon Web Services Regions or within the same Region as
the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
$sel:replicationRoleArn:LakeConfigurationResponse', lakeConfigurationResponse_replicationRoleArn - Replication settings for the Amazon S3 buckets. This parameter uses the
IAM role you created that is managed by Security Lake, to ensure the
replication setting is correct.
$sel:retentionSettings:LakeConfigurationResponse', lakeConfigurationResponse_retentionSettings - Retention settings for the destination Amazon S3 buckets.
$sel:s3BucketArn:LakeConfigurationResponse', lakeConfigurationResponse_s3BucketArn - Amazon Resource Names (ARNs) uniquely identify Amazon Web Services
resources. Security Lake requires an ARN when you need to specify a
resource unambiguously across all of Amazon Web Services, such as in IAM
policies, Amazon Relational Database Service (Amazon RDS) tags, and API
calls.
$sel:status:LakeConfigurationResponse', lakeConfigurationResponse_status - Retrieves the status of the configuration operation for an account in
Amazon Security Lake.
$sel:tagsMap:LakeConfigurationResponse', lakeConfigurationResponse_tagsMap - A tag is a label that you assign to an Amazon Web Services resource.
Each tag consists of a key and an optional value, both of which you
define.
lakeConfigurationResponse_encryptionKey :: Lens' LakeConfigurationResponse (Maybe Text) Source #
The type of encryption key used by secure the Security Lake configuration object.
lakeConfigurationResponse_replicationDestinationRegions :: Lens' LakeConfigurationResponse (Maybe [Region]) Source #
Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
lakeConfigurationResponse_replicationRoleArn :: Lens' LakeConfigurationResponse (Maybe Text) Source #
Replication settings for the Amazon S3 buckets. This parameter uses the IAM role you created that is managed by Security Lake, to ensure the replication setting is correct.
lakeConfigurationResponse_retentionSettings :: Lens' LakeConfigurationResponse (Maybe [RetentionSetting]) Source #
Retention settings for the destination Amazon S3 buckets.
lakeConfigurationResponse_s3BucketArn :: Lens' LakeConfigurationResponse (Maybe Text) Source #
Amazon Resource Names (ARNs) uniquely identify Amazon Web Services resources. Security Lake requires an ARN when you need to specify a resource unambiguously across all of Amazon Web Services, such as in IAM policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls.
lakeConfigurationResponse_status :: Lens' LakeConfigurationResponse (Maybe SettingsStatus) Source #
Retrieves the status of the configuration operation for an account in Amazon Security Lake.
lakeConfigurationResponse_tagsMap :: Lens' LakeConfigurationResponse (Maybe (HashMap Text Text)) Source #
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
LogsStatus
data LogsStatus Source #
Retrieves the Logs status for the Amazon Security Lake account.
See: newLogsStatus smart constructor.
Constructors
| LogsStatus' | |
Fields
| |
Instances
Arguments
| :: SourceStatus | |
| -> Text | |
| -> LogsStatus |
Create a value of LogsStatus 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:healthStatus:LogsStatus', logsStatus_healthStatus - The health status of services, including error codes and patterns.
$sel:pathToLogs:LogsStatus', logsStatus_pathToLogs - Defines path the stored logs are available which has information on your
systems, applications, and services.
logsStatus_healthStatus :: Lens' LogsStatus SourceStatus Source #
The health status of services, including error codes and patterns.
logsStatus_pathToLogs :: Lens' LogsStatus Text Source #
Defines path the stored logs are available which has information on your systems, applications, and services.
ProtocolAndNotificationEndpoint
data ProtocolAndNotificationEndpoint Source #
Protocol used in Amazon Security Lake that dictates how notifications are posted at the endpoint.
See: newProtocolAndNotificationEndpoint smart constructor.
Constructors
| ProtocolAndNotificationEndpoint' | |
Instances
newProtocolAndNotificationEndpoint :: ProtocolAndNotificationEndpoint Source #
Create a value of ProtocolAndNotificationEndpoint 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:endpoint:ProtocolAndNotificationEndpoint', protocolAndNotificationEndpoint_endpoint - The account that is subscribed to receive exception notifications.
$sel:protocol:ProtocolAndNotificationEndpoint', protocolAndNotificationEndpoint_protocol - The protocol to which notification messages are posted.
protocolAndNotificationEndpoint_endpoint :: Lens' ProtocolAndNotificationEndpoint (Maybe Text) Source #
The account that is subscribed to receive exception notifications.
protocolAndNotificationEndpoint_protocol :: Lens' ProtocolAndNotificationEndpoint (Maybe Text) Source #
The protocol to which notification messages are posted.
RetentionSetting
data RetentionSetting Source #
Retention settings for the destination Amazon S3 buckets in Amazon Security Lake.
See: newRetentionSetting smart constructor.
Constructors
| RetentionSetting' | |
Fields
| |
Instances
newRetentionSetting :: RetentionSetting Source #
Create a value of RetentionSetting 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:retentionPeriod:RetentionSetting', retentionSetting_retentionPeriod - The retention period specifies a fixed period of time during which the
Security Lake object remains locked. You can specify the retention
period in days for one or more sources.
$sel:storageClass:RetentionSetting', retentionSetting_storageClass - The range of storage classes that you can choose from based on the data
access, resiliency, and cost requirements of your workloads.
retentionSetting_retentionPeriod :: Lens' RetentionSetting (Maybe Natural) Source #
The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.
retentionSetting_storageClass :: Lens' RetentionSetting (Maybe StorageClass) Source #
The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
SourceType
data SourceType Source #
The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
See: newSourceType smart constructor.
Constructors
| SourceType' | |
Fields
| |
Instances
newSourceType :: SourceType Source #
Create a value of SourceType 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:awsSourceType:SourceType', sourceType_awsSourceType - Amazon Security Lake supports log and event collection for natively
supported Amazon Web Services.
$sel:customSourceType:SourceType', sourceType_customSourceType - Amazon Security Lake supports custom source types. For a detailed list,
see the Amazon Security Lake User Guide.
sourceType_awsSourceType :: Lens' SourceType (Maybe AwsLogSourceType) Source #
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
sourceType_customSourceType :: Lens' SourceType (Maybe Text) Source #
Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.
SubscriberResource
data SubscriberResource Source #
Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.
See: newSubscriberResource smart constructor.
Constructors
| SubscriberResource' | |
Fields
| |
Instances
newSubscriberResource Source #
Arguments
| :: Text | |
| -> Text | |
| -> SubscriberResource |
Create a value of SubscriberResource 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:accessTypes:SubscriberResource', subscriberResource_accessTypes - You can choose to notify subscribers of new objects with an Amazon
Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS
endpoint provided by the subscriber.
Subscribers can consume data by directly querying Lake Formation tables
in your Amazon S3 bucket through services like Amazon Athena. This
subscription type is defined as LAKEFORMATION.
$sel:createdAt:SubscriberResource', subscriberResource_createdAt - The date and time when the subscription was created.
$sel:externalId:SubscriberResource', subscriberResource_externalId - The external ID of the subscriber. The external ID 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.
$sel:roleArn:SubscriberResource', subscriberResource_roleArn - The Amazon Resource Name (ARN) specifying the role of the subscriber.
$sel:s3BucketArn:SubscriberResource', subscriberResource_s3BucketArn - The ARN for the Amazon S3 bucket.
$sel:snsArn:SubscriberResource', subscriberResource_snsArn - The ARN for the Amazon Simple Notification Service.
$sel:subscriberDescription:SubscriberResource', subscriberResource_subscriberDescription - The subscriber descriptions for a subscriber account. The description
for a subscriber includes subscriberName, accountID, externalID,
and subscriptionId.
$sel:subscriberName:SubscriberResource', subscriberResource_subscriberName - The name of your Amazon Security Lake subscriber account.
$sel:subscriptionEndpoint:SubscriberResource', subscriberResource_subscriptionEndpoint - The subscription endpoint to which exception messages are posted.
$sel:subscriptionProtocol:SubscriberResource', subscriberResource_subscriptionProtocol - The subscription protocol to which exception messages are posted.
$sel:subscriptionStatus:SubscriberResource', subscriberResource_subscriptionStatus - The subscription status of the Amazon Security Lake subscriber account.
$sel:updatedAt:SubscriberResource', subscriberResource_updatedAt - The date and time when the subscription was created.
$sel:accountId:SubscriberResource', subscriberResource_accountId - The Amazon Web Services account ID you are using to create your Amazon
Security Lake account.
$sel:sourceTypes:SubscriberResource', subscriberResource_sourceTypes - Amazon Security Lake supports log and event collection for natively
supported Amazon Web Services. For more information, see the Amazon
Security Lake User Guide.
$sel:subscriptionId:SubscriberResource', subscriberResource_subscriptionId - The subscription ID of the Amazon Security Lake subscriber account.
subscriberResource_accessTypes :: Lens' SubscriberResource (Maybe [AccessType]) Source #
You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.
Subscribers can consume data by directly querying Lake Formation tables
in your Amazon S3 bucket through services like Amazon Athena. This
subscription type is defined as LAKEFORMATION.
subscriberResource_createdAt :: Lens' SubscriberResource (Maybe UTCTime) Source #
The date and time when the subscription was created.
subscriberResource_externalId :: Lens' SubscriberResource (Maybe Text) Source #
The external ID of the subscriber. The external ID 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.
subscriberResource_roleArn :: Lens' SubscriberResource (Maybe Text) Source #
The Amazon Resource Name (ARN) specifying the role of the subscriber.
subscriberResource_s3BucketArn :: Lens' SubscriberResource (Maybe Text) Source #
The ARN for the Amazon S3 bucket.
subscriberResource_snsArn :: Lens' SubscriberResource (Maybe Text) Source #
The ARN for the Amazon Simple Notification Service.
subscriberResource_subscriberDescription :: Lens' SubscriberResource (Maybe Text) Source #
The subscriber descriptions for a subscriber account. The description
for a subscriber includes subscriberName, accountID, externalID,
and subscriptionId.
subscriberResource_subscriberName :: Lens' SubscriberResource (Maybe Text) Source #
The name of your Amazon Security Lake subscriber account.
subscriberResource_subscriptionEndpoint :: Lens' SubscriberResource (Maybe Text) Source #
The subscription endpoint to which exception messages are posted.
subscriberResource_subscriptionProtocol :: Lens' SubscriberResource (Maybe EndpointProtocol) Source #
The subscription protocol to which exception messages are posted.
subscriberResource_subscriptionStatus :: Lens' SubscriberResource (Maybe SubscriptionStatus) Source #
The subscription status of the Amazon Security Lake subscriber account.
subscriberResource_updatedAt :: Lens' SubscriberResource (Maybe UTCTime) Source #
The date and time when the subscription was created.
subscriberResource_accountId :: Lens' SubscriberResource Text Source #
The Amazon Web Services account ID you are using to create your Amazon Security Lake account.
subscriberResource_sourceTypes :: Lens' SubscriberResource [SourceType] Source #
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
subscriberResource_subscriptionId :: Lens' SubscriberResource Text Source #
The subscription ID of the Amazon Security Lake subscriber account.