Class: Aws::CloudTrail::Types::UpdateEventDataStoreRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudtrail/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_event_selectors ⇒ Array<Types::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.

Returns:



5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 5102

class UpdateEventDataStoreRequest < Struct.new(
  :event_data_store,
  :name,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :kms_key_id,
  :billing_mode)
  SENSITIVE = []
  include Aws::Structure
end

#billing_mode ⇒ String

<note markdown=“1”> You can’t change the billing mode from ‘EXTENDABLE_RETENTION_PRICING` to `FIXED_RETENTION_PRICING`. If `BillingMode` is set to `EXTENDABLE_RETENTION_PRICING` and you want to use `FIXED_RETENTION_PRICING` instead, you’ll need to stop ingestion on the event data store and create a new event data store that uses ‘FIXED_RETENTION_PRICING`.

</note>

The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.

The following are the possible values:

  • ‘EXTENDABLE_RETENTION_PRICING` - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days.

  • ‘FIXED_RETENTION_PRICING` - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days.

For more information about CloudTrail pricing, see [CloudTrail Pricing] and [Managing CloudTrail Lake costs].

[1]: aws.amazon.com/cloudtrail/pricing/ [2]: docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html

Returns:

  • (String) 


5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 5102

class UpdateEventDataStoreRequest < Struct.new(
  :event_data_store,
  :name,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :kms_key_id,
  :billing_mode)
  SENSITIVE = []
  include Aws::Structure
end

#event_data_store ⇒ String

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

Returns:

  • (String) 


5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 5102

class UpdateEventDataStoreRequest < Struct.new(
  :event_data_store,
  :name,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :kms_key_id,
  :billing_mode)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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`

[1]: docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html

Returns:

  • (String) 


5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 5102

class UpdateEventDataStoreRequest < Struct.new(
  :event_data_store,
  :name,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :kms_key_id,
  :billing_mode)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 5102

class UpdateEventDataStoreRequest < Struct.new(
  :event_data_store,
  :name,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :kms_key_id,
  :billing_mode)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The event data store name.

Returns:

  • (String) 


5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 5102

class UpdateEventDataStoreRequest < Struct.new(
  :event_data_store,
  :name,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :kms_key_id,
  :billing_mode)
  SENSITIVE = []
  include Aws::Structure
end

#organization_enabled ⇒ Boolean

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

<note markdown=“1”> Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

</note>

Returns:

  • (Boolean) 


5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 5102

class UpdateEventDataStoreRequest < Struct.new(
  :event_data_store,
  :name,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :kms_key_id,
  :billing_mode)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period ⇒ Integer

The retention period of the event data store, in days. If ‘BillingMode` is set to `EXTENDABLE_RETENTION_PRICING`, you can set a retention period of up to 3653 days, the equivalent of 10 years. If `BillingMode` is set to `FIXED_RETENTION_PRICING`, you can set a retention period of up to 2557 days, the equivalent of seven years.

CloudTrail Lake determines whether to retain an event by checking if the ‘eventTime` of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the `eventTime` is older than 90 days.

<note markdown=“1”> If you decrease the retention period of an event data store, CloudTrail will remove any events with an ‘eventTime` older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an `eventTime` older than 100 days.

</note>

Returns:

  • (Integer) 


5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 5102

class UpdateEventDataStoreRequest < Struct.new(
  :event_data_store,
  :name,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :kms_key_id,
  :billing_mode)
  SENSITIVE = []
  include Aws::Structure
end

#termination_protection_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
 
# File 'lib/aws-sdk-cloudtrail/types.rb', line 5102

class UpdateEventDataStoreRequest < Struct.new(
  :event_data_store,
  :name,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :kms_key_id,
  :billing_mode)
  SENSITIVE = []
  include Aws::Structure
end