Package software.amazon.awscdk.cfnpropertymixins.services.cloudtrail

Class CfnEventDataStoreMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cloudtrail.CfnEventDataStoreMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventDataStoreMixinProps>

Enclosing interface:

CfnEventDataStoreMixinProps

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

A builder for CfnEventDataStoreMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEventDataStoreMixinProps.Builder	advancedEventSelectors(List<? extends Object> advancedEventSelectors)	Sets the value of CfnEventDataStoreMixinProps.getAdvancedEventSelectors()
CfnEventDataStoreMixinProps.Builder	advancedEventSelectors(IResolvable advancedEventSelectors)	Sets the value of CfnEventDataStoreMixinProps.getAdvancedEventSelectors()
CfnEventDataStoreMixinProps.Builder	billingMode(String billingMode)	Sets the value of CfnEventDataStoreMixinProps.getBillingMode()
CfnEventDataStoreMixinProps	build()	Builds the configured instance.
CfnEventDataStoreMixinProps.Builder	contextKeySelectors(List<? extends Object> contextKeySelectors)	Sets the value of CfnEventDataStoreMixinProps.getContextKeySelectors()
CfnEventDataStoreMixinProps.Builder	contextKeySelectors(IResolvable contextKeySelectors)	Sets the value of CfnEventDataStoreMixinProps.getContextKeySelectors()
CfnEventDataStoreMixinProps.Builder	federationEnabled(Boolean federationEnabled)	Sets the value of CfnEventDataStoreMixinProps.getFederationEnabled()
CfnEventDataStoreMixinProps.Builder	federationEnabled(IResolvable federationEnabled)	Sets the value of CfnEventDataStoreMixinProps.getFederationEnabled()
CfnEventDataStoreMixinProps.Builder	federationRoleArn(String federationRoleArn)	Sets the value of CfnEventDataStoreMixinProps.getFederationRoleArn()
CfnEventDataStoreMixinProps.Builder	ingestionEnabled(Boolean ingestionEnabled)	Sets the value of CfnEventDataStoreMixinProps.getIngestionEnabled()
CfnEventDataStoreMixinProps.Builder	ingestionEnabled(IResolvable ingestionEnabled)	Sets the value of CfnEventDataStoreMixinProps.getIngestionEnabled()
CfnEventDataStoreMixinProps.Builder	insightsDestination(String insightsDestination)	Sets the value of CfnEventDataStoreMixinProps.getInsightsDestination()
CfnEventDataStoreMixinProps.Builder	insightSelectors(List<? extends Object> insightSelectors)	Sets the value of CfnEventDataStoreMixinProps.getInsightSelectors()
CfnEventDataStoreMixinProps.Builder	insightSelectors(IResolvable insightSelectors)	Sets the value of CfnEventDataStoreMixinProps.getInsightSelectors()
CfnEventDataStoreMixinProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnEventDataStoreMixinProps.getKmsKeyId()
CfnEventDataStoreMixinProps.Builder	maxEventSize(String maxEventSize)	Sets the value of CfnEventDataStoreMixinProps.getMaxEventSize()
CfnEventDataStoreMixinProps.Builder	multiRegionEnabled(Boolean multiRegionEnabled)	Sets the value of CfnEventDataStoreMixinProps.getMultiRegionEnabled()
CfnEventDataStoreMixinProps.Builder	multiRegionEnabled(IResolvable multiRegionEnabled)	Sets the value of CfnEventDataStoreMixinProps.getMultiRegionEnabled()
CfnEventDataStoreMixinProps.Builder	name(String name)	Sets the value of CfnEventDataStoreMixinProps.getName()
CfnEventDataStoreMixinProps.Builder	organizationEnabled(Boolean organizationEnabled)	Sets the value of CfnEventDataStoreMixinProps.getOrganizationEnabled()
CfnEventDataStoreMixinProps.Builder	organizationEnabled(IResolvable organizationEnabled)	Sets the value of CfnEventDataStoreMixinProps.getOrganizationEnabled()
CfnEventDataStoreMixinProps.Builder	retentionPeriod(Number retentionPeriod)	Sets the value of CfnEventDataStoreMixinProps.getRetentionPeriod()
CfnEventDataStoreMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnEventDataStoreMixinProps.getTags()
CfnEventDataStoreMixinProps.Builder	terminationProtectionEnabled(Boolean terminationProtectionEnabled)	Sets the value of CfnEventDataStoreMixinProps.getTerminationProtectionEnabled()
CfnEventDataStoreMixinProps.Builder	terminationProtectionEnabled(IResolvable terminationProtectionEnabled)	Sets the value of CfnEventDataStoreMixinProps.getTerminationProtectionEnabled()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

advancedEventSelectors

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

Sets the value of CfnEventDataStoreMixinProps.getAdvancedEventSelectors()

