CfnEventDataStore

class aws_cdk.aws_cloudtrail.CfnEventDataStore(scope, id, *, advanced_event_selectors=None, billing_mode=None, federation_enabled=None, federation_role_arn=None, ingestion_enabled=None, insights_destination=None, insight_selectors=None, kms_key_id=None, multi_region_enabled=None, name=None, organization_enabled=None, retention_period=None, tags=None, termination_protection_enabled=None)

Bases: CfnResource

Creates a new event data store.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html

CloudformationResource:

AWS::CloudTrail::EventDataStore

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudtrail as cloudtrail

cfn_event_data_store = cloudtrail.CfnEventDataStore(self, "MyCfnEventDataStore",
    advanced_event_selectors=[cloudtrail.CfnEventDataStore.AdvancedEventSelectorProperty(
        field_selectors=[cloudtrail.CfnEventDataStore.AdvancedFieldSelectorProperty(
            field="field",

            # the properties below are optional
            ends_with=["endsWith"],
            equal_to=["equalTo"],
            not_ends_with=["notEndsWith"],
            not_equals=["notEquals"],
            not_starts_with=["notStartsWith"],
            starts_with=["startsWith"]
        )],

        # the properties below are optional
        name="name"
    )],
    billing_mode="billingMode",
    federation_enabled=False,
    federation_role_arn="federationRoleArn",
    ingestion_enabled=False,
    insights_destination="insightsDestination",
    insight_selectors=[cloudtrail.CfnEventDataStore.InsightSelectorProperty(
        insight_type="insightType"
    )],
    kms_key_id="kmsKeyId",
    multi_region_enabled=False,
    name="name",
    organization_enabled=False,
    retention_period=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    termination_protection_enabled=False
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • advanced_event_selectors (Union[IResolvable, Sequence[Union[IResolvable, AdvancedEventSelectorProperty, Dict[str, Any]]], None]) – 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 AWS Config configuration items in your event data store, see Create an event data store for AWS Config configuration items in the CloudTrail User Guide. For more information about how to use advanced event selectors to include events outside of AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.

  • billing_mode (Optional[str]) – The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store. The following are the possible values: - EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days. - FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days. The default value is EXTENDABLE_RETENTION_PRICING . For more information about CloudTrail pricing, see AWS CloudTrail Pricing and Managing CloudTrail Lake costs .

  • federation_enabled (Union[bool, IResolvable, None]) – Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.

  • federation_role_arn (Optional[str]) – If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store. The federation role must exist in your account and provide the required minimum permissions .

  • ingestion_enabled (Union[bool, IResolvable, None]) – Specifies whether the event data store should start ingesting live events. The default is true.

  • insights_destination (Optional[str]) – The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. For more information, see Create an event data store for CloudTrail Insights events .

  • insight_selectors (Union[IResolvable, Sequence[Union[IResolvable, InsightSelectorProperty, Dict[str, Any]]], None]) – A JSON string that contains the Insights types you want to log on an event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.

  • kms_key_id (Optional[str]) – Specifies the AWS 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. .. epigraph:: 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 AWS KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the AWS 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

  • multi_region_enabled (Union[bool, IResolvable, None]) – Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

  • name (Optional[str]) – The name of the event data store.

  • organization_enabled (Union[bool, IResolvable, None]) – Specifies whether an event data store collects events logged for an organization in AWS Organizations .

  • retention_period (Union[int, float, None]) – 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. .. epigraph:: If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags.

  • termination_protection_enabled (Union[bool, IResolvable, None]) – 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:
  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CloudTrail::EventDataStore'
advanced_event_selectors

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

attr_created_timestamp

Ref returns the time stamp of the creation of the event data store, such as 1248496624 .

CloudformationAttribute:

CreatedTimestamp

attr_event_data_store_arn

Ref returns the ARN of the CloudTrail event data store, such as arn:aws:cloudtrail:us-east-1:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE .

CloudformationAttribute:

EventDataStoreArn

attr_status

Ref returns the status of the event data store, such as ENABLED .

CloudformationAttribute:

Status

attr_updated_timestamp

Ref returns the time stamp that updates were made to an event data store, such as 1598296624 .

CloudformationAttribute:

UpdatedTimestamp

billing_mode

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.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

federation_enabled

Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.

federation_role_arn

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

ingestion_enabled

Specifies whether the event data store should start ingesting live events.

insight_selectors

A JSON string that contains the Insights types you want to log on an event data store.

insights_destination

The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.

kms_key_id

Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

multi_region_enabled

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

name

The name of the event data store.

node

The tree node.

organization_enabled

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

retention_period

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tag Manager which manages the tags for this resource.

tags_raw

A list of tags.

termination_protection_enabled

Specifies whether termination protection is enabled for the event data store.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AdvancedEventSelectorProperty

class CfnEventDataStore.AdvancedEventSelectorProperty(*, field_selectors, name=None)

Bases: object

Advanced event selectors let you create fine-grained selectors for AWS CloudTrail management, data, and network activity events.

They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events , Logging network activity events , and Logging management events topics in the AWS CloudTrail User Guide .

You cannot apply both event selectors and advanced event selectors to a trail.

Supported CloudTrail event record fields for management events

  • eventCategory (required)

  • eventSource

  • readOnly

The following additional fields are available for event data stores:

  • eventName

  • eventType

  • sessionCredentialFromConsole

  • userIdentity.arn

Supported CloudTrail event record fields for data events

  • eventCategory (required)

  • resources.type (required)

  • readOnly

  • eventName

  • resources.ARN

The following additional fields are available for event data stores:

  • eventSource

  • eventType

  • sessionCredentialFromConsole

  • userIdentity.arn

Supported CloudTrail event record fields for network activity events .. epigraph:

Network activity events is in preview release for CloudTrail and is subject to change.
  • eventCategory (required)

  • eventSource (required)

  • eventName

  • errorCode - The only valid value for errorCode is VpceAccessDenied .

  • vpcEndpointId

For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is eventCategory .

Parameters:
  • field_selectors (Union[IResolvable, Sequence[Union[IResolvable, AdvancedFieldSelectorProperty, Dict[str, Any]]]]) – Contains all selector statements in an advanced event selector.

  • name (Optional[str]) – An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudtrail as cloudtrail

advanced_event_selector_property = cloudtrail.CfnEventDataStore.AdvancedEventSelectorProperty(
    field_selectors=[cloudtrail.CfnEventDataStore.AdvancedFieldSelectorProperty(
        field="field",

        # the properties below are optional
        ends_with=["endsWith"],
        equal_to=["equalTo"],
        not_ends_with=["notEndsWith"],
        not_equals=["notEquals"],
        not_starts_with=["notStartsWith"],
        starts_with=["startsWith"]
    )],

    # the properties below are optional
    name="name"
)

Attributes

field_selectors

Contains all selector statements in an advanced event selector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html#cfn-cloudtrail-eventdatastore-advancedeventselector-fieldselectors

name

An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html#cfn-cloudtrail-eventdatastore-advancedeventselector-name

AdvancedFieldSelectorProperty

class CfnEventDataStore.AdvancedFieldSelectorProperty(*, field, ends_with=None, equal_to=None, not_ends_with=None, not_equals=None, not_starts_with=None, starts_with=None)

Bases: object

A single selector statement in an advanced event selector.

Parameters:
  • field (str) – A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported. For CloudTrail management events, supported fields include eventCategory (required), eventSource , and readOnly . The following additional fields are available for event data stores: eventName , eventType , sessionCredentialFromConsole , and userIdentity.arn . For CloudTrail data events, supported fields include eventCategory (required), resources.type (required), eventName , readOnly , and resources.ARN . The following additional fields are available for event data stores: eventSource , eventType , sessionCredentialFromConsole , and userIdentity.arn . For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName , errorCode , and vpcEndpointId . For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is eventCategory . - ``readOnly`` - This is an optional field that is only used for management events and data events. This field can be set to Equals with a value of true or false . If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events. - ``eventSource`` - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to NotEquals kms.amazonaws.com to exclude KMS management events, or NotEquals rdsdata.amazonaws.com to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the Equals operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. The following are valid values for network activity events: - cloudtrail.amazonaws.com - ec2.amazonaws.com - kms.amazonaws.com - secretsmanager.amazonaws.com - ``eventName`` - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with eventName . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas. - ``eventCategory`` - This field is required and must be set to Equals . - For CloudTrail management events, the value must be Management . - For CloudTrail data events, the value must be Data . - For CloudTrail network activity events, the value must be NetworkActivity . The following are used only for event data stores: - For CloudTrail Insights events, the value must be Insight . - For AWS Config configuration items, the value must be ConfigurationItem . - For Audit Manager evidence, the value must be Evidence . - For events outside of AWS , the value must be ActivityAuditLog . - ``eventType`` - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see CloudTrail record contents in the AWS CloudTrail user guide . - ``errorCode`` - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied . errorCode can only use the Equals operator. - ``sessionCredentialFromConsole`` - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an AWS Management Console session. sessionCredentialFromConsole can only use the Equals and NotEquals operators. - ``resources.type`` - This field is required for CloudTrail data events. resources.type can only use the Equals operator. For a list of available resource types for data events, see Data events in the AWS CloudTrail User Guide . You can have only one resources.type field per selector. To log events on more than one resource type, add another selector. - ``resources.ARN`` - The resources.ARN is an optional field for data events. You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you’ve specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. For information about filtering data events on the resources.ARN field, see Filtering data events by resources.ARN in the AWS CloudTrail User Guide . .. epigraph:: You can’t use the resources.ARN field to filter resource types that do not have ARNs. - ``userIdentity.arn`` - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator with userIdentity.arn . For more information on the userIdentity element, see CloudTrail userIdentity element in the AWS CloudTrail User Guide . - ``vpcEndpointId`` - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId .

  • ends_with (Optional[Sequence[str]]) – An operator that includes events that match the last few characters of the event record field specified as the value of Field .

  • equal_to (Optional[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 (Optional[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 (Optional[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 (Optional[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 (Optional[Sequence[str]]) – An operator that includes events that match the first few characters of the event record field specified as the value of Field .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudtrail as cloudtrail

advanced_field_selector_property = cloudtrail.CfnEventDataStore.AdvancedFieldSelectorProperty(
    field="field",

    # the properties below are optional
    ends_with=["endsWith"],
    equal_to=["equalTo"],
    not_ends_with=["notEndsWith"],
    not_equals=["notEquals"],
    not_starts_with=["notStartsWith"],
    starts_with=["startsWith"]
)

Attributes

ends_with

An operator that includes events that match the last few characters of the event record field specified as the value of Field .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-endswith

equal_to

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-equals

field

A field in a CloudTrail event record on which to filter events to be logged.

For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported.

For CloudTrail management events, supported fields include eventCategory (required), eventSource , and readOnly . The following additional fields are available for event data stores: eventName , eventType , sessionCredentialFromConsole , and userIdentity.arn .

For CloudTrail data events, supported fields include eventCategory (required), resources.type (required), eventName , readOnly , and resources.ARN . The following additional fields are available for event data stores: eventSource , eventType , sessionCredentialFromConsole , and userIdentity.arn .

For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName , errorCode , and vpcEndpointId .

For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is eventCategory .

  • ``readOnly`` - This is an optional field that is only used for management events and data events. This field can be set to Equals with a value of true or false . If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events.

  • ``eventSource`` - This field is only used for management events, data events (for event data stores only), and network activity events.

For management events for trails, this is an optional field that can be set to NotEquals kms.amazonaws.com to exclude KMS management events, or NotEquals rdsdata.amazonaws.com to exclude RDS management events.

For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator.

For network activity events, this is a required field that only uses the Equals operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source.

The following are valid values for network activity events:

  • cloudtrail.amazonaws.com

  • ec2.amazonaws.com

  • kms.amazonaws.com

  • secretsmanager.amazonaws.com

  • ``eventName`` - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with eventName . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas.

  • ``eventCategory`` - This field is required and must be set to Equals .

  • For CloudTrail management events, the value must be Management .

  • For CloudTrail data events, the value must be Data .

  • For CloudTrail network activity events, the value must be NetworkActivity .

The following are used only for event data stores:

  • For CloudTrail Insights events, the value must be Insight .

  • For AWS Config configuration items, the value must be ConfigurationItem .

  • For Audit Manager evidence, the value must be Evidence .

  • For events outside of AWS , the value must be ActivityAuditLog .

  • ``eventType`` - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see CloudTrail record contents in the AWS CloudTrail user guide .

  • ``errorCode`` - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied . errorCode can only use the Equals operator.

  • ``sessionCredentialFromConsole`` - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an AWS Management Console session. sessionCredentialFromConsole can only use the Equals and NotEquals operators.

  • ``resources.type`` - This field is required for CloudTrail data events. resources.type can only use the Equals operator.

For a list of available resource types for data events, see Data events in the AWS CloudTrail User Guide .

You can have only one resources.type field per selector. To log events on more than one resource type, add another selector.

  • ``resources.ARN`` - The resources.ARN is an optional field for data events. You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you’ve specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value.

For information about filtering data events on the resources.ARN field, see Filtering data events by resources.ARN in the AWS CloudTrail User Guide . .. epigraph:

You can't use the ``resources.ARN`` field to filter resource types that do not have ARNs.
  • ``userIdentity.arn`` - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator with userIdentity.arn . For more information on the userIdentity element, see CloudTrail userIdentity element in the AWS CloudTrail User Guide .

  • ``vpcEndpointId`` - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-field

not_ends_with

An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notendswith

not_equals

An operator that excludes events that match the exact value of the event record field specified as the value of Field .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notequals

not_starts_with

An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notstartswith

starts_with

An operator that includes events that match the first few characters of the event record field specified as the value of Field .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-startswith

InsightSelectorProperty

class CfnEventDataStore.InsightSelectorProperty(*, insight_type=None)

Bases: object

A JSON string that contains a list of Insights types that are logged on an event data store.

Parameters:

insight_type (Optional[str]) – The type of Insights events to log on an event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-insightselector.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudtrail as cloudtrail

insight_selector_property = cloudtrail.CfnEventDataStore.InsightSelectorProperty(
    insight_type="insightType"
)

Attributes

insight_type

The type of Insights events to log on an event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.

The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-insightselector.html#cfn-cloudtrail-eventdatastore-insightselector-insighttype