Package software.amazon.awscdk.services.cloudtrail

Class CfnEventDataStoreProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudtrail.CfnEventDataStoreProps.Jsii$Proxy

All Implemented Interfaces:

CfnEventDataStoreProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEventDataStoreProps

@Stability(Stable)
@Internal
public static final class CfnEventDataStoreProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnEventDataStoreProps

An implementation for 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

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnEventDataStoreProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnEventDataStoreProps.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 Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAdvancedEventSelectors()	The advanced event selectors to use to select the events for the data store.
final String	getBillingMode()	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	getContextKeySelectors()	The list of context key selectors that are configured for the event data store.
final Object	getFederationEnabled()	Indicates if Lake query federation is enabled.
final String	getFederationRoleArn()	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	getIngestionEnabled()	Specifies whether the event data store should start ingesting live events.
final String	getInsightsDestination()	The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.
final Object	getInsightSelectors()	A JSON string that contains the Insights types you want to log on an event data store.
final String	getKmsKeyId()	Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
final String	getMaxEventSize()	The maximum allowed size for events to be stored in the specified event data store.
final 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.
final String	getName()	The name of the event data store.
final Object	getOrganizationEnabled()	Specifies whether an event data store collects events logged for an organization in AWS Organizations .
final Number	getRetentionPeriod()	The retention period of the event data store, in days.
final List<CfnTag>	getTags()	A list of tags.
final Object	getTerminationProtectionEnabled()	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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

protected Jsii$Proxy(CfnEventDataStoreProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnEventDataStoreProps.Builder.

Method Details

getAdvancedEventSelectors

public final Object 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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEventDataStore.AdvancedEventSelectorProperty>

Specified by:

getAdvancedEventSelectors in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-advancedeventselectors

getBillingMode

public final String 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 interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-billingmode

getContextKeySelectors

public final Object getContextKeySelectors()

Description copied from interface: CfnEventDataStoreProps

The list of context key selectors that are configured for the event data store.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEventDataStore.ContextKeySelectorProperty>

Specified by:

getContextKeySelectors in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-contextkeyselectors

getFederationEnabled

public final Object 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.

Returns union: either Boolean or IResolvable

Specified by:

getFederationEnabled in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationenabled

getFederationRoleArn

public final String 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 interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationrolearn

getIngestionEnabled

public final Object getIngestionEnabled()

Description copied from interface: CfnEventDataStoreProps

Specifies whether the event data store should start ingesting live events.

The default is true.

Returns union: either Boolean or IResolvable

Specified by:

getIngestionEnabled in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-ingestionenabled

getInsightsDestination

public final String 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 interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightsdestination

getInsightSelectors

public final Object getInsightSelectors()

Description copied from interface: CfnEventDataStoreProps

A JSON string that contains the Insights types you want to log on an event data store.

ApiCallRateInsight and ApiErrorRateInsight 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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEventDataStore.InsightSelectorProperty>

Specified by:

getInsightSelectors in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightselectors

getKmsKeyId

public final String 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 interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-kmskeyid

getMaxEventSize

public final String getMaxEventSize()

Description copied from interface: CfnEventDataStoreProps

The maximum allowed size for events to be stored in the specified event data store.

If you are using context key selectors, MaxEventSize must be set to Large.

Specified by:

getMaxEventSize in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-maxeventsize

getMultiRegionEnabled

public final Object 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.

Returns union: either Boolean or IResolvable

Specified by:

getMultiRegionEnabled in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-multiregionenabled

getName

public final String getName()

Description copied from interface: CfnEventDataStoreProps

The name of the event data store.

Specified by:

getName in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-name

getOrganizationEnabled

public final Object getOrganizationEnabled()

Description copied from interface: CfnEventDataStoreProps

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

Returns union: either Boolean or IResolvable

Specified by:

getOrganizationEnabled in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-organizationenabled

getRetentionPeriod

public final Number getRetentionPeriod()

Description copied from interface: CfnEventDataStoreProps

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

If BillingMode is set to EXTENDABLE_RETENTION_PRICING , you can set a retention period of up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_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 the eventTime 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 interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-retentionperiod

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnEventDataStoreProps

A list of tags.

Specified by:

getTags in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-tags

getTerminationProtectionEnabled

public final Object 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.

Returns union: either Boolean or IResolvable

Specified by:

getTerminationProtectionEnabled in interface CfnEventDataStoreProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-terminationprotectionenabled

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object