Class: Aws::CloudTrail::Types::GetEventDataStoreResponse

Inherits:

Struct

Object
Struct
Aws::CloudTrail::Types::GetEventDataStoreResponse

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cloudtrail/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#advanced_event_selectors ⇒ Array<Types::AdvancedEventSelector>

The advanced event selectors used to select events for the data store.
#billing_mode ⇒ String

The billing mode for the event data store.
#created_timestamp ⇒ Time

The timestamp of the event data store’s creation.
#event_data_store_arn ⇒ String

The event data store Amazon Resource Number (ARN).
#federation_role_arn ⇒ String

If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.
#federation_status ⇒ String

Indicates the [Lake query federation] status.
#kms_key_id ⇒ String

Specifies the KMS key ID that encrypts the events delivered by CloudTrail.
#multi_region_enabled ⇒ Boolean

Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.
#name ⇒ String

The name of the event data store.
#organization_enabled ⇒ Boolean

Indicates whether an event data store is collecting logged events for an organization in Organizations.
#partition_keys ⇒ Array<Types::PartitionKey>

The partition keys for the event data store.
#retention_period ⇒ Integer

The retention period of the event data store, in days.
#status ⇒ String

The status of an event data store.
#termination_protection_enabled ⇒ Boolean

Indicates that termination protection is enabled.
#updated_timestamp ⇒ Time

Shows the time that an event data store was updated, if applicable.

Instance Attribute Details

#advanced_event_selectors ⇒ `Array<Types::AdvancedEventSelector>`

The advanced event selectors used to select events for the data store.

Returns:

(Array<Types::AdvancedEventSelector>)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#billing_mode ⇒ `String`

The billing mode for the event data store.

Returns:

(String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#created_timestamp ⇒ `Time`

The timestamp of the event data store’s creation.

Returns:

(Time)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#event_data_store_arn ⇒ `String`

The event data store Amazon Resource Number (ARN).

Returns:

(String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#federation_role_arn ⇒ `String`

If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.

Returns:

(String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#federation_status ⇒ `String`

Indicates the [Lake query federation] status. The status is ‘ENABLED` if Lake query federation is enabled, or `DISABLED` if Lake query federation is disabled. You cannot delete an event data store if the `FederationStatus` is `ENABLED`.

[1]: docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html

Returns:

(String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.

‘arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012`

Returns:

(String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region_enabled ⇒ `Boolean`

Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.

Returns:

(Boolean)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the event data store.

Returns:

(String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#organization_enabled ⇒ `Boolean`

Indicates whether an event data store is collecting logged events for an organization in Organizations.

Returns:

(Boolean)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#partition_keys ⇒ `Array<Types::PartitionKey>`

The partition keys for the event data store. To improve query performance and efficiency, CloudTrail Lake organizes event data into partitions based on values derived from partition keys.

Returns:

(Array<Types::PartitionKey>)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period ⇒ `Integer`

The retention period of the event data store, in days.

Returns:

(Integer)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of an event data store.

Returns:

(String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#termination_protection_enabled ⇒ `Boolean`

Indicates that termination protection is enabled.

Returns:

(Boolean)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

#updated_timestamp ⇒ `Time`

Shows the time that an event data store was updated, if applicable. ‘UpdatedTimestamp` is always either the same or newer than the time shown in `CreatedTimestamp`.

Returns:

(Time)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 2124

class GetEventDataStoreResponse < Struct.new(
  :event_data_store_arn,
  :name,
  :status,
  :advanced_event_selectors,
  :multi_region_enabled,
  :organization_enabled,
  :retention_period,
  :termination_protection_enabled,
  :created_timestamp,
  :updated_timestamp,
  :kms_key_id,
  :billing_mode,
  :federation_status,
  :federation_role_arn,
  :partition_keys)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::CloudTrail::Types::GetEventDataStoreResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_event_selectors ⇒ Array<Types::AdvancedEventSelector>

#billing_mode ⇒ String

#created_timestamp ⇒ Time

#event_data_store_arn ⇒ String

#federation_role_arn ⇒ String

#federation_status ⇒ String

#kms_key_id ⇒ String

#multi_region_enabled ⇒ Boolean

#name ⇒ String

#organization_enabled ⇒ Boolean

#partition_keys ⇒ Array<Types::PartitionKey>

#retention_period ⇒ Integer

#status ⇒ String

#termination_protection_enabled ⇒ Boolean

#updated_timestamp ⇒ Time

#advanced_event_selectors ⇒ `Array<Types::AdvancedEventSelector>`

#billing_mode ⇒ `String`

#created_timestamp ⇒ `Time`

#event_data_store_arn ⇒ `String`

#federation_role_arn ⇒ `String`

#federation_status ⇒ `String`

#kms_key_id ⇒ `String`

#multi_region_enabled ⇒ `Boolean`

#name ⇒ `String`

#organization_enabled ⇒ `Boolean`

#partition_keys ⇒ `Array<Types::PartitionKey>`

#retention_period ⇒ `Integer`

#status ⇒ `String`

#termination_protection_enabled ⇒ `Boolean`

#updated_timestamp ⇒ `Time`