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.CloudTrail.CreateEventDataStore

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new event data store.

Synopsis

Creating a Request

data CreateEventDataStore Source #

See: newCreateEventDataStore smart constructor.

Constructors

CreateEventDataStore'

Fields

advancedEventSelectors :: Maybe [AdvancedEventSelector]
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.
kmsKeyId :: Maybe Text
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
```
multiRegionEnabled :: Maybe Bool
Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
organizationEnabled :: Maybe Bool
Specifies whether an event data store collects events logged for an organization in Organizations.
retentionPeriod :: Maybe Natural
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.
tagsList :: Maybe [Tag]
terminationProtectionEnabled :: Maybe Bool
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.
name :: Text
The name of the event data store.

Instances

Instances details

ToJSON CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods toJSON :: CreateEventDataStore -> Value # toEncoding :: CreateEventDataStore -> Encoding # toJSONList :: [CreateEventDataStore] -> Value # toEncodingList :: [CreateEventDataStore] -> Encoding #
ToHeaders CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods toHeaders :: CreateEventDataStore -> [Header] #
ToPath CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods toPath :: CreateEventDataStore -> ByteString #
ToQuery CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods toQuery :: CreateEventDataStore -> QueryString #
AWSRequest CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Associated Types type AWSResponse CreateEventDataStore # Methods request :: (Service -> Service) -> CreateEventDataStore -> Request CreateEventDataStore # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateEventDataStore -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEventDataStore))) #
Generic CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Associated Types type Rep CreateEventDataStore :: Type -> Type # Methods from :: CreateEventDataStore -> Rep CreateEventDataStore x # to :: Rep CreateEventDataStore x -> CreateEventDataStore #
Read CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods readsPrec :: Int -> ReadS CreateEventDataStore # readList :: ReadS [CreateEventDataStore] # readPrec :: ReadPrec CreateEventDataStore # readListPrec :: ReadPrec [CreateEventDataStore] #
Show CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods showsPrec :: Int -> CreateEventDataStore -> ShowS # show :: CreateEventDataStore -> String # showList :: [CreateEventDataStore] -> ShowS #
NFData CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods rnf :: CreateEventDataStore -> () #
Eq CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods (==) :: CreateEventDataStore -> CreateEventDataStore -> Bool # (/=) :: CreateEventDataStore -> CreateEventDataStore -> Bool #
Hashable CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods hashWithSalt :: Int -> CreateEventDataStore -> Int # hash :: CreateEventDataStore -> Int #
type AWSResponse CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore type AWSResponse CreateEventDataStore = CreateEventDataStoreResponse
type Rep CreateEventDataStore Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore type Rep CreateEventDataStore = D1 ('MetaData "CreateEventDataStore" "Amazonka.CloudTrail.CreateEventDataStore" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "CreateEventDataStore'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "advancedEventSelectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdvancedEventSelector])) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "multiRegionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "organizationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "tagsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "terminationProtectionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateEventDataStore Source #

Arguments

:: Text	`CreateEventDataStore`
-> CreateEventDataStore

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.

Constructors

CreateEventDataStoreResponse'

Fields

advancedEventSelectors :: Maybe [AdvancedEventSelector]
The advanced event selectors that were used to select the events for the data store.
createdTimestamp :: Maybe POSIX
The timestamp that shows when the event data store was created.
eventDataStoreArn :: Maybe Text
The ARN of the event data store.
kmsKeyId :: Maybe Text
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
```
multiRegionEnabled :: Maybe Bool
Indicates whether the event data store collects events from all regions, or only from the region in which it was created.
name :: Maybe Text
The name of the event data store.
organizationEnabled :: Maybe Bool
Indicates whether an event data store is collecting logged events for an organization in Organizations.
retentionPeriod :: Maybe Natural
The retention period of an event data store, in days.
status :: Maybe EventDataStoreStatus
The status of event data store creation.
tagsList :: Maybe [Tag]
terminationProtectionEnabled :: Maybe Bool
Indicates whether termination protection is enabled for the event data store.
updatedTimestamp :: Maybe POSIX
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Associated Types type Rep CreateEventDataStoreResponse :: Type -> Type # Methods from :: CreateEventDataStoreResponse -> Rep CreateEventDataStoreResponse x # to :: Rep CreateEventDataStoreResponse x -> CreateEventDataStoreResponse #
Read CreateEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods readsPrec :: Int -> ReadS CreateEventDataStoreResponse # readList :: ReadS [CreateEventDataStoreResponse] # readPrec :: ReadPrec CreateEventDataStoreResponse # readListPrec :: ReadPrec [CreateEventDataStoreResponse] #
Show CreateEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods showsPrec :: Int -> CreateEventDataStoreResponse -> ShowS # show :: CreateEventDataStoreResponse -> String # showList :: [CreateEventDataStoreResponse] -> ShowS #
NFData CreateEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods rnf :: CreateEventDataStoreResponse -> () #
Eq CreateEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore Methods (==) :: CreateEventDataStoreResponse -> CreateEventDataStoreResponse -> Bool # (/=) :: CreateEventDataStoreResponse -> CreateEventDataStoreResponse -> Bool #
type Rep CreateEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.CreateEventDataStore type Rep CreateEventDataStoreResponse = D1 ('MetaData "CreateEventDataStoreResponse" "Amazonka.CloudTrail.CreateEventDataStore" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "CreateEventDataStoreResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "advancedEventSelectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdvancedEventSelector])) :: (S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "eventDataStoreArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "multiRegionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "organizationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventDataStoreStatus)))) :: ((S1 ('MetaSel ('Just "tagsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "terminationProtectionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "updatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateEventDataStoreResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEventDataStoreResponse'`
-> CreateEventDataStoreResponse

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.