aws-cdk-lib

import * as cdk from "../../core"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; /** * Contains information about a returned CloudTrail channel. * * @cloudformationResource AWS::CloudTrail::Channel * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html */ export declare class CfnChannel extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnChannel from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnChannel; /** * `Ref` returns the ARN of the CloudTrail channel, such as `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890` . * * @cloudformationAttribute ChannelArn */ readonly attrChannelArn: string; /** * One or more event data stores to which events arriving through a channel will be logged. */ destinations?: Array<CfnChannel.DestinationProperty | cdk.IResolvable> | cdk.IResolvable; /** * The name of the channel. */ name?: string; /** * The name of the partner or external event source. */ source?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of tags. */ tagsRaw?: Array<cdk.CfnTag>; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnChannelProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnChannel { /** * Contains information about the destination receiving events. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html */ interface DestinationProperty { /** * For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. * * For service-linked channels, the location is the name of the AWS service. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html#cfn-cloudtrail-channel-destination-location */ readonly location: string; /** * The type of destination for events arriving from a channel. * * For channels used for a CloudTrail Lake integration, the value is `EVENT_DATA_STORE` . For service-linked channels, the value is `AWS_SERVICE` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html#cfn-cloudtrail-channel-destination-type */ readonly type: string; } } /** * Properties for defining a `CfnChannel` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html */ export interface CfnChannelProps { /** * One or more event data stores to which events arriving through a channel will be logged. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-destinations */ readonly destinations?: Array<CfnChannel.DestinationProperty | cdk.IResolvable> | cdk.IResolvable; /** * The name of the channel. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-name */ readonly name?: string; /** * The name of the partner or external event source. * * You cannot change this name after you create the channel. A maximum of one channel is allowed per source. * * A source can be either `Custom` for all valid non- AWS events, or the name of a partner event source. For information about the source names for available partners, see [Additional information about integration partners](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information) in the CloudTrail User Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-source */ readonly source?: string; /** * A list of tags. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * Creates a new event data store. * * @cloudformationResource AWS::CloudTrail::EventDataStore * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html */ export declare class CfnEventDataStore extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnEventDataStore from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnEventDataStore; /** * `Ref` returns the time stamp of the creation of the event data store, such as `1248496624` . * * @cloudformationAttribute CreatedTimestamp */ readonly attrCreatedTimestamp: string; /** * `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 */ readonly attrEventDataStoreArn: string; /** * `Ref` returns the status of the event data store, such as `ENABLED` . * * @cloudformationAttribute Status */ readonly attrStatus: string; /** * `Ref` returns the time stamp that updates were made to an event data store, such as `1598296624` . * * @cloudformationAttribute UpdatedTimestamp */ readonly attrUpdatedTimestamp: string; /** * The advanced event selectors to use to select the events for the data store. */ advancedEventSelectors?: Array<CfnEventDataStore.AdvancedEventSelectorProperty | cdk.IResolvable> | cdk.IResolvable; /** * 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. */ billingMode?: string; /** * Indicates if [Lake query federation](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html) is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled. */ federationEnabled?: boolean | cdk.IResolvable; /** * If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store. */ federationRoleArn?: string; /** * Specifies whether the event data store should start ingesting live events. */ ingestionEnabled?: boolean | cdk.IResolvable; /** * The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. */ insightsDestination?: string; /** * A JSON string that contains the Insights types you want to log on an event data store. */ insightSelectors?: Array<CfnEventDataStore.InsightSelectorProperty | cdk.IResolvable> | cdk.IResolvable; /** * Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail. */ kmsKeyId?: string; /** * Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created. */ multiRegionEnabled?: boolean | cdk.IResolvable; /** * The name of the event data store. */ name?: string; /** * Specifies whether an event data store collects events logged for an organization in AWS Organizations . */ organizationEnabled?: boolean | cdk.IResolvable; /** * The retention period of the event data store, in days. */ retentionPeriod?: number; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of tags. */ tagsRaw?: Array<cdk.CfnTag>; /** * Specifies whether termination protection is enabled for the event data store. */ terminationProtectionEnabled?: boolean | cdk.IResolvable; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnEventDataStoreProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnEventDataStore { /** * Advanced event selectors let you create fine-grained selectors for CloudTrail management and data events. * * They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see [Logging management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) and [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) 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` * * *Supported CloudTrail event record fields for data events* * * - `eventCategory` (required) * - `resources.type` (required) * - `readOnly` * - `eventName` * - `resources.ARN` * * > 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` . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html */ interface AdvancedEventSelectorProperty { /** * 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 */ readonly fieldSelectors: Array<CfnEventDataStore.AdvancedFieldSelectorProperty | cdk.IResolvable> | cdk.IResolvable; /** * 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 */ readonly name?: string; } /** * A single selector statement in an advanced event selector. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html */ interface AdvancedFieldSelectorProperty { /** * 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 */ readonly endsWith?: Array<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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-equals */ readonly equalTo?: Array<string>; /** * 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 `readOnly` , `eventCategory` , and `eventSource` . * * For CloudTrail data events, supported fields include `readOnly` , `eventCategory` , `eventName` , `resources.type` , and `resources.ARN` . * * 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`* - Optional. Can be set to `Equals` 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`* - For filtering management events only. This can be set to `NotEquals` `kms.amazonaws.com` or `NotEquals` `rdsdata.amazonaws.com` . * - *`eventName`* - Can use any operator. You can use it to ﬁlter in or ﬁlter out any data event logged to CloudTrail, such as `PutBucket` or `GetSnapshotBlock` . You can have multiple values for this ﬁeld, separated by commas. * - *`eventCategory`* - This 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` . * * 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 non- AWS events, the value must be `ActivityAuditLog` . * - *`resources.type`* - This ﬁeld is required for CloudTrail data events. `resources.type` can only use the `Equals` operator, and the value can be one of the following: * * - `AWS::DynamoDB::Table` * - `AWS::Lambda::Function` * - `AWS::S3::Object` * - `AWS::AppConfig::Configuration` * - `AWS::B2BI::Transformer` * - `AWS::Bedrock::AgentAlias` * - `AWS::Bedrock::KnowledgeBase` * - `AWS::Cassandra::Table` * - `AWS::CloudFront::KeyValueStore` * - `AWS::CloudTrail::Channel` * - `AWS::CodeWhisperer::Customization` * - `AWS::CodeWhisperer::Profile` * - `AWS::Cognito::IdentityPool` * - `AWS::DynamoDB::Stream` * - `AWS::EC2::Snapshot` * - `AWS::EMRWAL::Workspace` * - `AWS::FinSpace::Environment` * - `AWS::Glue::Table` * - `AWS::GreengrassV2::ComponentVersion` * - `AWS::GreengrassV2::Deployment` * - `AWS::GuardDuty::Detector` * - `AWS::IoT::Certificate` * - `AWS::IoT::Thing` * - `AWS::IoTSiteWise::Asset` * - `AWS::IoTSiteWise::TimeSeries` * - `AWS::IoTTwinMaker::Entity` * - `AWS::IoTTwinMaker::Workspace` * - `AWS::KendraRanking::ExecutionPlan` * - `AWS::KinesisVideo::Stream` * - `AWS::ManagedBlockchain::Network` * - `AWS::ManagedBlockchain::Node` * - `AWS::MedicalImaging::Datastore` * - `AWS::NeptuneGraph::Graph` * - `AWS::PCAConnectorAD::Connector` * - `AWS::QBusiness::Application` * - `AWS::QBusiness::DataSource` * - `AWS::QBusiness::Index` * - `AWS::QBusiness::WebExperience` * - `AWS::RDS::DBCluster` * - `AWS::S3::AccessPoint` * - `AWS::S3ObjectLambda::AccessPoint` * - `AWS::S3Outposts::Object` * - `AWS::SageMaker::Endpoint` * - `AWS::SageMaker::ExperimentTrialComponent` * - `AWS::SageMaker::FeatureGroup` * - `AWS::ServiceDiscovery::Namespace` * - `AWS::ServiceDiscovery::Service` * - `AWS::SCN::Instance` * - `AWS::SNS::PlatformEndpoint` * - `AWS::SNS::Topic` * - `AWS::SWF::Domain` * - `AWS::SQS::Queue` * - `AWS::SSMMessages::ControlChannel` * - `AWS::ThinClient::Device` * - `AWS::ThinClient::Environment` * - `AWS::Timestream::Database` * - `AWS::Timestream::Table` * - `AWS::VerifiedPermissions::PolicyStore` * * You can have only one `resources.type` ﬁeld per selector. To log data events on more than one resource type, add another selector. * - *`resources.ARN`* - 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 speciﬁed in the template as the value of resources.type. For example, if resources.type equals `AWS::S3::Object` , the ARN must be in one of the following formats. 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. * * The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information. * * - `arn:<partition>:s3:::<bucket_name>/` * - `arn:<partition>:s3:::<bucket_name>/<object_path>/` * * When resources.type equals `AWS::DynamoDB::Table` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>` * * When resources.type equals `AWS::Lambda::Function` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>` * * When resources.type equals `AWS::AppConfig::Configuration` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID>` * * When resources.type equals `AWS::B2BI::Transformer` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>` * * When resources.type equals `AWS::Bedrock::AgentAlias` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>` * * When resources.type equals `AWS::Bedrock::KnowledgeBase` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>` * * When resources.type equals `AWS::Cassandra::Table` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>` * * When resources.type equals `AWS::CloudFront::KeyValueStore` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_name>` * * When resources.type equals `AWS::CloudTrail::Channel` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>` * * When resources.type equals `AWS::CodeWhisperer::Customization` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>` * * When resources.type equals `AWS::CodeWhisperer::Profile` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:codewhisperer:<region>:<account_ID>:profile/<profile_ID>` * * When resources.type equals `AWS::Cognito::IdentityPool` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_ID>` * * When `resources.type` equals `AWS::DynamoDB::Stream` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>` * * When `resources.type` equals `AWS::EC2::Snapshot` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>` * * When `resources.type` equals `AWS::EMRWAL::Workspace` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:emrwal:<region>:<account_ID>:workspace/<workspace_name>` * * When `resources.type` equals `AWS::FinSpace::Environment` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>` * * When `resources.type` equals `AWS::Glue::Table` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>` * * When `resources.type` equals `AWS::GreengrassV2::ComponentVersion` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name>` * * When `resources.type` equals `AWS::GreengrassV2::Deployment` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID` * * When `resources.type` equals `AWS::GuardDuty::Detector` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>` * * When `resources.type` equals `AWS::IoT::Certificate` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID>` * * When `resources.type` equals `AWS::IoT::Thing` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID>` * * When `resources.type` equals `AWS::IoTSiteWise::Asset` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID>` * * When `resources.type` equals `AWS::IoTSiteWise::TimeSeries` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID>` * * When `resources.type` equals `AWS::IoTTwinMaker::Entity` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>` * * When `resources.type` equals `AWS::IoTTwinMaker::Workspace` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>` * * When `resources.type` equals `AWS::KendraRanking::ExecutionPlan` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID>` * * When `resources.type` equals `AWS::KinesisVideo::Stream` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>` * * When `resources.type` equals `AWS::ManagedBlockchain::Network` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:managedblockchain:::networks/<network_name>` * * When `resources.type` equals `AWS::ManagedBlockchain::Node` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>` * * When `resources.type` equals `AWS::MedicalImaging::Datastore` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>` * * When `resources.type` equals `AWS::NeptuneGraph::Graph` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>` * * When `resources.type` equals `AWS::PCAConnectorAD::Connector` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>` * * When `resources.type` equals `AWS::QBusiness::Application` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>` * * When `resources.type` equals `AWS::QBusiness::DataSource` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>` * * When `resources.type` equals `AWS::QBusiness::Index` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>` * * When `resources.type` equals `AWS::QBusiness::WebExperience` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>` * * When `resources.type` equals `AWS::RDS::DBCluster` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_name>` * * When `resources.type` equals `AWS::S3::AccessPoint` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the `StartsWith` or `NotStartsWith` operators. * * - `arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>` * - `arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>` * * When `resources.type` equals `AWS::S3ObjectLambda::AccessPoint` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>` * * When `resources.type` equals `AWS::S3Outposts::Object` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>` * * When `resources.type` equals `AWS::SageMaker::Endpoint` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>` * * When `resources.type` equals `AWS::SageMaker::ExperimentTrialComponent` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>` * * When `resources.type` equals `AWS::SageMaker::FeatureGroup` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>` * * When `resources.type` equals `AWS::SCN::Instance` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>` * * When `resources.type` equals `AWS::ServiceDiscovery::Namespace` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>` * * When `resources.type` equals `AWS::ServiceDiscovery::Service` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>` * * When `resources.type` equals `AWS::SNS::PlatformEndpoint` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>` * * When `resources.type` equals `AWS::SNS::Topic` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:sns:<region>:<account_ID>:<topic_name>` * * When `resources.type` equals `AWS::SWF::Domain` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name>` * * When `resources.type` equals `AWS::SQS::Queue` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:sqs:<region>:<account_ID>:<queue_name>` * * When `resources.type` equals `AWS::SSMMessages::ControlChannel` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>` * * When `resources.type` equals `AWS::ThinClient::Device` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>` * * When `resources.type` equals `AWS::ThinClient::Environment` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:thinclient:<region>:<account_ID>:environment/<environment_ID>` * * When `resources.type` equals `AWS::Timestream::Database` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>` * * When `resources.type` equals `AWS::Timestream::Table` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>` * * When resources.type equals `AWS::VerifiedPermissions::PolicyStore` , and the operator is set to `Equals` or `NotEquals` , the ARN must be in the following format: * * - `arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-field */ readonly field: string; /** * 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 */ readonly notEndsWith?: Array<string>; /** * 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 */ readonly notEquals?: Array<string>; /** * 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 */ readonly notStartsWith?: Array<string>; /** * 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 */ readonly startsWith?: Array<string>; } /** * A JSON string that contains a list of Insights types that are logged on an event data store. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-insightselector.html */ interface InsightSelectorProperty { /** * 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 */ readonly insightType?: string; } } /** * Properties for defining a `CfnEventDataStore` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html */ export interface CfnEventDataStoreProps { /** * 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](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) 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](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-eds-config) in the CloudTrail User Guide. * * For more information about how to use advanced event selectors to include non- AWS events in your event data store, see [Create an integration to log events from outside AWS](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-integration) in the CloudTrail User Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-advancedeventselectors */ readonly advancedEventSelectors?: Array<CfnEventDataStore.AdvancedEventSelectorProperty | cdk.IResolvable> | cdk.IResolvable; /** * 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](https://docs.aws.amazon.com/cloudtrail/pricing/) and [Managing CloudTrail Lake costs](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-billingmode */ readonly billingMode?: string; /** * Indicates if [Lake query federation](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html) is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationenabled */ readonly federationEnabled?: boolean | cdk.IResolvable; /** * 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](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html#query-federation-permissions-role) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationrolearn */ readonly federationRoleArn?: string; /** * Specifies whether the event data store should start ingesting live events. * * The default is true. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-ingestionenabled */ readonly ingestionEnabled?: boolean | cdk.IResolvable; /** * 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](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-insights.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightsdestination */ readonly insightsDestination?: string; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightselectors */ readonly insightSelectors?: Array<CfnEventDataStore.InsightSelectorProperty | cdk.IResolvable> | cdk.IResolvable; /** * 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. * * > 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](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) 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` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-kmskeyid */ readonly kmsKeyId?: string; /** * Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-multiregionenabled */ readonly multiRegionEnabled?: boolean | cdk.IResolvable; /** * The name of the event data store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-name */ readonly name?: string; /** * Specifies whether an event data store collects events logged for an organization in AWS Organizations . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-organizationenabled */ readonly organizationEnabled?: boolean | cdk.IResolvable; /** * The retention period of the event data store, in days. * * If `BillingMode` is set to `EXTENDABLE_RETENTION_PRICING` , you can set a retention period of up to 3653 days, the equivalent of 10 years. If `BillingMode` is set to `FIXED_RETENTION_PRICING` , you can set a retention period of up to 2557 days, the equivalent of seven years. * * CloudTrail Lake determines whether to retain an event by checking if the `eventTime` of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the `eventTime` is older than 90 days. * * > If you 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-retentionperiod */ readonly retentionPeriod?: number; /** * A list of tags. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-tags */ readonly tags?: Array<cdk.CfnTag>; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-terminationprotectionenabled */ readonly terminationProtectionEnabled?: boolean | cdk.IResolvable; } /** * Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of AWS . * * For more information about resource-based policies, see [CloudTrail resource-based policy examples](https://docs.aws.amazon.com/aws