Class CfnEventDataStoreProps.Jsii$Proxy
- All Implemented Interfaces:
CfnEventDataStoreProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnEventDataStoreProps
CfnEventDataStoreProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudtrail.CfnEventDataStoreProps
CfnEventDataStoreProps.Builder, CfnEventDataStoreProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(CfnEventDataStoreProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnEventDataStoreProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Object
The advanced event selectors to use to select the events for the data store.final String
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.final Object
Indicates if Lake query federation is enabled.final String
If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.final Object
Specifies whether the event data store should start ingesting live events.final String
The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.final Object
A JSON string that contains the Insights types you want to log on an event data store.final String
Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.final Object
Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.final String
getName()
The name of the event data store.final Object
Specifies whether an event data store collects events logged for an organization in AWS Organizations .final Number
The retention period of the event data store, in days.getTags()
A list of tags.final Object
Specifies whether termination protection is enabled for the event data store.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnEventDataStoreProps.Builder
.
-
-
Method Details
-
getAdvancedEventSelectors
Description copied from interface:CfnEventDataStoreProps
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.
For more information about how to use advanced event selectors to include events outside of AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.
- Specified by:
getAdvancedEventSelectors
in interfaceCfnEventDataStoreProps
- See Also:
-
getBillingMode
Description copied from interface:CfnEventDataStoreProps
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.
The default value is
EXTENDABLE_RETENTION_PRICING
.For more information about CloudTrail pricing, see AWS CloudTrail Pricing and Managing CloudTrail Lake costs .
- Specified by:
getBillingMode
in interfaceCfnEventDataStoreProps
- See Also:
-
getFederationEnabled
Description copied from interface:CfnEventDataStoreProps
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.- Specified by:
getFederationEnabled
in interfaceCfnEventDataStoreProps
- See Also:
-
getFederationRoleArn
Description copied from interface:CfnEventDataStoreProps
If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.The federation role must exist in your account and provide the required minimum permissions .
- Specified by:
getFederationRoleArn
in interfaceCfnEventDataStoreProps
- See Also:
-
getIngestionEnabled
Description copied from interface:CfnEventDataStoreProps
Specifies whether the event data store should start ingesting live events.The default is true.
- Specified by:
getIngestionEnabled
in interfaceCfnEventDataStoreProps
- See Also:
-
getInsightsDestination
Description copied from interface:CfnEventDataStoreProps
The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.For more information, see Create an event data store for CloudTrail Insights events .
- Specified by:
getInsightsDestination
in interfaceCfnEventDataStoreProps
- See Also:
-
getInsightSelectors
Description copied from interface:CfnEventDataStoreProps
A JSON string that contains the Insights types you want to log on an event data store.ApiCallRateInsight
andApiErrorRateInsight
are valid Insight types.The
ApiCallRateInsight
Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.The
ApiErrorRateInsight
Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.- Specified by:
getInsightSelectors
in interfaceCfnEventDataStoreProps
- See Also:
-
getKmsKeyId
Description copied from interface:CfnEventDataStoreProps
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
- Specified by:
getKmsKeyId
in interfaceCfnEventDataStoreProps
- See Also:
-
getMultiRegionEnabled
Description copied from interface:CfnEventDataStoreProps
Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.- Specified by:
getMultiRegionEnabled
in interfaceCfnEventDataStoreProps
- See Also:
-
getName
Description copied from interface:CfnEventDataStoreProps
The name of the event data store.- Specified by:
getName
in interfaceCfnEventDataStoreProps
- See Also:
-
getOrganizationEnabled
Description copied from interface:CfnEventDataStoreProps
Specifies whether an event data store collects events logged for an organization in AWS Organizations .- Specified by:
getOrganizationEnabled
in interfaceCfnEventDataStoreProps
- See Also:
-
getRetentionPeriod
Description copied from interface:CfnEventDataStoreProps
The retention period of the event data store, in days.If
BillingMode
is set toEXTENDABLE_RETENTION_PRICING
, you can set a retention period of up to 3653 days, the equivalent of 10 years. IfBillingMode
is set toFIXED_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 theeventTime
is older than 90 days.If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.
- Specified by:
getRetentionPeriod
in interfaceCfnEventDataStoreProps
- See Also:
-
getTags
Description copied from interface:CfnEventDataStoreProps
A list of tags.- Specified by:
getTags
in interfaceCfnEventDataStoreProps
- See Also:
-
getTerminationProtectionEnabled
Description copied from interface:CfnEventDataStoreProps
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.
- Specified by:
getTerminationProtectionEnabled
in interfaceCfnEventDataStoreProps
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-