Parameters:

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.

Returns:

this

advancedEventSelectors

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

Sets the value of CfnEventDataStoreMixinProps.getAdvancedEventSelectors()

Parameters:

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.

Returns:

this

billingMode

@Stability(Stable)
public CfnEventDataStoreMixinProps.Builder billingMode(String billingMode)

Sets the value of CfnEventDataStoreMixinProps.getBillingMode()

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

Returns:

this

contextKeySelectors

@Stability(Stable)
public CfnEventDataStoreMixinProps.Builder contextKeySelectors(IResolvable contextKeySelectors)

Sets the value of CfnEventDataStoreMixinProps.getContextKeySelectors()

Parameters:

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

Returns:

this

contextKeySelectors

@Stability(Stable)
public CfnEventDataStoreMixinProps.Builder contextKeySelectors(List<? extends Object> contextKeySelectors)

Sets the value of CfnEventDataStoreMixinProps.getContextKeySelectors()

Parameters:

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

Returns:

this

federationEnabled

@Stability(Stable)
public CfnEventDataStoreMixinProps.Builder federationEnabled(Boolean federationEnabled)

Sets the value of CfnEventDataStoreMixinProps.getFederationEnabled()

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.

Returns:

this

federationEnabled

@Stability(Stable)
public CfnEventDataStoreMixinProps.Builder federationEnabled(IResolvable federationEnabled)

Sets the value of CfnEventDataStoreMixinProps.getFederationEnabled()

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.

Returns:

this

federationRoleArn

@Stability(Stable)
public CfnEventDataStoreMixinProps.Builder federationRoleArn(String federationRoleArn)

Sets the value of CfnEventDataStoreMixinProps.getFederationRoleArn()

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. The federation role must exist in your account and provide the required minimum permissions .

Returns:

this

ingestionEnabled

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

Sets the value of CfnEventDataStoreMixinProps.getIngestionEnabled()

Parameters:

ingestionEnabled - Specifies whether the event data store should start ingesting live events. The default is true.

Returns:

this

ingestionEnabled

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

Sets the value of CfnEventDataStoreMixinProps.getIngestionEnabled()

Parameters:

ingestionEnabled - Specifies whether the event data store should start ingesting live events. The default is true.

Returns:

this

insightsDestination

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

Sets the value of CfnEventDataStoreMixinProps.getInsightsDestination()

Parameters:

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 .

Returns:

this

insightSelectors

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

Sets the value of CfnEventDataStoreMixinProps.getInsightSelectors()

Parameters:

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.

Returns:

this

insightSelectors

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

Sets the value of CfnEventDataStoreMixinProps.getInsightSelectors()

Parameters:

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.

Returns:

this

kmsKeyId

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

Sets the value of CfnEventDataStoreMixinProps.getKmsKeyId()

Parameters:

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

Returns:

this

maxEventSize

@Stability(Stable)
public CfnEventDataStoreMixinProps.Builder maxEventSize(String maxEventSize)

Sets the value of CfnEventDataStoreMixinProps.getMaxEventSize()

Parameters:

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

Returns:

this

multiRegionEnabled

@Stability(Stable)
public CfnEventDataStoreMixinProps.Builder multiRegionEnabled(Boolean multiRegionEnabled)

Sets the value of CfnEventDataStoreMixinProps.getMultiRegionEnabled()

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.

Returns:

this

multiRegionEnabled

@Stability(Stable)
public CfnEventDataStoreMixinProps.Builder multiRegionEnabled(IResolvable multiRegionEnabled)

Sets the value of CfnEventDataStoreMixinProps.getMultiRegionEnabled()

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.

Returns:

this

name

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

Sets the value of CfnEventDataStoreMixinProps.getName()

Parameters:

name - The name of the event data store.

Returns:

this

organizationEnabled

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

Sets the value of CfnEventDataStoreMixinProps.getOrganizationEnabled()

Parameters:

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

Returns:

this

organizationEnabled

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

Sets the value of CfnEventDataStoreMixinProps.getOrganizationEnabled()

Parameters:

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

Returns:

this

retentionPeriod

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

Sets the value of CfnEventDataStoreMixinProps.getRetentionPeriod()

Parameters:

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.

Returns:

this

tags

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

Sets the value of CfnEventDataStoreMixinProps.getTags()

Parameters:

tags - A list of tags.

Returns:

this

terminationProtectionEnabled

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

Sets the value of CfnEventDataStoreMixinProps.getTerminationProtectionEnabled()

Parameters:

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.

Returns:

this

terminationProtectionEnabled

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

Sets the value of CfnEventDataStoreMixinProps.getTerminationProtectionEnabled()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnEventDataStoreMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnEventDataStoreMixinProps

Throws:

NullPointerException - if any required attribute was not provided