com.amazonaws.services.cloudtrail.model

Class CreateEventDataStoreRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudtrail.model.CreateEventDataStoreRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateEventDataStoreRequest
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
CreateEventDataStoreRequest()

Method Summary

Modifier and Type	Method and Description
CreateEventDataStoreRequest	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 to use to select the events for the data store.
String	getKmsKeyId() Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail.
Boolean	getMultiRegionEnabled() Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
String	getName() The name of the event data store.
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.
List<Tag>	getTagsList()
Boolean	getTerminationProtectionEnabled() Specifies whether termination protection is enabled for the event data store.
int	hashCode()
Boolean	isMultiRegionEnabled() Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
Boolean	isOrganizationEnabled() Specifies whether an event data store collects events logged for an organization in Organizations.
Boolean	isTerminationProtectionEnabled() Specifies whether termination protection is enabled for the event data store.
void	setAdvancedEventSelectors(Collection<AdvancedEventSelector> advancedEventSelectors) The advanced event selectors to use to select the events for the data store.
void	setKmsKeyId(String kmsKeyId) Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail.
void	setMultiRegionEnabled(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.
void	setName(String name) The name of the event data store.
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	setTagsList(Collection<Tag> tagsList)
void	setTerminationProtectionEnabled(Boolean terminationProtectionEnabled) Specifies whether termination protection is enabled for the event data store.
String	toString() Returns a string representation of this object.
CreateEventDataStoreRequest	withAdvancedEventSelectors(AdvancedEventSelector... advancedEventSelectors) The advanced event selectors to use to select the events for the data store.
CreateEventDataStoreRequest	withAdvancedEventSelectors(Collection<AdvancedEventSelector> advancedEventSelectors) The advanced event selectors to use to select the events for the data store.
CreateEventDataStoreRequest	withKmsKeyId(String kmsKeyId) Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail.
CreateEventDataStoreRequest	withMultiRegionEnabled(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.
CreateEventDataStoreRequest	withName(String name) The name of the event data store.
CreateEventDataStoreRequest	withOrganizationEnabled(Boolean organizationEnabled) Specifies whether an event data store collects events logged for an organization in Organizations.
CreateEventDataStoreRequest	withRetentionPeriod(Integer retentionPeriod) The retention period of the event data store, in days.
CreateEventDataStoreRequest	withTagsList(Collection<Tag> tagsList)
CreateEventDataStoreRequest	withTagsList(Tag... tagsList) NOTE: This method appends the values to the existing list (if any).
CreateEventDataStoreRequest	withTerminationProtectionEnabled(Boolean terminationProtectionEnabled) Specifies whether termination protection is enabled for the event data store.

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

CreateEventDataStoreRequest

public CreateEventDataStoreRequest()

Method Detail

setName

public void setName(String name)

The name of the event data store.

Parameters:

name - The name of the event data store.

getName

public String getName()

The name of the event data store.

Returns:

The name of the event data store.

withName

public CreateEventDataStoreRequest withName(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.

getAdvancedEventSelectors

public List<AdvancedEventSelector> getAdvancedEventSelectors()

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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

Returns:

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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

setAdvancedEventSelectors

public void setAdvancedEventSelectors(Collection<AdvancedEventSelector> 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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

withAdvancedEventSelectors

public CreateEventDataStoreRequest withAdvancedEventSelectors(AdvancedEventSelector... 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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

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 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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

Returns:

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

withAdvancedEventSelectors

public CreateEventDataStoreRequest withAdvancedEventSelectors(Collection<AdvancedEventSelector> 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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

Returns:

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

setMultiRegionEnabled

public void setMultiRegionEnabled(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.

getMultiRegionEnabled

public Boolean getMultiRegionEnabled()

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:

Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.

withMultiRegionEnabled

public CreateEventDataStoreRequest withMultiRegionEnabled(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.

isMultiRegionEnabled

public Boolean isMultiRegionEnabled()

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:

Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.

setOrganizationEnabled

public void setOrganizationEnabled(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.

getOrganizationEnabled

public Boolean getOrganizationEnabled()

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

Returns:

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

withOrganizationEnabled

public CreateEventDataStoreRequest withOrganizationEnabled(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.

isOrganizationEnabled

public Boolean isOrganizationEnabled()

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

Returns:

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

setRetentionPeriod

public void setRetentionPeriod(Integer 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.

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.

getRetentionPeriod

public Integer getRetentionPeriod()

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:

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.

withRetentionPeriod

public CreateEventDataStoreRequest withRetentionPeriod(Integer 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.

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:

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

setTerminationProtectionEnabled

public void setTerminationProtectionEnabled(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.

getTerminationProtectionEnabled

public Boolean getTerminationProtectionEnabled()

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:

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.

withTerminationProtectionEnabled

public CreateEventDataStoreRequest withTerminationProtectionEnabled(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.

isTerminationProtectionEnabled

public Boolean isTerminationProtectionEnabled()

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:

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.

getTagsList

public List<Tag> getTagsList()

Returns:

setTagsList

public void setTagsList(Collection<Tag> tagsList)

Parameters:

tagsList -

withTagsList

public CreateEventDataStoreRequest withTagsList(Tag... tagsList)

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

Parameters:

tagsList -

Returns:

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

withTagsList

public CreateEventDataStoreRequest withTagsList(Collection<Tag> tagsList)

Parameters:

tagsList -

Returns:

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

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

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 CreateEventDataStoreRequest 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()