com.amazonaws.services.cloudtrail.model

Class UpdateEventDataStoreRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudtrail.model.UpdateEventDataStoreRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateEventDataStoreRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateEventDataStoreRequest()

Method Summary

Modifier and Type	Method and Description
UpdateEventDataStoreRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<AdvancedEventSelector>	getAdvancedEventSelectors() The advanced event selectors used to select events for the event data store.
String	getBillingMode()
String	getEventDataStore() The ARN (or the ID suffix of the ARN) of the event data store that you want to update.
String	getKmsKeyId() Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail.
Boolean	getMultiRegionEnabled() Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.
String	getName() The event data store name.
Boolean	getOrganizationEnabled() Specifies whether an event data store collects events logged for an organization in Organizations.
Integer	getRetentionPeriod() The retention period of the event data store, in days.
Boolean	getTerminationProtectionEnabled() Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
int	hashCode()
Boolean	isMultiRegionEnabled() Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.
Boolean	isOrganizationEnabled() Specifies whether an event data store collects events logged for an organization in Organizations.
Boolean	isTerminationProtectionEnabled() Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
void	setAdvancedEventSelectors(Collection<AdvancedEventSelector> advancedEventSelectors) The advanced event selectors used to select events for the event data store.
void	setBillingMode(String billingMode)
void	setEventDataStore(String eventDataStore) The ARN (or the ID suffix of the ARN) of the event data store that you want to update.
void	setKmsKeyId(String kmsKeyId) Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail.
void	setMultiRegionEnabled(Boolean multiRegionEnabled) Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.
void	setName(String name) The event data store name.
void	setOrganizationEnabled(Boolean organizationEnabled) Specifies whether an event data store collects events logged for an organization in Organizations.
void	setRetentionPeriod(Integer retentionPeriod) The retention period of the event data store, in days.
void	setTerminationProtectionEnabled(Boolean terminationProtectionEnabled) Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
String	toString() Returns a string representation of this object.
UpdateEventDataStoreRequest	withAdvancedEventSelectors(AdvancedEventSelector... advancedEventSelectors) The advanced event selectors used to select events for the event data store.
UpdateEventDataStoreRequest	withAdvancedEventSelectors(Collection<AdvancedEventSelector> advancedEventSelectors) The advanced event selectors used to select events for the event data store.
UpdateEventDataStoreRequest	withBillingMode(BillingMode billingMode)
UpdateEventDataStoreRequest	withBillingMode(String billingMode)
UpdateEventDataStoreRequest	withEventDataStore(String eventDataStore) The ARN (or the ID suffix of the ARN) of the event data store that you want to update.
UpdateEventDataStoreRequest	withKmsKeyId(String kmsKeyId) Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail.
UpdateEventDataStoreRequest	withMultiRegionEnabled(Boolean multiRegionEnabled) Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.
UpdateEventDataStoreRequest	withName(String name) The event data store name.
UpdateEventDataStoreRequest	withOrganizationEnabled(Boolean organizationEnabled) Specifies whether an event data store collects events logged for an organization in Organizations.
UpdateEventDataStoreRequest	withRetentionPeriod(Integer retentionPeriod) The retention period of the event data store, in days.
UpdateEventDataStoreRequest	withTerminationProtectionEnabled(Boolean terminationProtectionEnabled) Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateEventDataStoreRequest

public UpdateEventDataStoreRequest()

Method Detail

setEventDataStore

public void setEventDataStore(String eventDataStore)

The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Parameters:

eventDataStore - The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

getEventDataStore

public String getEventDataStore()

The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Returns:

The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

withEventDataStore

public UpdateEventDataStoreRequest withEventDataStore(String eventDataStore)

The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Parameters:

eventDataStore - The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The event data store name.

Parameters:

name - The event data store name.

getName

public String getName()

The event data store name.

Returns:

The event data store name.

withName

public UpdateEventDataStoreRequest withName(String name)

The event data store name.

