Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudtrail
  5. EventDataStore

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudtrail.EventDataStore

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode.

    Create EventDataStore Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EventDataStore(name: string, args?: EventDataStoreArgs, opts?: CustomResourceOptions);
    @overload
def EventDataStore(resource_name: str,
                   args: Optional[EventDataStoreArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def EventDataStore(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   advanced_event_selectors: Optional[Sequence[EventDataStoreAdvancedEventSelectorArgs]] = None,
                   billing_mode: Optional[str] = None,
                   federation_enabled: Optional[bool] = None,
                   federation_role_arn: Optional[str] = None,
                   ingestion_enabled: Optional[bool] = None,
                   insight_selectors: Optional[Sequence[EventDataStoreInsightSelectorArgs]] = None,
                   insights_destination: Optional[str] = None,
                   kms_key_id: Optional[str] = None,
                   multi_region_enabled: Optional[bool] = None,
                   name: Optional[str] = None,
                   organization_enabled: Optional[bool] = None,
                   retention_period: Optional[int] = None,
                   tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                   termination_protection_enabled: Optional[bool] = None)
    func NewEventDataStore(ctx *Context, name string, args *EventDataStoreArgs, opts ...ResourceOption) (*EventDataStore, error)
    public EventDataStore(string name, EventDataStoreArgs? args = null, CustomResourceOptions? opts = null)
    public EventDataStore(String name, EventDataStoreArgs args)
public EventDataStore(String name, EventDataStoreArgs args, CustomResourceOptions options)

    type: aws-native:cloudtrail:EventDataStore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EventDataStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EventDataStoreArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EventDataStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EventDataStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EventDataStoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    EventDataStore Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EventDataStore resource accepts the following input properties:

    AdvancedEventSelectors List<Pulumi.AwsNative.CloudTrail.Inputs.EventDataStoreAdvancedEventSelector>
    The advanced event selectors that were used to select events for the data store.
    BillingMode string
    The mode that the event data store will use to charge for event storage.
    FederationEnabled bool
    Indicates whether federation is enabled on an event data store.
    FederationRoleArn string
    The ARN of the role used for event data store federation.
    IngestionEnabled bool
    Indicates whether the event data store is ingesting events.
    InsightSelectors List<Pulumi.AwsNative.CloudTrail.Inputs.EventDataStoreInsightSelector>
    Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
    InsightsDestination string
    Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
    KmsKeyId string
    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.
    MultiRegionEnabled bool
    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.
    OrganizationEnabled bool
    Indicates that an event data store is collecting logged events for an organization.
    RetentionPeriod int
    The retention period, in days.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tags.
    TerminationProtectionEnabled bool
    Indicates whether the event data store is protected from termination.
    AdvancedEventSelectors []EventDataStoreAdvancedEventSelectorArgs
    The advanced event selectors that were used to select events for the data store.
    BillingMode string
    The mode that the event data store will use to charge for event storage.
    FederationEnabled bool
    Indicates whether federation is enabled on an event data store.
    FederationRoleArn string
    The ARN of the role used for event data store federation.
    IngestionEnabled bool
    Indicates whether the event data store is ingesting events.
    InsightSelectors []EventDataStoreInsightSelectorArgs
    Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
    InsightsDestination string
    Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
    KmsKeyId string
    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.
    MultiRegionEnabled bool
    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.
    OrganizationEnabled bool
    Indicates that an event data store is collecting logged events for an organization.
    RetentionPeriod int
    The retention period, in days.
    Tags TagArgs
    A list of tags.
    TerminationProtectionEnabled bool
    Indicates whether the event data store is protected from termination.
    advancedEventSelectors List<EventDataStoreAdvancedEventSelector>
    The advanced event selectors that were used to select events for the data store.
    billingMode String
    The mode that the event data store will use to charge for event storage.
    federationEnabled Boolean
    Indicates whether federation is enabled on an event data store.
    federationRoleArn String
    The ARN of the role used for event data store federation.
    ingestionEnabled Boolean
    Indicates whether the event data store is ingesting events.
    insightSelectors List<EventDataStoreInsightSelector>
    Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
    insightsDestination String
    Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
    kmsKeyId String
    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.
    multiRegionEnabled 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.
    organizationEnabled Boolean
    Indicates that an event data store is collecting logged events for an organization.
    retentionPeriod Integer
    The retention period, in days.
    tags List<Tag>
    A list of tags.
    terminationProtectionEnabled Boolean
    Indicates whether the event data store is protected from termination.
    advancedEventSelectors EventDataStoreAdvancedEventSelector[]
    The advanced event selectors that were used to select events for the data store.
    billingMode string
    The mode that the event data store will use to charge for event storage.
    federationEnabled boolean
    Indicates whether federation is enabled on an event data store.
    federationRoleArn string
    The ARN of the role used for event data store federation.
    ingestionEnabled boolean
    Indicates whether the event data store is ingesting events.
    insightSelectors EventDataStoreInsightSelector[]
    Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
    insightsDestination string
    Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
    kmsKeyId string
    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.
    multiRegionEnabled 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.
    organizationEnabled boolean
    Indicates that an event data store is collecting logged events for an organization.
    retentionPeriod number
    The retention period, in days.
    tags Tag[]
    A list of tags.
    terminationProtectionEnabled boolean
    Indicates whether the event data store is protected from termination.
    advanced_event_selectors Sequence[EventDataStoreAdvancedEventSelectorArgs]
    The advanced event selectors that were used to select events for the data store.
    billing_mode str
    The mode that the event data store will use to charge for event storage.
    federation_enabled bool
    Indicates whether federation is enabled on an event data store.
    federation_role_arn str
    The ARN of the role used for event data store federation.
    ingestion_enabled bool
    Indicates whether the event data store is ingesting events.
    insight_selectors Sequence[EventDataStoreInsightSelectorArgs]
    Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
    insights_destination str
    Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
    kms_key_id str
    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.
    multi_region_enabled bool
    Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
    name str
    The name of the event data store.
    organization_enabled bool
    Indicates that an event data store is collecting logged events for an organization.
    retention_period int
    The retention period, in days.
    tags Sequence[TagArgs]
    A list of tags.
    termination_protection_enabled bool
    Indicates whether the event data store is protected from termination.
    advancedEventSelectors List<Property Map>
    The advanced event selectors that were used to select events for the data store.
    billingMode String
    The mode that the event data store will use to charge for event storage.
    federationEnabled Boolean
    Indicates whether federation is enabled on an event data store.
    federationRoleArn String
    The ARN of the role used for event data store federation.
    ingestionEnabled Boolean
    Indicates whether the event data store is ingesting events.
    insightSelectors List<Property Map>
    Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
    insightsDestination String
    Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
    kmsKeyId String
    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.
    multiRegionEnabled 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.
    organizationEnabled Boolean
    Indicates that an event data store is collecting logged events for an organization.
    retentionPeriod Number
    The retention period, in days.
    tags List<Property Map>
    A list of tags.
    terminationProtectionEnabled Boolean
    Indicates whether the event data store is protected from termination.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EventDataStore resource produces the following output properties:

    CreatedTimestamp string
    The timestamp of the event data store's creation.
    EventDataStoreArn string
    The ARN of the event data store.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
    UpdatedTimestamp string
    The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    CreatedTimestamp string
    The timestamp of the event data store's creation.
    EventDataStoreArn string
    The ARN of the event data store.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
    UpdatedTimestamp string
    The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    createdTimestamp String
    The timestamp of the event data store's creation.
    eventDataStoreArn String
    The ARN of the event data store.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
    updatedTimestamp String
    The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    createdTimestamp string
    The timestamp of the event data store's creation.
    eventDataStoreArn string
    The ARN of the event data store.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
    updatedTimestamp string
    The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    created_timestamp str
    The timestamp of the event data store's creation.
    event_data_store_arn str
    The ARN of the event data store.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
    updated_timestamp str
    The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    createdTimestamp String
    The timestamp of the event data store's creation.
    eventDataStoreArn String
    The ARN of the event data store.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
    updatedTimestamp String
    The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

    Supporting Types

    EventDataStoreAdvancedEventSelector, EventDataStoreAdvancedEventSelectorArgs

    FieldSelectors List<Pulumi.AwsNative.CloudTrail.Inputs.EventDataStoreAdvancedFieldSelector>
    Contains all selector statements in an advanced event selector.
    Name string
    An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
    FieldSelectors []EventDataStoreAdvancedFieldSelector
    Contains all selector statements in an advanced event selector.
    Name string
    An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
    fieldSelectors List<EventDataStoreAdvancedFieldSelector>
    Contains all selector statements in an advanced event selector.
    name String
    An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
    fieldSelectors EventDataStoreAdvancedFieldSelector[]
    Contains all selector statements in an advanced event selector.
    name string
    An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
    field_selectors Sequence[EventDataStoreAdvancedFieldSelector]
    Contains all selector statements in an advanced event selector.
    name str
    An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
    fieldSelectors List<Property Map>
    Contains all selector statements in an advanced event selector.
    name String
    An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

    EventDataStoreAdvancedFieldSelector, EventDataStoreAdvancedFieldSelectorArgs

    Field string
    A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
    EndsWith List<string>
    An operator that includes events that match the last few characters of the event record field specified as the value of Field.
    Equals List<string>
    An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.
    NotEndsWith List<string>
    An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
    NotEquals List<string>
    An operator that excludes events that match the exact value of the event record field specified as the value of Field.
    NotStartsWith List<string>
    An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
    StartsWith List<string>
    An operator that includes events that match the first few characters of the event record field specified as the value of Field.
    Field string
    A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
    EndsWith []string
    An operator that includes events that match the last few characters of the event record field specified as the value of Field.
    Equals []string
    An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.
    NotEndsWith []string
    An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
    NotEquals []string
    An operator that excludes events that match the exact value of the event record field specified as the value of Field.
    NotStartsWith []string
    An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
    StartsWith []string
    An operator that includes events that match the first few characters of the event record field specified as the value of Field.
    field String
    A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
    endsWith List<String>
    An operator that includes events that match the last few characters of the event record field specified as the value of Field.
    equals_ List<String>
    An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.
    notEndsWith List<String>
    An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
    notEquals List<String>
    An operator that excludes events that match the exact value of the event record field specified as the value of Field.
    notStartsWith List<String>
    An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
    startsWith List<String>
    An operator that includes events that match the first few characters of the event record field specified as the value of Field.
    field string
    A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
    endsWith string[]
    An operator that includes events that match the last few characters of the event record field specified as the value of Field.
    equals string[]
    An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.
    notEndsWith string[]
    An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
    notEquals string[]
    An operator that excludes events that match the exact value of the event record field specified as the value of Field.
    notStartsWith string[]
    An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
    startsWith string[]
    An operator that includes events that match the first few characters of the event record field specified as the value of Field.
    field str
    A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
    ends_with Sequence[str]
    An operator that includes events that match the last few characters of the event record field specified as the value of Field.
    equals Sequence[str]
    An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.
    not_ends_with Sequence[str]
    An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
    not_equals Sequence[str]
    An operator that excludes events that match the exact value of the event record field specified as the value of Field.
    not_starts_with Sequence[str]
    An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
    starts_with Sequence[str]
    An operator that includes events that match the first few characters of the event record field specified as the value of Field.
    field String
    A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
    endsWith List<String>
    An operator that includes events that match the last few characters of the event record field specified as the value of Field.
    equals List<String>
    An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.
    notEndsWith List<String>
    An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
    notEquals List<String>
    An operator that excludes events that match the exact value of the event record field specified as the value of Field.
    notStartsWith List<String>
    An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
    startsWith List<String>
    An operator that includes events that match the first few characters of the event record field specified as the value of Field.

    EventDataStoreInsightSelector, EventDataStoreInsightSelectorArgs

    InsightType string
    The type of Insights to log on an event data store.
    InsightType string
    The type of Insights to log on an event data store.
    insightType String
    The type of Insights to log on an event data store.
    insightType string
    The type of Insights to log on an event data store.
    insight_type str
    The type of Insights to log on an event data store.
    insightType String
    The type of Insights to log on an event data store.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native