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 |
Creates a new event data store.
Synopsis
- data CreateEventDataStore = CreateEventDataStore' {}
- newCreateEventDataStore :: Text -> CreateEventDataStore
- createEventDataStore_advancedEventSelectors :: Lens' CreateEventDataStore (Maybe [AdvancedEventSelector])
- createEventDataStore_kmsKeyId :: Lens' CreateEventDataStore (Maybe Text)
- createEventDataStore_multiRegionEnabled :: Lens' CreateEventDataStore (Maybe Bool)
- createEventDataStore_organizationEnabled :: Lens' CreateEventDataStore (Maybe Bool)
- createEventDataStore_retentionPeriod :: Lens' CreateEventDataStore (Maybe Natural)
- createEventDataStore_tagsList :: Lens' CreateEventDataStore (Maybe [Tag])
- createEventDataStore_terminationProtectionEnabled :: Lens' CreateEventDataStore (Maybe Bool)
- createEventDataStore_name :: Lens' CreateEventDataStore Text
- data CreateEventDataStoreResponse = CreateEventDataStoreResponse' {
- advancedEventSelectors :: Maybe [AdvancedEventSelector]
- createdTimestamp :: Maybe POSIX
- eventDataStoreArn :: Maybe Text
- kmsKeyId :: Maybe Text
- multiRegionEnabled :: Maybe Bool
- name :: Maybe Text
- organizationEnabled :: Maybe Bool
- retentionPeriod :: Maybe Natural
- status :: Maybe EventDataStoreStatus
- tagsList :: Maybe [Tag]
- terminationProtectionEnabled :: Maybe Bool
- updatedTimestamp :: Maybe POSIX
- httpStatus :: Int
- newCreateEventDataStoreResponse :: Int -> CreateEventDataStoreResponse
- createEventDataStoreResponse_advancedEventSelectors :: Lens' CreateEventDataStoreResponse (Maybe [AdvancedEventSelector])
- createEventDataStoreResponse_createdTimestamp :: Lens' CreateEventDataStoreResponse (Maybe UTCTime)
- createEventDataStoreResponse_eventDataStoreArn :: Lens' CreateEventDataStoreResponse (Maybe Text)
- createEventDataStoreResponse_kmsKeyId :: Lens' CreateEventDataStoreResponse (Maybe Text)
- createEventDataStoreResponse_multiRegionEnabled :: Lens' CreateEventDataStoreResponse (Maybe Bool)
- createEventDataStoreResponse_name :: Lens' CreateEventDataStoreResponse (Maybe Text)
- createEventDataStoreResponse_organizationEnabled :: Lens' CreateEventDataStoreResponse (Maybe Bool)
- createEventDataStoreResponse_retentionPeriod :: Lens' CreateEventDataStoreResponse (Maybe Natural)
- createEventDataStoreResponse_status :: Lens' CreateEventDataStoreResponse (Maybe EventDataStoreStatus)
- createEventDataStoreResponse_tagsList :: Lens' CreateEventDataStoreResponse (Maybe [Tag])
- createEventDataStoreResponse_terminationProtectionEnabled :: Lens' CreateEventDataStoreResponse (Maybe Bool)
- createEventDataStoreResponse_updatedTimestamp :: Lens' CreateEventDataStoreResponse (Maybe UTCTime)
- createEventDataStoreResponse_httpStatus :: Lens' CreateEventDataStoreResponse Int
Creating a Request
data CreateEventDataStore Source #
See: newCreateEventDataStore
smart constructor.
CreateEventDataStore' | |
|
Instances
newCreateEventDataStore Source #
Create a value of CreateEventDataStore
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:
CreateEventDataStore
, createEventDataStore_advancedEventSelectors
- The advanced event selectors to use to select the events for the data
store. For more information about how to use advanced event selectors,
see
Log events by using advanced event selectors
in the CloudTrail User Guide.
CreateEventDataStore
, createEventDataStore_kmsKeyId
- Specifies the KMS key ID to use to encrypt the events delivered by
CloudTrail. The value can be an alias name prefixed by alias/
, a
fully specified ARN to an alias, a fully specified ARN to a key, or a
globally unique identifier.
Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
Examples:
alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
CreateEventDataStore
, createEventDataStore_multiRegionEnabled
- Specifies whether the event data store includes events from all regions,
or only from the region in which the event data store is created.
CreateEventDataStore
, createEventDataStore_organizationEnabled
- Specifies whether an event data store collects events logged for an
organization in Organizations.
CreateEventDataStore
, createEventDataStore_retentionPeriod
- The retention period of the event data store, in days. You can set a
retention period of up to 2557 days, the equivalent of seven years.
CreateEventDataStore
, createEventDataStore_tagsList
- Undocumented member.
CreateEventDataStore
, createEventDataStore_terminationProtectionEnabled
- Specifies whether termination protection is enabled for the event data
store. If termination protection is enabled, you cannot delete the event
data store until termination protection is disabled.
CreateEventDataStore
, createEventDataStore_name
- The name of the event data store.
Request Lenses
createEventDataStore_advancedEventSelectors :: Lens' CreateEventDataStore (Maybe [AdvancedEventSelector]) Source #
The advanced event selectors to use to select the events for the data store. For more information about how to use advanced event selectors, see Log events by using advanced event selectors in the CloudTrail User Guide.
createEventDataStore_kmsKeyId :: Lens' CreateEventDataStore (Maybe Text) Source #
Specifies the KMS key ID to use to encrypt the events delivered by
CloudTrail. The value can be an alias name prefixed by alias/
, a
fully specified ARN to an alias, a fully specified ARN to a key, or a
globally unique identifier.
Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
Examples:
alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
createEventDataStore_multiRegionEnabled :: Lens' CreateEventDataStore (Maybe Bool) Source #
Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
createEventDataStore_organizationEnabled :: Lens' CreateEventDataStore (Maybe Bool) Source #
Specifies whether an event data store collects events logged for an organization in Organizations.
createEventDataStore_retentionPeriod :: Lens' CreateEventDataStore (Maybe Natural) Source #
The retention period of the event data store, in days. You can set a retention period of up to 2557 days, the equivalent of seven years.
createEventDataStore_tagsList :: Lens' CreateEventDataStore (Maybe [Tag]) Source #
Undocumented member.
createEventDataStore_terminationProtectionEnabled :: Lens' CreateEventDataStore (Maybe Bool) Source #
Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.
createEventDataStore_name :: Lens' CreateEventDataStore Text Source #
The name of the event data store.
Destructuring the Response
data CreateEventDataStoreResponse Source #
See: newCreateEventDataStoreResponse
smart constructor.
CreateEventDataStoreResponse' | |
|
Instances
newCreateEventDataStoreResponse Source #
Create a value of CreateEventDataStoreResponse
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:
CreateEventDataStore
, createEventDataStoreResponse_advancedEventSelectors
- The advanced event selectors that were used to select the events for the
data store.
CreateEventDataStoreResponse
, createEventDataStoreResponse_createdTimestamp
- The timestamp that shows when the event data store was created.
CreateEventDataStoreResponse
, createEventDataStoreResponse_eventDataStoreArn
- The ARN of the event data store.
CreateEventDataStore
, createEventDataStoreResponse_kmsKeyId
- Specifies the KMS key ID that encrypts the events delivered by
CloudTrail. The value is a fully specified ARN to a KMS key in the
following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
CreateEventDataStore
, createEventDataStoreResponse_multiRegionEnabled
- Indicates whether the event data store collects events from all regions,
or only from the region in which it was created.
CreateEventDataStore
, createEventDataStoreResponse_name
- The name of the event data store.
CreateEventDataStore
, createEventDataStoreResponse_organizationEnabled
- Indicates whether an event data store is collecting logged events for an
organization in Organizations.
CreateEventDataStore
, createEventDataStoreResponse_retentionPeriod
- The retention period of an event data store, in days.
CreateEventDataStoreResponse
, createEventDataStoreResponse_status
- The status of event data store creation.
CreateEventDataStore
, createEventDataStoreResponse_tagsList
- Undocumented member.
CreateEventDataStore
, createEventDataStoreResponse_terminationProtectionEnabled
- Indicates whether termination protection is enabled for the event data
store.
CreateEventDataStoreResponse
, createEventDataStoreResponse_updatedTimestamp
- The timestamp that shows when an event data store was updated, if
applicable. UpdatedTimestamp
is always either the same or newer than
the time shown in CreatedTimestamp
.
$sel:httpStatus:CreateEventDataStoreResponse'
, createEventDataStoreResponse_httpStatus
- The response's http status code.
Response Lenses
createEventDataStoreResponse_advancedEventSelectors :: Lens' CreateEventDataStoreResponse (Maybe [AdvancedEventSelector]) Source #
The advanced event selectors that were used to select the events for the data store.
createEventDataStoreResponse_createdTimestamp :: Lens' CreateEventDataStoreResponse (Maybe UTCTime) Source #
The timestamp that shows when the event data store was created.
createEventDataStoreResponse_eventDataStoreArn :: Lens' CreateEventDataStoreResponse (Maybe Text) Source #
The ARN of the event data store.
createEventDataStoreResponse_kmsKeyId :: Lens' CreateEventDataStoreResponse (Maybe Text) Source #
Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
createEventDataStoreResponse_multiRegionEnabled :: Lens' CreateEventDataStoreResponse (Maybe Bool) Source #
Indicates whether the event data store collects events from all regions, or only from the region in which it was created.
createEventDataStoreResponse_name :: Lens' CreateEventDataStoreResponse (Maybe Text) Source #
The name of the event data store.
createEventDataStoreResponse_organizationEnabled :: Lens' CreateEventDataStoreResponse (Maybe Bool) Source #
Indicates whether an event data store is collecting logged events for an organization in Organizations.
createEventDataStoreResponse_retentionPeriod :: Lens' CreateEventDataStoreResponse (Maybe Natural) Source #
The retention period of an event data store, in days.
createEventDataStoreResponse_status :: Lens' CreateEventDataStoreResponse (Maybe EventDataStoreStatus) Source #
The status of event data store creation.
createEventDataStoreResponse_tagsList :: Lens' CreateEventDataStoreResponse (Maybe [Tag]) Source #
Undocumented member.
createEventDataStoreResponse_terminationProtectionEnabled :: Lens' CreateEventDataStoreResponse (Maybe Bool) Source #
Indicates whether termination protection is enabled for the event data store.
createEventDataStoreResponse_updatedTimestamp :: Lens' CreateEventDataStoreResponse (Maybe UTCTime) Source #
The timestamp that shows when an event data store was updated, if
applicable. UpdatedTimestamp
is always either the same or newer than
the time shown in CreatedTimestamp
.
createEventDataStoreResponse_httpStatus :: Lens' CreateEventDataStoreResponse Int Source #
The response's http status code.