Package software.amazon.awscdk.services.cloudtrail

Class CfnEventDataStoreProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudtrail.CfnEventDataStoreProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventDataStoreProps>

Enclosing interface:

CfnEventDataStoreProps

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

A builder for CfnEventDataStoreProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEventDataStoreProps.Builder	advancedEventSelectors(List<? extends Object> advancedEventSelectors)	Sets the value of CfnEventDataStoreProps.getAdvancedEventSelectors()
CfnEventDataStoreProps.Builder	advancedEventSelectors(IResolvable advancedEventSelectors)	Sets the value of CfnEventDataStoreProps.getAdvancedEventSelectors()
CfnEventDataStoreProps	build()	Builds the configured instance.
CfnEventDataStoreProps.Builder	ingestionEnabled(Boolean ingestionEnabled)	Sets the value of CfnEventDataStoreProps.getIngestionEnabled()
CfnEventDataStoreProps.Builder	ingestionEnabled(IResolvable ingestionEnabled)	Sets the value of CfnEventDataStoreProps.getIngestionEnabled()
CfnEventDataStoreProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnEventDataStoreProps.getKmsKeyId()
CfnEventDataStoreProps.Builder	multiRegionEnabled(Boolean multiRegionEnabled)	Sets the value of CfnEventDataStoreProps.getMultiRegionEnabled()
CfnEventDataStoreProps.Builder	multiRegionEnabled(IResolvable multiRegionEnabled)	Sets the value of CfnEventDataStoreProps.getMultiRegionEnabled()
CfnEventDataStoreProps.Builder	name(String name)	Sets the value of CfnEventDataStoreProps.getName()
CfnEventDataStoreProps.Builder	organizationEnabled(Boolean organizationEnabled)	Sets the value of CfnEventDataStoreProps.getOrganizationEnabled()
CfnEventDataStoreProps.Builder	organizationEnabled(IResolvable organizationEnabled)	Sets the value of CfnEventDataStoreProps.getOrganizationEnabled()
CfnEventDataStoreProps.Builder	retentionPeriod(Number retentionPeriod)	Sets the value of CfnEventDataStoreProps.getRetentionPeriod()
CfnEventDataStoreProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnEventDataStoreProps.getTags()
CfnEventDataStoreProps.Builder	terminationProtectionEnabled(Boolean terminationProtectionEnabled)	Sets the value of CfnEventDataStoreProps.getTerminationProtectionEnabled()
CfnEventDataStoreProps.Builder	terminationProtectionEnabled(IResolvable terminationProtectionEnabled)	Sets the value of CfnEventDataStoreProps.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 CfnEventDataStoreProps.Builder advancedEventSelectors(IResolvable advancedEventSelectors)

Sets the value of CfnEventDataStoreProps.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 non- 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 CfnEventDataStoreProps.Builder advancedEventSelectors(List<? extends Object> advancedEventSelectors)

Sets the value of CfnEventDataStoreProps.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 non- AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.

Returns:

this

ingestionEnabled

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

Sets the value of CfnEventDataStoreProps.getIngestionEnabled()

Parameters:

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

Returns:

this

ingestionEnabled

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

Sets the value of CfnEventDataStoreProps.getIngestionEnabled()

Parameters:

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

Returns:

this

kmsKeyId

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

Sets the value of CfnEventDataStoreProps.getKmsKeyId()

Parameters:

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

Returns:

this

multiRegionEnabled

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

Sets the value of CfnEventDataStoreProps.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 CfnEventDataStoreProps.Builder multiRegionEnabled(IResolvable multiRegionEnabled)

Sets the value of CfnEventDataStoreProps.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 CfnEventDataStoreProps.Builder name(String name)

Sets the value of CfnEventDataStoreProps.getName()

Parameters:

name - The name of the event data store.

Returns:

this

organizationEnabled

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

Sets the value of CfnEventDataStoreProps.getOrganizationEnabled()

Parameters:

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

Returns:

this

organizationEnabled

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

Sets the value of CfnEventDataStoreProps.getOrganizationEnabled()

Parameters:

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

Returns:

this

retentionPeriod

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

Sets the value of CfnEventDataStoreProps.getRetentionPeriod()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnEventDataStoreProps.getTags()

Parameters:

tags - A list of tags.

Returns:

this

terminationProtectionEnabled

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

Sets the value of CfnEventDataStoreProps.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 CfnEventDataStoreProps.Builder terminationProtectionEnabled(IResolvable terminationProtectionEnabled)

Sets the value of CfnEventDataStoreProps.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 CfnEventDataStoreProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnEventDataStoreProps

Throws:

NullPointerException - if any required attribute was not provided