software.amazon.awscdk.services.cloudtrail

Class CfnEventDataStore

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cloudtrail.CfnEventDataStore

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:42.141Z")
 @Stability(value=Stable)
public class CfnEventDataStore
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudTrail::EventDataStore`.

Creates a new event data store.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudtrail.*;
 CfnEventDataStore cfnEventDataStore = CfnEventDataStore.Builder.create(this, "MyCfnEventDataStore")
         .advancedEventSelectors(List.of(AdvancedEventSelectorProperty.builder()
                 .fieldSelectors(List.of(AdvancedFieldSelectorProperty.builder()
                         .field("field")
                         // the properties below are optional
                         .endsWith(List.of("endsWith"))
                         .equalTo(List.of("equalTo"))
                         .notEndsWith(List.of("notEndsWith"))
                         .notEquals(List.of("notEquals"))
                         .notStartsWith(List.of("notStartsWith"))
                         .startsWith(List.of("startsWith"))
                         .build()))
                 // the properties below are optional
                 .name("name")
                 .build()))
         .kmsKeyId("kmsKeyId")
         .multiRegionEnabled(false)
         .name("name")
         .organizationEnabled(false)
         .retentionPeriod(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .terminationProtectionEnabled(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnEventDataStore.AdvancedEventSelectorProperty Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record fields.
static interface	CfnEventDataStore.AdvancedFieldSelectorProperty A single selector statement in an advanced event selector.
static class	CfnEventDataStore.Builder A fluent builder for CfnEventDataStore.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEventDataStore(Construct scope, String id) Create a new `AWS::CloudTrail::EventDataStore`.
	CfnEventDataStore(Construct scope, String id, CfnEventDataStoreProps props) Create a new `AWS::CloudTrail::EventDataStore`.
protected	CfnEventDataStore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEventDataStore(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAdvancedEventSelectors() The advanced event selectors to use to select the events for the data store.
String	getAttrCreatedTimestamp() `Ref` returns the time stamp of the creation of the event data store, such as `1248496624` .
String	getAttrEventDataStoreArn() `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` .
String	getAttrStatus() `Ref` returns the status of the event data store, such as `ENABLED` .
String	getAttrUpdatedTimestamp() `Ref` returns the time stamp that updates were made to an event data store, such as `1598296624` .
protected Map<String,Object>	getCfnProperties()
String	getKmsKeyId() Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
Object	getMultiRegionEnabled() Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
String	getName() The name of the event data store.
Object	getOrganizationEnabled() Specifies whether an event data store collects events logged for an organization in AWS Organizations .
Number	getRetentionPeriod() The retention period of the event data store, in days.
TagManager	getTags() A list of tags.
Object	getTerminationProtectionEnabled() Specifies whether termination protection is enabled for the event data store.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdvancedEventSelectors(IResolvable value) The advanced event selectors to use to select the events for the data store.
void	setAdvancedEventSelectors(List<Object> value) The advanced event selectors to use to select the events for the data store.
void	setKmsKeyId(String value) Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
void	setMultiRegionEnabled(Boolean value) Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
void	setMultiRegionEnabled(IResolvable value) Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
void	setName(String value) The name of the event data store.
void	setOrganizationEnabled(Boolean value) Specifies whether an event data store collects events logged for an organization in AWS Organizations .
void	setOrganizationEnabled(IResolvable value) Specifies whether an event data store collects events logged for an organization in AWS Organizations .
void	setRetentionPeriod(Number value) The retention period of the event data store, in days.
void	setTerminationProtectionEnabled(Boolean value) Specifies whether termination protection is enabled for the event data store.
void	setTerminationProtectionEnabled(IResolvable value) Specifies whether termination protection is enabled for the event data store.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEventDataStore

protected CfnEventDataStore(software.amazon.jsii.JsiiObjectRef objRef)

CfnEventDataStore

protected CfnEventDataStore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEventDataStore

@Stability(value=Stable)
public CfnEventDataStore(@NotNull
                                                  Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @Nullable
                                                  CfnEventDataStoreProps props)

Create a new `AWS::CloudTrail::EventDataStore`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnEventDataStore

@Stability(value=Stable)
public CfnEventDataStore(@NotNull
                                                  Construct scope,
                                                  @NotNull
                                                  String id)

Create a new `AWS::CloudTrail::EventDataStore`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedTimestamp

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTimestamp()

`Ref` returns the time stamp of the creation of the event data store, such as `1248496624` .

getAttrEventDataStoreArn

@Stability(value=Stable)
 @NotNull
public String getAttrEventDataStoreArn()

`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` .

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

`Ref` returns the status of the event data store, such as `ENABLED` .

getAttrUpdatedTimestamp

@Stability(value=Stable)
 @NotNull
public String getAttrUpdatedTimestamp()

`Ref` returns the time stamp that updates were made to an event data store, such as `1598296624` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A list of tags.

getAdvancedEventSelectors

@Stability(value=Stable)
 @Nullable
public Object getAdvancedEventSelectors()

The advanced event selectors to use to select the events for the data store.

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.

setAdvancedEventSelectors

@Stability(value=Stable)
public void setAdvancedEventSelectors(@Nullable
                                                               IResolvable value)

The advanced event selectors to use to select the events for the data store.

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.

setAdvancedEventSelectors

@Stability(value=Stable)
public void setAdvancedEventSelectors(@Nullable
                                                               List<Object> value)

The advanced event selectors to use to select the events for the data store.

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.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()

Specifies the AWS 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 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:

• 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

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

Specifies the AWS 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 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:

• 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

getMultiRegionEnabled

@Stability(value=Stable)
 @Nullable
public Object getMultiRegionEnabled()

Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.

setMultiRegionEnabled

@Stability(value=Stable)
public void setMultiRegionEnabled(@Nullable
                                                           Boolean value)

Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.

setMultiRegionEnabled

@Stability(value=Stable)
public void setMultiRegionEnabled(@Nullable
                                                           IResolvable value)

Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the event data store.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the event data store.

getOrganizationEnabled

@Stability(value=Stable)
 @Nullable
public Object getOrganizationEnabled()

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

setOrganizationEnabled

@Stability(value=Stable)
public void setOrganizationEnabled(@Nullable
                                                            Boolean value)

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

setOrganizationEnabled

@Stability(value=Stable)
public void setOrganizationEnabled(@Nullable
                                                            IResolvable value)

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

getRetentionPeriod

@Stability(value=Stable)
 @Nullable
public Number getRetentionPeriod()

The retention period of the event data store, in days.

You can set a retention period of up to 2557 days, the equivalent of seven years.

setRetentionPeriod

@Stability(value=Stable)
public void setRetentionPeriod(@Nullable
                                                        Number value)

The retention period of the event data store, in days.

You can set a retention period of up to 2557 days, the equivalent of seven years.

getTerminationProtectionEnabled

@Stability(value=Stable)
 @Nullable
public Object getTerminationProtectionEnabled()

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.

setTerminationProtectionEnabled

@Stability(value=Stable)
public void setTerminationProtectionEnabled(@Nullable
                                                                     Boolean value)

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.

setTerminationProtectionEnabled

@Stability(value=Stable)
public void setTerminationProtectionEnabled(@Nullable
                                                                     IResolvable value)

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.