AwsCloudtrailEventDataStoreArgs

interface AwsCloudtrailEventDataStoreArgs extends Omit<aws.cloudtrail.EventDataStoreArgs, 'kmsKeyId' | 'name' | 'tags'> { advancedEventSelectors?: Input<Input<EventDataStoreAdvancedEventSelector>[] | undefined>; billingMode?: Input<string | undefined>; kmsKey?: AwsKmsKeyInput; multiRegionEnabled?: Input<boolean | undefined>; name: Input<string>; organizationEnabled?: Input<boolean | undefined>; region?: Input<string | undefined>; retentionPeriod?: Input<number | undefined>; suspend?: Input<string | undefined>; tags?: Input<Record<string, Input<string>>>; terminationProtectionEnabled?: Input<boolean | undefined>; }

Input arguments for the CloudTrail event data store capability.

Example

CODE
const eventDataStore: AwsCloudtrailEventDataStoreArgs = {
  name: 'securityAuditStore',
  multiRegionEnabled: true,
  retentionPeriod: 2555,
};

Hierarchy

  • EventDataStoreArgs, "kmsKeyId" | "name" | "tags">
  • AwsCloudtrailEventDataStoreArgs

Properties

advancedEventSelectors: Input<Input<EventDataStoreAdvancedEventSelector>[] | undefined>

Inherited from 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.

billingMode: Input<string | undefined>

Inherited from billingMode

The billing mode for the event data store. The valid values are EXTENDABLE_RETENTION_PRICING and FIXED_RETENTION_PRICING. Defaults to EXTENDABLE_RETENTION_PRICING.

kmsKey: AwsKmsKeyInput

Optional customer-managed KMS key used to encrypt stored events.

multiRegionEnabled: Input<boolean | undefined>

Inherited from 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. Default: true.

name: Input<string>

Required event data store purpose used to build the AWS resource name ({env}-{projectHash}-{purpose}).

organizationEnabled: Input<boolean | undefined>

Inherited from organizationEnabled

Specifies whether an event data store collects events logged for an organization in AWS Organizations. Default: false.

region: Input<string | undefined>

Inherited from region

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

retentionPeriod: Input<number | undefined>

Inherited from retentionPeriod

The retention period of the event data store, in days. You can set a retention period of up to 2555 days, the equivalent of seven years. Default: 2555.

suspend: Input<string | undefined>

Inherited from suspend

Specifies whether to stop ingesting new events into the event data store. If set to true, ingestion is suspended while maintaining the ability to query existing events. If set to false, ingestion is active.

tags: Input<Record<string, Input<string>>>

Optional tags merged with runtime default tags.

terminationProtectionEnabled: Input<boolean | undefined>

Inherited from 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. Default: true.