Amazonka.CloudTrail.UpdateEventDataStore

Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 90 and 2557. By default, TerminationProtection is enabled. AdvancedEventSelectors includes or excludes management and data events in your event data store; for more information about AdvancedEventSelectors, see PutEventSelectorsRequest$AdvancedEventSelectors.

Creating a Request

data UpdateEventDataStore

See: newUpdateEventDataStore smart constructor.

Constructors

UpdateEventDataStore'

Fields

• advancedEventSelectors :: Maybe [AdvancedEventSelector]

  The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

• 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 an event data store collects events from all regions, or only from the region in which it was created.

• name :: Maybe Text

  The event data store name.

• organizationEnabled :: Maybe Bool

  Specifies whether an event data store collects events logged for an organization in Organizations.

• retentionPeriod :: Maybe Natural

  The retention period, in days.

• terminationProtectionEnabled :: Maybe Bool

  Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

• eventDataStore :: Text

  The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Instances

ToJSON UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

toJSON :: UpdateEventDataStore -> Value

toEncoding :: UpdateEventDataStore -> Encoding

toJSONList :: [UpdateEventDataStore] -> Value

toEncodingList :: [UpdateEventDataStore] -> Encoding

ToHeaders UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

toHeaders :: UpdateEventDataStore -> [Header]

ToPath UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

toPath :: UpdateEventDataStore -> ByteString

ToQuery UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

toQuery :: UpdateEventDataStore -> QueryString

AWSRequest UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Associated Types

type AWSResponse UpdateEventDataStore

Methods

request :: (Service -> Service) -> UpdateEventDataStore -> Request UpdateEventDataStore

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateEventDataStore -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateEventDataStore)))

Generic UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Associated Types

type Rep UpdateEventDataStore :: Type -> Type

Methods

from :: UpdateEventDataStore -> Rep UpdateEventDataStore x

to :: Rep UpdateEventDataStore x -> UpdateEventDataStore

Read UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

readsPrec :: Int -> ReadS UpdateEventDataStore

readList :: ReadS [UpdateEventDataStore]

readPrec :: ReadPrec UpdateEventDataStore

readListPrec :: ReadPrec [UpdateEventDataStore]

Show UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

showsPrec :: Int -> UpdateEventDataStore -> ShowS

show :: UpdateEventDataStore -> String

showList :: [UpdateEventDataStore] -> ShowS

NFData UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

rnf :: UpdateEventDataStore -> ()

Eq UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

(==) :: UpdateEventDataStore -> UpdateEventDataStore -> Bool

(/=) :: UpdateEventDataStore -> UpdateEventDataStore -> Bool

Hashable UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

hashWithSalt :: Int -> UpdateEventDataStore -> Int

hash :: UpdateEventDataStore -> Int

type AWSResponse UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

type AWSResponse UpdateEventDataStore = UpdateEventDataStoreResponse

type Rep UpdateEventDataStore

Defined in Amazonka.CloudTrail.UpdateEventDataStore

type Rep UpdateEventDataStore = D1 ('MetaData "UpdateEventDataStore" "Amazonka.CloudTrail.UpdateEventDataStore" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "UpdateEventDataStore'" '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 "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 "terminationProtectionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "eventDataStore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateEventDataStore

Arguments

:: Text

$sel:eventDataStore:UpdateEventDataStore'

-> UpdateEventDataStore

Create a value of UpdateEventDataStore 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:

UpdateEventDataStore, updateEventDataStore_advancedEventSelectors - The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

UpdateEventDataStore, updateEventDataStore_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

UpdateEventDataStore, updateEventDataStore_multiRegionEnabled - Specifies whether an event data store collects events from all regions, or only from the region in which it was created.

UpdateEventDataStore, updateEventDataStore_name - The event data store name.

UpdateEventDataStore, updateEventDataStore_organizationEnabled - Specifies whether an event data store collects events logged for an organization in Organizations.

UpdateEventDataStore, updateEventDataStore_retentionPeriod - The retention period, in days.

UpdateEventDataStore, updateEventDataStore_terminationProtectionEnabled - Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

$sel:eventDataStore:UpdateEventDataStore', updateEventDataStore_eventDataStore - The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Request Lenses

updateEventDataStore_advancedEventSelectors :: Lens' UpdateEventDataStore (Maybe [AdvancedEventSelector])

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

updateEventDataStore_kmsKeyId :: Lens' UpdateEventDataStore (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

updateEventDataStore_multiRegionEnabled :: Lens' UpdateEventDataStore (Maybe Bool)

Specifies whether an event data store collects events from all regions, or only from the region in which it was created.

updateEventDataStore_name :: Lens' UpdateEventDataStore (Maybe Text)

The event data store name.

updateEventDataStore_organizationEnabled :: Lens' UpdateEventDataStore (Maybe Bool)

Specifies whether an event data store collects events logged for an organization in Organizations.

updateEventDataStore_retentionPeriod :: Lens' UpdateEventDataStore (Maybe Natural)

The retention period, in days.

updateEventDataStore_terminationProtectionEnabled :: Lens' UpdateEventDataStore (Maybe Bool)

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

updateEventDataStore_eventDataStore :: Lens' UpdateEventDataStore Text

The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Destructuring the Response

data UpdateEventDataStoreResponse

See: newUpdateEventDataStoreResponse smart constructor.

Constructors

UpdateEventDataStoreResponse'

Fields

• advancedEventSelectors :: Maybe [AdvancedEventSelector]

  The advanced event selectors that are applied to the event data store.

• createdTimestamp :: Maybe POSIX

  The timestamp that shows when an event data store was first 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 includes 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, in days.

• status :: Maybe EventDataStoreStatus

  The status of an event data store. Values can be ENABLED and PENDING_DELETION.

• terminationProtectionEnabled :: Maybe Bool

  Indicates whether termination protection is enabled for the event data store.

• updatedTimestamp :: Maybe POSIX

  The timestamp that shows when the event data store was last updated. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateEventDataStoreResponse

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Associated Types

type Rep UpdateEventDataStoreResponse :: Type -> Type

Methods

from :: UpdateEventDataStoreResponse -> Rep UpdateEventDataStoreResponse x

to :: Rep UpdateEventDataStoreResponse x -> UpdateEventDataStoreResponse

Read UpdateEventDataStoreResponse

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

readsPrec :: Int -> ReadS UpdateEventDataStoreResponse

readList :: ReadS [UpdateEventDataStoreResponse]

readPrec :: ReadPrec UpdateEventDataStoreResponse

readListPrec :: ReadPrec [UpdateEventDataStoreResponse]

Show UpdateEventDataStoreResponse

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

showsPrec :: Int -> UpdateEventDataStoreResponse -> ShowS

show :: UpdateEventDataStoreResponse -> String

showList :: [UpdateEventDataStoreResponse] -> ShowS

NFData UpdateEventDataStoreResponse

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

rnf :: UpdateEventDataStoreResponse -> ()

Eq UpdateEventDataStoreResponse

Defined in Amazonka.CloudTrail.UpdateEventDataStore

Methods

(==) :: UpdateEventDataStoreResponse -> UpdateEventDataStoreResponse -> Bool

(/=) :: UpdateEventDataStoreResponse -> UpdateEventDataStoreResponse -> Bool

type Rep UpdateEventDataStoreResponse

Defined in Amazonka.CloudTrail.UpdateEventDataStore

type Rep UpdateEventDataStoreResponse = D1 ('MetaData "UpdateEventDataStoreResponse" "Amazonka.CloudTrail.UpdateEventDataStore" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "UpdateEventDataStoreResponse'" '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 "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))))))

