aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
885 lines • 82.4 kB
TypeScript
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 `EventDataStore` . 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;
/**
* Specifies whether the event data store should start ingesting live events.
*/
ingestionEnabled?: boolean | 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 the following AWS CloudTrail event record fields.
*
* They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide* .
*
* - `readOnly`
* - `eventSource`
* - `eventName`
* - `eventCategory`
* - `resources.type`
* - `resources.ARN`
*
* You cannot apply both event selectors and advanced event selectors to a trail.
*
* @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 AWS Config configuration items, Audit Manager evidence, or non- AWS events, the field is used only for selecting events as filtering is not supported.
*
* For CloudTrail event records, supported fields include `readOnly` , `eventCategory` , `eventSource` (for management events), `eventName` , `resources.type` , and `resources.ARN` .
*
* For event data stores for AWS Config configuration items, Audit Manager evidence, or non- AWS events, 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 filter in or filter out any data event logged to CloudTrail, such as `PutBucket` or `GetSnapshotBlock` . You can have multiple values for this field, separated by commas.
* - *`eventCategory`* - This is required and must be set to `Equals` .
*
* - For CloudTrail event records, the value must be `Management` or `Data` .
* - 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 field 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::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::GuardDuty::Detector`
* - `AWS::KendraRanking::ExecutionPlan`
* - `AWS::KinesisVideo::Stream`
* - `AWS::ManagedBlockchain::Network`
* - `AWS::ManagedBlockchain::Node`
* - `AWS::MedicalImaging::Datastore`
* - `AWS::PCAConnectorAD::Connector`
* - `AWS::SageMaker::Endpoint`
* - `AWS::SageMaker::ExperimentTrialComponent`
* - `AWS::SageMaker::FeatureGroup`
* - `AWS::SNS::PlatformEndpoint`
* - `AWS::SNS::Topic`
* - `AWS::S3::AccessPoint`
* - `AWS::S3ObjectLambda::AccessPoint`
* - `AWS::S3Outposts::Object`
* - `AWS::SSMMessages::ControlChannel`
* - `AWS::Timestream::Database`
* - `AWS::Timestream::Table`
* - `AWS::VerifiedPermissions::PolicyStore`
*
* You can have only one `resources.type` field 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 specified 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::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>::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::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::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::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::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::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::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::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::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>;
}
}
/**
* 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;
/**
* 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;
/**
* 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.
*
* You can set a retention period of up to 2557 days, the equivalent of seven 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/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html) in the *CloudTrail User Guide* .
*
* @cloudformationResource AWS::CloudTrail::ResourcePolicy
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html
*/
export declare class CfnResourcePolicy extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnResourcePolicy 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): CfnResourcePolicy;
/**
* The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.
*/
resourceArn: string;
/**
* A JSON-formatted string for an AWS resource-based policy.
*/
resourcePolicy: any | 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: CfnResourcePolicyProps);
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>;
}
/**
* Properties for defining a `CfnResourcePolicy`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html
*/
export interface CfnResourcePolicyProps {
/**
* The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.
*
* The following is the format of a resource ARN: `arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html#cfn-cloudtrail-resourcepolicy-resourcearn
*/
readonly resourceArn: string;
/**
* A JSON-formatted string for an AWS resource-based policy.
*
* The following are requirements for the resource policy:
*
* - Contains only one action: cloudtrail-data:PutAuditEvents
* - Contains at least one statement. The policy can have a maximum of 20 statements.
* - Each statement contains at least one principal. A statement can have a maximum of 50 principals.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html#cfn-cloudtrail-resourcepolicy-resourcepolicy
*/
readonly resourcePolicy: any | cdk.IResolvable;
}
/**
* Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
*
* @cloudformationResource AWS::CloudTrail::Trail
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html
*/
export declare class CfnTrail 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 CfnTrail 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): CfnTrail;
/**
* `Ref` returns the ARN of the CloudTrail trail, such as `arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail` .
*
* @cloudformationAttribute Arn
*/
readonly attrArn: string;
/**
* `Ref` returns the ARN of the Amazon SNS topic that's associated with the CloudTrail trail, such as `arn:aws:sns:us-east-2:123456789012:mySNSTopic` .
*
* @cloudformationAttribute SnsTopicArn
*/
readonly attrSnsTopicArn: string;
/**
* Specifies the settings for advanced event selectors.
*/
advancedEventSelectors?: Array<CfnTrail.AdvancedEventSelectorProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered.
*/
cloudWatchLogsLogGroupArn?: string;
/**
* Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
*/
cloudWatchLogsRoleArn?: string;
/**
* Specifies whether log file validation is enabled. The default is false.
*/
enableLogFileValidation?: boolean | cdk.IResolvable;
/**
* Use event selectors to further specify the management and data event settings for your trail.
*/
eventSelectors?: Array<CfnTrail.EventSelectorProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Specifies whether the trail is publishing events from global services such as IAM to the log files.
*/
includeGlobalServiceEvents?: boolean | cdk.IResolvable;
/**
* A JSON string that contains the insight types you want to log on a trail.
*/
insightSelectors?: Array<CfnTrail.InsightSelectorProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Whether the CloudTrail trail is currently logging AWS API calls.
*/
isLogging: boolean | cdk.IResolvable;
/**
* Specifies whether the trail applies only to the current Region or to all Regions.
*/
isMultiRegionTrail?: boolean | cdk.IResolvable;
/**
* Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account .
*/
isOrganizationTrail?: boolean | cdk.IResolvable;
/**
* Specifies the AWS KMS key ID to use to encrypt the logs delivered by CloudTrail.
*/
kmsKeyId?: string;
/**
* Specifies the name of the Amazon S3 bucket designated for publishing log files.
*/
s3BucketName: string;
/**
* Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
*/
s3KeyPrefix?: string;
/**
* Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
*/
snsTopicName?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* A custom set of tags (key-value pairs) for this trail.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* Specifies the name of the trail. The name must meet the following requirements:.
*/
trailName?: string;
/**
* @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: CfnTrailProps);
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 CfnTrail {
/**
* Use event selectors to further specify the management and data event settings for your trail.
*
* By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
*
* You can configure up to five event selectors for a trail.
*
* You cannot apply both event selectors and advanced event selectors to a trail.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html
*/
interface EventSelectorProperty {
/**
* CloudTrail supports data event logging for Amazon S3 objects, AWS Lambda functions, and Amazon DynamoDB tables with basic event selectors.
*
* You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.
*
* For more information, see [Data Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) and [Limits in AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the *AWS CloudTrail User Guide* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-dataresources
*/
readonly dataResources?: Array<CfnTrail.DataResourceProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* An optional list of service event sources from which you do not want management events to be logged on your trail.
*
* In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service or Amazon RDS Data API events by containing `kms.amazonaws.com` or `rdsdata.amazonaws.com` . By default, `ExcludeManagementEventSources` is empty, and AWS KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in Regions that support the event source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-excludemanagementeventsources
*/
readonly excludeManagementEventSources?: Array<string>;
/**
* Specify if you want your event selector to include management events for your trail.
*
* For more information, see [Management Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide* .
*
* By default, the value is `true` .
*
* The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same Region. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](https://docs.aws.amazon.com/cloudtrail/pricing/) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-includemanagementevents
*/
readonly includeManagementEvents?: boolean | cdk.IResolvable;
/**
* Specify if you want your trail to log read-only events, write-only events, or all.
*
* For example, the EC2 `GetConsoleOutput` is a read-only API operation and `RunInstances` is a write-only API operation.
*
* By default, the value is `All` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-readwritetype
*/
readonly readWriteType?: string;
}
/**
* The Amazon S3 buckets, AWS Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events.
*
* Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.
*
* > The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.
* >
* > If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.
*
* The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named `bucket-1` . In this example, the CloudTrail user specified an empty prefix, and the option to log both `Read` and `Write` data events.
*
* - A user uploads an image file to `bucket-1` .
* - The `PutObject` API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.
* - A user uploads an object to an Amazon S3 bucket named `arn:aws:s3:::bucket-2` .
* - The `PutObject` API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.
*
* The following example demonstrates how logging works when you configure logging of AWS Lambda data events for a Lambda function named *MyLambdaFunction* , but not for all Lambda functions.
*
* - A user runs a script that includes a call to the *MyLambdaFunction* function and the *MyOtherLambdaFunction* function.
* - The `Invoke` API operation on *MyLambdaFunction* is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for *MyLambdaFunction* , any invocations of that function are logged. The trail processes and logs the event.
* - The `Invoke` API operation on *MyOtherLambdaFunction* is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the `Invoke` operation for *MyOtherLambdaFunction* does not match the function specified for the trail. The trail doesn’t log the event.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html
*/
interface DataResourceProperty {
/**
* The resource type in which you want to log data events.
*
* You can specify the following *basic* event selector resource types:
*
* - `AWS::DynamoDB::Table`
* - `AWS::Lambda::Function`
* - `AWS::S3::Object`
*
* The following resource types are also available through *advanced* event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see [AdvancedFieldSelector](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html) .
*
* - `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::GuardDuty::Detector`
* - `AWS::KendraRanking::ExecutionPlan`
* - `AWS::KinesisVi