Package software.amazon.awssdk.services.cloudtrail.model

Interface CreateEventDataStoreRequest.Builder

    • Method Detail

      • name

        CreateEventDataStoreRequest.Builder name​(String name)

        The name of the event data store.

        Parameters:
        name - The name of the event data store.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • multiRegionEnabled

        CreateEventDataStoreRequest.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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • organizationEnabled

        CreateEventDataStoreRequest.Builder organizationEnabled​(Boolean organizationEnabled)

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

        Parameters:
        organizationEnabled - Specifies whether an event data store collects events logged for an organization in Organizations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retentionPeriod

        CreateEventDataStoreRequest.Builder retentionPeriod​(Integer 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. 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:
        Returns a reference to this object so that method calls can be chained together.

      • terminationProtectionEnabled

        CreateEventDataStoreRequest.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. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagsList

        CreateEventDataStoreRequest.Builder tagsList​(Collection<Tag> tagsList)
        Sets the value of the TagsList property for this object.
        Parameters:
        tagsList - The new value for the TagsList property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagsList

        CreateEventDataStoreRequest.Builder tagsList​(Tag... tagsList)
        Sets the value of the TagsList property for this object.
        Parameters:
        tagsList - The new value for the TagsList property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagsList

        CreateEventDataStoreRequest.Builder tagsList​(Consumer<Tag.Builder>... tagsList)
        Sets the value of the TagsList property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tagsList(List).

        Parameters:
        tagsList - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tagsList(java.util.Collection)

      • kmsKeyId

        CreateEventDataStoreRequest.Builder kmsKeyId​(String kmsKeyId)

        Specifies the 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 KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the 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 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 KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the 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:
        Returns a reference to this object so that method calls can be chained together.

      • startIngestion

        CreateEventDataStoreRequest.Builder startIngestion​(Boolean startIngestion)

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

        Parameters:
        startIngestion - Specifies whether the event data store should start ingesting live events. The default is true.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • billingMode

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

        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 CloudTrail Pricing and Managing CloudTrail Lake costs.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BillingMode, BillingMode

      • billingMode

        CreateEventDataStoreRequest.Builder billingMode​(BillingMode 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 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.

        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 CloudTrail Pricing and Managing CloudTrail Lake costs.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BillingMode, BillingMode