Class CfnEventDataStore
Creates a new event data store.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudTrail
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEventDataStore : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnEventDataStore
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
CloudformationResource: AWS::CloudTrail::EventDataStore
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 cfnEventDataStore = new CfnEventDataStore(this, "MyCfnEventDataStore", 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"
} },
BillingMode = "billingMode",
FederationEnabled = false,
FederationRoleArn = "federationRoleArn",
IngestionEnabled = false,
InsightsDestination = "insightsDestination",
InsightSelectors = new [] { new InsightSelectorProperty {
InsightType = "insightType"
} },
KmsKeyId = "kmsKeyId",
MultiRegionEnabled = false,
Name = "name",
OrganizationEnabled = false,
RetentionPeriod = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TerminationProtectionEnabled = false
});
Synopsis
Constructors
CfnEventDataStore(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEventDataStore(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnEventDataStore(Construct, String, ICfnEventDataStoreProps) |
Properties
AdvancedEventSelectors | The advanced event selectors to use to select the events for the data store. |
AttrCreatedTimestamp |
|
AttrEventDataStoreArn |
|
AttrStatus |
|
AttrUpdatedTimestamp |
|
BillingMode | 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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
FederationEnabled | Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled. |
FederationRoleArn | If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store. |
IngestionEnabled | Specifies whether the event data store should start ingesting live events. |
InsightsDestination | The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. |
InsightSelectors | A JSON string that contains the Insights types you want to log on an event data store. |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of tags. |
TerminationProtectionEnabled | Specifies whether termination protection is enabled for the event data store. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEventDataStore(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEventDataStore(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEventDataStore(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEventDataStore(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnEventDataStore(Construct, String, ICfnEventDataStoreProps)
public CfnEventDataStore(Construct scope, string id, ICfnEventDataStoreProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnEventDataStoreProps
Resource properties.
Properties
AdvancedEventSelectors
The advanced event selectors to use to select the events for the data store.
public virtual object AdvancedEventSelectors { get; set; }
Property Value
System.Object
AttrCreatedTimestamp
Ref
returns the time stamp of the creation of the event data store, such as 1248496624
.
public virtual string AttrCreatedTimestamp { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedTimestamp
AttrEventDataStoreArn
Ref
returns the ARN of the CloudTrail event data store, such as arn:aws:cloudtrail:us-east-1:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
.
public virtual string AttrEventDataStoreArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EventDataStoreArn
AttrStatus
Ref
returns the status of the event data store, such as ENABLED
.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
AttrUpdatedTimestamp
Ref
returns the time stamp that updates were made to an event data store, such as 1598296624
.
public virtual string AttrUpdatedTimestamp { get; }
Property Value
System.String
Remarks
CloudformationAttribute: UpdatedTimestamp
BillingMode
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.
public virtual string BillingMode { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
FederationEnabled
Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.
public virtual object FederationEnabled { get; set; }
Property Value
System.Object
FederationRoleArn
If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.
public virtual string FederationRoleArn { get; set; }
Property Value
System.String
IngestionEnabled
Specifies whether the event data store should start ingesting live events.
public virtual object IngestionEnabled { get; set; }
Property Value
System.Object
InsightsDestination
The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.
public virtual string InsightsDestination { get; set; }
Property Value
System.String
InsightSelectors
A JSON string that contains the Insights types you want to log on an event data store.
public virtual object InsightSelectors { get; set; }
Property Value
System.Object
KmsKeyId
Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
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.
public virtual object MultiRegionEnabled { get; set; }
Property Value
System.Object
Name
The name of the event data store.
public virtual string Name { get; set; }
Property Value
System.String
OrganizationEnabled
Specifies whether an event data store collects events logged for an organization in AWS Organizations .
public virtual object OrganizationEnabled { get; set; }
Property Value
System.Object
RetentionPeriod
The retention period of the event data store, in days.
public virtual Nullable<double> RetentionPeriod { get; set; }
Property Value
System.Nullable<System.Double>
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
TerminationProtectionEnabled
Specifies whether termination protection is enabled for the event data store.
public virtual object TerminationProtectionEnabled { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>