Parameters:

name - The event data store name.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAdvancedEventSelectors

public List<AdvancedEventSelector> getAdvancedEventSelectors()

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

Returns:

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

setAdvancedEventSelectors

public void setAdvancedEventSelectors(Collection<AdvancedEventSelector> advancedEventSelectors)

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

Parameters:

advancedEventSelectors - The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

withAdvancedEventSelectors

public UpdateEventDataStoreRequest withAdvancedEventSelectors(AdvancedEventSelector... advancedEventSelectors)

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

NOTE: This method appends the values to the existing list (if any). Use setAdvancedEventSelectors(java.util.Collection) or withAdvancedEventSelectors(java.util.Collection) if you want to override the existing values.

Parameters:

advancedEventSelectors - The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAdvancedEventSelectors

public UpdateEventDataStoreRequest withAdvancedEventSelectors(Collection<AdvancedEventSelector> advancedEventSelectors)

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

Parameters:

advancedEventSelectors - The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMultiRegionEnabled

public void setMultiRegionEnabled(Boolean multiRegionEnabled)

Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

Parameters:

multiRegionEnabled - Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

getMultiRegionEnabled

public Boolean getMultiRegionEnabled()

Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

Returns:

Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

withMultiRegionEnabled

public UpdateEventDataStoreRequest withMultiRegionEnabled(Boolean multiRegionEnabled)

Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

Parameters:

multiRegionEnabled - Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

isMultiRegionEnabled

public Boolean isMultiRegionEnabled()

Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

Returns:

Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

setOrganizationEnabled

public void setOrganizationEnabled(Boolean organizationEnabled)

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

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

Parameters:

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

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

getOrganizationEnabled

public Boolean getOrganizationEnabled()

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

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

Returns:

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

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

withOrganizationEnabled

public UpdateEventDataStoreRequest withOrganizationEnabled(Boolean organizationEnabled)

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

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

Parameters:

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

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

Returns:

Returns a reference to this object so that method calls can be chained together.

isOrganizationEnabled

public Boolean isOrganizationEnabled()

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

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

Returns:

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

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

setRetentionPeriod

public void setRetentionPeriod(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 decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

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 decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

getRetentionPeriod

public Integer getRetentionPeriod()

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 decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

Returns:

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 decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

withRetentionPeriod

public UpdateEventDataStoreRequest withRetentionPeriod(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 decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

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 decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTerminationProtectionEnabled

public void setTerminationProtectionEnabled(Boolean terminationProtectionEnabled)

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

Parameters:

terminationProtectionEnabled - Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

getTerminationProtectionEnabled

public Boolean getTerminationProtectionEnabled()

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

Returns:

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

withTerminationProtectionEnabled

public UpdateEventDataStoreRequest withTerminationProtectionEnabled(Boolean terminationProtectionEnabled)

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

Parameters:

terminationProtectionEnabled - Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

Returns:

Returns a reference to this object so that method calls can be chained together.

isTerminationProtectionEnabled

public Boolean isTerminationProtectionEnabled()

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

Returns:

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

setKmsKeyId

public void setKmsKeyId(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

getKmsKeyId

public String getKmsKeyId()

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:

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

withKmsKeyId

public UpdateEventDataStoreRequest withKmsKeyId(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.

setBillingMode

public void setBillingMode(String billingMode)

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.

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.

For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.

Parameters:

billingMode -

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.

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.

For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.

See Also:

BillingMode

getBillingMode

public String getBillingMode()

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.

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.

For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.

Returns:

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.

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.

For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.

See Also:

BillingMode

withBillingMode

public UpdateEventDataStoreRequest withBillingMode(String billingMode)

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.

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.

For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.

Parameters:

billingMode -

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.

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.

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

withBillingMode

public UpdateEventDataStoreRequest withBillingMode(BillingMode billingMode)

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.

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.

For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.

Parameters:

billingMode -

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.

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.

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateEventDataStoreRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()