Package software.amazon.awscdk.services.cloudtrail

Class CfnEventDataStore.Builder

java.lang.Object

software.amazon.awscdk.services.cloudtrail.CfnEventDataStore.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventDataStore>

Enclosing class:

CfnEventDataStore

@Stability(Stable)
public static final class CfnEventDataStore.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEventDataStore>

A fluent builder for CfnEventDataStore.

Method Summary

Modifier and Type	Method	Description
CfnEventDataStore.Builder	advancedEventSelectors(List<? extends Object> advancedEventSelectors)	The advanced event selectors to use to select the events for the data store.
CfnEventDataStore.Builder	advancedEventSelectors(IResolvable advancedEventSelectors)	The advanced event selectors to use to select the events for the data store.
CfnEventDataStore.Builder	billingMode(String 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.
CfnEventDataStore	build()
static CfnEventDataStore.Builder	create(software.constructs.Construct scope, String id)
CfnEventDataStore.Builder	federationEnabled(Boolean federationEnabled)	Indicates if Lake query federation is enabled.
CfnEventDataStore.Builder	federationEnabled(IResolvable federationEnabled)	Indicates if Lake query federation is enabled.
CfnEventDataStore.Builder	federationRoleArn(String 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.
CfnEventDataStore.Builder	ingestionEnabled(Boolean ingestionEnabled)	Specifies whether the event data store should start ingesting live events.
CfnEventDataStore.Builder	ingestionEnabled(IResolvable ingestionEnabled)	Specifies whether the event data store should start ingesting live events.
CfnEventDataStore.Builder	insightsDestination(String insightsDestination)	The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.
CfnEventDataStore.Builder	insightSelectors(List<? extends Object> insightSelectors)	A JSON string that contains the Insights types you want to log on an event data store.
CfnEventDataStore.Builder	insightSelectors(IResolvable insightSelectors)	A JSON string that contains the Insights types you want to log on an event data store.
CfnEventDataStore.Builder	kmsKeyId(String kmsKeyId)	Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
CfnEventDataStore.Builder	multiRegionEnabled(Boolean 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.
CfnEventDataStore.Builder	multiRegionEnabled(IResolvable 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.
CfnEventDataStore.Builder	name(String name)	The name of the event data store.
CfnEventDataStore.Builder	organizationEnabled(Boolean organizationEnabled)	Specifies whether an event data store collects events logged for an organization in AWS Organizations .
CfnEventDataStore.Builder	organizationEnabled(IResolvable organizationEnabled)	Specifies whether an event data store collects events logged for an organization in AWS Organizations .
CfnEventDataStore.Builder	retentionPeriod(Number retentionPeriod)	The retention period of the event data store, in days.
CfnEventDataStore.Builder	tags(List<? extends CfnTag> tags)	A list of tags.
CfnEventDataStore.Builder	terminationProtectionEnabled(Boolean terminationProtectionEnabled)	Specifies whether termination protection is enabled for the event data store.
CfnEventDataStore.Builder	terminationProtectionEnabled(IResolvable terminationProtectionEnabled)	Specifies whether termination protection is enabled for the event data store.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnEventDataStore.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnEventDataStore.Builder.

advancedEventSelectors

@Stability(Stable)
public CfnEventDataStore.Builder advancedEventSelectors(IResolvable advancedEventSelectors)

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.

Parameters:

advancedEventSelectors - The advanced event selectors to use to select the events for the data store. This parameter is required.

Returns:

this

See Also:

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

advancedEventSelectors

@Stability(Stable)
public CfnEventDataStore.Builder advancedEventSelectors(List<? extends Object> advancedEventSelectors)

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.

Parameters:

advancedEventSelectors - The advanced event selectors to use to select the events for the data store. This parameter is required.

Returns:

this

See Also:

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

billingMode

@Stability(Stable)
public CfnEventDataStore.Builder billingMode(String 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.

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 .

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

federationEnabled

@Stability(Stable)
public CfnEventDataStore.Builder federationEnabled(Boolean 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

federationEnabled

@Stability(Stable)
public CfnEventDataStore.Builder federationEnabled(IResolvable 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

federationRoleArn

@Stability(Stable)
public CfnEventDataStore.Builder federationRoleArn(String 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.

The federation role must exist in your account and provide the required minimum permissions .

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

ingestionEnabled

@Stability(Stable)
public CfnEventDataStore.Builder ingestionEnabled(Boolean ingestionEnabled)

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

The default is true.

Parameters:

ingestionEnabled - Specifies whether the event data store should start ingesting live events. This parameter is required.

Returns:

this

See Also:

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

ingestionEnabled

@Stability(Stable)
public CfnEventDataStore.Builder ingestionEnabled(IResolvable ingestionEnabled)

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

The default is true.

Parameters:

ingestionEnabled - Specifies whether the event data store should start ingesting live events. This parameter is required.

Returns:

this

See Also:

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

insightsDestination

@Stability(Stable)
public CfnEventDataStore.Builder insightsDestination(String insightsDestination)

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 .

Parameters:

insightsDestination - The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. This parameter is required.

Returns:

this

See Also:

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

insightSelectors

@Stability(Stable)
public CfnEventDataStore.Builder insightSelectors(IResolvable insightSelectors)

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.

Parameters:

insightSelectors - A JSON string that contains the Insights types you want to log on an event data store. This parameter is required.

Returns:

this

See Also:

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

insightSelectors

@Stability(Stable)
public CfnEventDataStore.Builder insightSelectors(List<? extends Object> insightSelectors)

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.

Parameters:

insightSelectors - A JSON string that contains the Insights types you want to log on an event data store. This parameter is required.

Returns:

this

See Also:

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

kmsKeyId

@Stability(Stable)
public CfnEventDataStore.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

kmsKeyId - Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail. This parameter is required.

Returns:

this

See Also:

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

multiRegionEnabled

@Stability(Stable)
public CfnEventDataStore.Builder multiRegionEnabled(Boolean 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

multiRegionEnabled

@Stability(Stable)
public CfnEventDataStore.Builder multiRegionEnabled(IResolvable 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnEventDataStore.Builder name(String name)

The name of the event data store.

Parameters:

name - The name of the event data store. This parameter is required.

Returns:

this

See Also:

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

organizationEnabled

@Stability(Stable)
public CfnEventDataStore.Builder organizationEnabled(Boolean organizationEnabled)

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

Parameters:

organizationEnabled - Specifies whether an event data store collects events logged for an organization in AWS Organizations . This parameter is required.

Returns:

this

See Also:

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

organizationEnabled

@Stability(Stable)
public CfnEventDataStore.Builder organizationEnabled(IResolvable organizationEnabled)

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

Parameters:

organizationEnabled - Specifies whether an event data store collects events logged for an organization in AWS Organizations . This parameter is required.

Returns:

this

See Also:

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

retentionPeriod

@Stability(Stable)
public CfnEventDataStore.Builder retentionPeriod(Number retentionPeriod)

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.

Parameters:

retentionPeriod - The retention period of the event data store, in days. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnEventDataStore.Builder tags(List<? extends CfnTag> tags)

A list of tags.

Parameters:

tags - A list of tags. This parameter is required.

Returns:

this

See Also:

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

terminationProtectionEnabled

@Stability(Stable)
public CfnEventDataStore.Builder terminationProtectionEnabled(Boolean terminationProtectionEnabled)

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.

Parameters:

terminationProtectionEnabled - Specifies whether termination protection is enabled for the event data store. This parameter is required.

Returns:

this

See Also:

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

terminationProtectionEnabled

@Stability(Stable)
public CfnEventDataStore.Builder terminationProtectionEnabled(IResolvable terminationProtectionEnabled)

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.

Parameters:

terminationProtectionEnabled - Specifies whether termination protection is enabled for the event data store. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnEventDataStore build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEventDataStore>

Returns:

a newly built instance of CfnEventDataStore.