newUpdateEventDataStoreResponse

Arguments

:: Int

$sel:httpStatus:UpdateEventDataStoreResponse'

-> UpdateEventDataStoreResponse

Create a value of UpdateEventDataStoreResponse 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:

UpdateEventDataStore, updateEventDataStoreResponse_advancedEventSelectors - The advanced event selectors that are applied to the event data store.

UpdateEventDataStoreResponse, updateEventDataStoreResponse_createdTimestamp - The timestamp that shows when an event data store was first created.

UpdateEventDataStoreResponse, updateEventDataStoreResponse_eventDataStoreArn - The ARN of the event data store.

UpdateEventDataStore, updateEventDataStoreResponse_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

UpdateEventDataStore, updateEventDataStoreResponse_multiRegionEnabled - Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

UpdateEventDataStore, updateEventDataStoreResponse_name - The name of the event data store.

UpdateEventDataStore, updateEventDataStoreResponse_organizationEnabled - Indicates whether an event data store is collecting logged events for an organization in Organizations.

UpdateEventDataStore, updateEventDataStoreResponse_retentionPeriod - The retention period, in days.

UpdateEventDataStoreResponse, updateEventDataStoreResponse_status - The status of an event data store. Values can be ENABLED and PENDING_DELETION.

UpdateEventDataStore, updateEventDataStoreResponse_terminationProtectionEnabled - Indicates whether termination protection is enabled for the event data store.

UpdateEventDataStoreResponse, updateEventDataStoreResponse_updatedTimestamp - The timestamp that shows when the event data store was last updated. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

$sel:httpStatus:UpdateEventDataStoreResponse', updateEventDataStoreResponse_httpStatus - The response's http status code.

Response Lenses

updateEventDataStoreResponse_advancedEventSelectors :: Lens' UpdateEventDataStoreResponse (Maybe [AdvancedEventSelector])

The advanced event selectors that are applied to the event data store.

updateEventDataStoreResponse_createdTimestamp :: Lens' UpdateEventDataStoreResponse (Maybe UTCTime)

The timestamp that shows when an event data store was first created.

updateEventDataStoreResponse_eventDataStoreArn :: Lens' UpdateEventDataStoreResponse (Maybe Text)

The ARN of the event data store.

updateEventDataStoreResponse_kmsKeyId :: Lens' UpdateEventDataStoreResponse (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

updateEventDataStoreResponse_multiRegionEnabled :: Lens' UpdateEventDataStoreResponse (Maybe Bool)

Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

updateEventDataStoreResponse_name :: Lens' UpdateEventDataStoreResponse (Maybe Text)

The name of the event data store.

updateEventDataStoreResponse_organizationEnabled :: Lens' UpdateEventDataStoreResponse (Maybe Bool)

Indicates whether an event data store is collecting logged events for an organization in Organizations.

updateEventDataStoreResponse_retentionPeriod :: Lens' UpdateEventDataStoreResponse (Maybe Natural)

The retention period, in days.

updateEventDataStoreResponse_status :: Lens' UpdateEventDataStoreResponse (Maybe EventDataStoreStatus)

The status of an event data store. Values can be ENABLED and PENDING_DELETION.

updateEventDataStoreResponse_terminationProtectionEnabled :: Lens' UpdateEventDataStoreResponse (Maybe Bool)

Indicates whether termination protection is enabled for the event data store.

updateEventDataStoreResponse_updatedTimestamp :: Lens' UpdateEventDataStoreResponse (Maybe UTCTime)

The timestamp that shows when the event data store was last updated. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

updateEventDataStoreResponse_httpStatus :: Lens' UpdateEventDataStoreResponse Int

The response's http status code.