Interface ICfnEventDataStoreProps
Properties for defining a CfnEventDataStore
.
Namespace: Amazon.CDK.AWS.CloudTrail
Assembly: Amazon.CDK.AWS.CloudTrail.dll
Syntax (csharp)
public interface ICfnEventDataStoreProps
Syntax (vb)
Public Interface ICfnEventDataStoreProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudTrail;
var cfnEventDataStoreProps = new CfnEventDataStoreProps {
AdvancedEventSelectors = new [] { new AdvancedEventSelectorProperty {
FieldSelectors = new [] { new AdvancedFieldSelectorProperty {
Field = "field",
// the properties below are optional
EndsWith = new [] { "endsWith" },
EqualTo = new [] { "equalTo" },
NotEndsWith = new [] { "notEndsWith" },
NotEquals = new [] { "notEquals" },
NotStartsWith = new [] { "notStartsWith" },
StartsWith = new [] { "startsWith" }
} },
// the properties below are optional
Name = "name"
} },
IngestionEnabled = false,
KmsKeyId = "kmsKeyId",
MultiRegionEnabled = false,
Name = "name",
OrganizationEnabled = false,
RetentionPeriod = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TerminationProtectionEnabled = false
};
Synopsis
Properties
AdvancedEventSelectors | The advanced event selectors to use to select the events for the data store. |
IngestionEnabled | Specifies whether the event data store should start ingesting live events. |
KmsKeyId | Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail. |
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. |
Name | The name of the event data store. |
OrganizationEnabled | Specifies whether an event data store collects events logged for an organization in AWS Organizations . |
RetentionPeriod | The retention period of the event data store, in days. |
Tags | A list of tags. |
TerminationProtectionEnabled | Specifies whether termination protection is enabled for the event data store. |
Properties
AdvancedEventSelectors
The advanced event selectors to use to select the events for the data store.
virtual object AdvancedEventSelectors { get; }
Property Value
System.Object
Remarks
You can configure up to five advanced event selectors for each event data store.
For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide.
For more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see Create an event data store for AWS Config configuration items in the CloudTrail User Guide.
For more information about how to use advanced event selectors to include non- AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.
IngestionEnabled
Specifies whether the event data store should start ingesting live events.
virtual object IngestionEnabled { get; }
Property Value
System.Object
Remarks
KmsKeyId
Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
virtual string KmsKeyId { get; }
Property Value
System.String
Remarks
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 AWS KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide .
Examples:
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.
virtual object MultiRegionEnabled { get; }
Property Value
System.Object
Remarks
Name
The name of the event data store.
virtual string Name { get; }
Property Value
System.String
Remarks
OrganizationEnabled
Specifies whether an event data store collects events logged for an organization in AWS Organizations .
virtual object OrganizationEnabled { get; }
Property Value
System.Object
Remarks
RetentionPeriod
The retention period of the event data store, in days.
virtual Nullable<double> RetentionPeriod { get; }
Property Value
System.Nullable<System.Double>
Remarks
You can set a retention period of up to 2557 days, the equivalent of seven years.
Tags
TerminationProtectionEnabled
Specifies whether termination protection is enabled for the event data store.
virtual object TerminationProtectionEnabled { get; }
Property Value
System.Object
Remarks
If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.