interface AWSAPICallViaCloudTrailProps 🔹

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.S3.Events.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awss3/events#AWSAPICallViaCloudTrail_AWSAPICallViaCloudTrailProps`
Java	`software.amazon.awscdk.mixins.preview.services.s3.events.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps`
Python	`aws_cdk.mixins_preview.aws_s3.events.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps`
TypeScript	`@aws-cdk/mixins-preview` » `aws_s3` » `events` » `AWSAPICallViaCloudTrail` » `AWSAPICallViaCloudTrailProps`

Props type for aws.s3@AWSAPICallViaCloudTrail event.

Example

import { AWSAPICallViaCloudTrail, ObjectCreated, ObjectDeleted } from '@aws-cdk/mixins-preview/aws-s3/events';
import * as events from 'aws-cdk-lib/aws-events';
import * as targets from 'aws-cdk-lib/aws-events-targets';

declare const fn: lambda.Function;

// Works with L2 Rule
new events.Rule(scope, 'Rule', {
  eventPattern: AWSAPICallViaCloudTrail.awsAPICallViaCloudTrailPattern({
    tlsDetails: { tlsVersion: ['TLSv1.3'] },
    eventMetadata: { region: ['us-east-1'] },
  }),
  targets: [new targets.LambdaFunction(fn)]
});

// Also works with L1 CfnRule
new events.CfnRule(scope, 'CfnRule', {
  state: 'ENABLED',
  eventPattern: AWSAPICallViaCloudTrail.awsAPICallViaCloudTrailPattern({
    tlsDetails: { tlsVersion: ['TLSv1.3'] },
    eventMetadata: { region: ['us-east-1'] },
  }),
  targets: [{ arn: fn.functionArn, id: 'L1' }]
});

Properties

Name	Type	Description
additionalEventData?🔹	`AdditionalEventData`	additionalEventData property.
awsRegion?🔹	`string[]`	awsRegion property.
errorCode?🔹	`string[]`	errorCode property.
errorMessage?🔹	`string[]`	errorMessage property.
eventCategory?🔹	`string[]`	eventCategory property.
eventId?🔹	`string[]`	eventID property.
eventMetadata?🔹	`AWSEventMetadataProps`	EventBridge event metadata.
eventName?🔹	`string[]`	eventName property.
eventSource?🔹	`string[]`	eventSource property.
eventTime?🔹	`string[]`	eventTime property.
eventType?🔹	`string[]`	eventType property.
eventVersion?🔹	`string[]`	eventVersion property.
managementEvent?🔹	`string[]`	managementEvent property.
readOnly?🔹	`string[]`	readOnly property.
recipientAccountId?🔹	`string[]`	recipientAccountId property.
requestId?🔹	`string[]`	requestID property.
requestParameters?🔹	`RequestParameters`	requestParameters property.
resources?🔹	`AwsapiCallViaCloudTrailItem[]`	resources property.
responseElements?🔹	`string[]`	responseElements property.
sourceIpAddress?🔹	`string[]`	sourceIPAddress property.
tlsDetails?🔹	`TlsDetails`	tlsDetails property.
userAgent?🔹	`string[]`	userAgent property.
userIdentity?🔹	`UserIdentity`	userIdentity property.
vpcEndpointId?🔹	`string[]`	vpcEndpointId property.

additionalEventData?🔹

Type: AdditionalEventData (optional, default: Do not filter on this field)

additionalEventData property.

Specify an array of string values to match this event if the actual value of additionalEventData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

awsRegion?🔹

Type: string[] (optional, default: Do not filter on this field)

awsRegion property.

Specify an array of string values to match this event if the actual value of awsRegion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

errorCode?🔹

Type: string[] (optional, default: Do not filter on this field)

errorCode property.

Specify an array of string values to match this event if the actual value of errorCode is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

errorMessage?🔹

Type: string[] (optional, default: Do not filter on this field)

errorMessage property.

Specify an array of string values to match this event if the actual value of errorMessage is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

eventCategory?🔹

Type: string[] (optional, default: Do not filter on this field)

eventCategory property.

Specify an array of string values to match this event if the actual value of eventCategory is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

eventId?🔹

Type: string[] (optional, default: Do not filter on this field)

eventID property.

Specify an array of string values to match this event if the actual value of eventID is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

eventMetadata?🔹

Type: AWSEventMetadataProps (optional, default: -)

EventBridge event metadata.

eventName?🔹

Type: string[] (optional, default: Do not filter on this field)

eventName property.

Specify an array of string values to match this event if the actual value of eventName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

eventSource?🔹

Type: string[] (optional, default: Do not filter on this field)

eventSource property.

Specify an array of string values to match this event if the actual value of eventSource is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

eventTime?🔹

Type: string[] (optional, default: Do not filter on this field)

eventTime property.

Specify an array of string values to match this event if the actual value of eventTime is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

eventType?🔹

Type: string[] (optional, default: Do not filter on this field)

eventType property.

Specify an array of string values to match this event if the actual value of eventType is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

eventVersion?🔹

Type: string[] (optional, default: Do not filter on this field)

eventVersion property.

Specify an array of string values to match this event if the actual value of eventVersion is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

managementEvent?🔹

Type: string[] (optional, default: Do not filter on this field)

managementEvent property.

Specify an array of string values to match this event if the actual value of managementEvent is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

readOnly?🔹

Type: string[] (optional, default: Do not filter on this field)

readOnly property.

Specify an array of string values to match this event if the actual value of readOnly is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

recipientAccountId?🔹

Type: string[] (optional, default: Do not filter on this field)

recipientAccountId property.

Specify an array of string values to match this event if the actual value of recipientAccountId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

requestId?🔹

Type: string[] (optional, default: Do not filter on this field)

requestID property.

Specify an array of string values to match this event if the actual value of requestID is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

requestParameters?🔹

Type: RequestParameters (optional, default: Do not filter on this field)

requestParameters property.

Specify an array of string values to match this event if the actual value of requestParameters is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

resources?🔹

Type: AwsapiCallViaCloudTrailItem[] (optional, default: Do not filter on this field)

resources property.

Specify an array of string values to match this event if the actual value of resources is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

responseElements?🔹

Type: string[] (optional, default: Do not filter on this field)

responseElements property.

Specify an array of string values to match this event if the actual value of responseElements is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

sourceIpAddress?🔹

Type: string[] (optional, default: Do not filter on this field)

sourceIPAddress property.

Specify an array of string values to match this event if the actual value of sourceIPAddress is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

tlsDetails?🔹

Type: TlsDetails (optional, default: Do not filter on this field)

tlsDetails property.

Specify an array of string values to match this event if the actual value of tlsDetails is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

userAgent?🔹

Type: string[] (optional, default: Do not filter on this field)

userAgent property.

Specify an array of string values to match this event if the actual value of userAgent is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

userIdentity?🔹

Type: UserIdentity (optional, default: Do not filter on this field)

userIdentity property.

Specify an array of string values to match this event if the actual value of userIdentity is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

vpcEndpointId?🔹

Type: string[] (optional, default: Do not filter on this field)

vpcEndpointId property.

Specify an array of string values to match this event if the actual value of vpcEndpointId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

AWS CDK

2.245.0

interface AWSAPICallViaCloudTrailProps 🔹

Example

Properties

additionalEventData?🔹

awsRegion?🔹

errorCode?🔹

errorMessage?🔹

eventCategory?🔹

eventId?🔹

eventMetadata?🔹

eventName?🔹

eventSource?🔹

eventTime?🔹

eventType?🔹

eventVersion?🔹

managementEvent?🔹

readOnly?🔹

recipientAccountId?🔹

requestId?🔹

requestParameters?🔹

resources?🔹

responseElements?🔹

sourceIpAddress?🔹

tlsDetails?🔹

userAgent?🔹

userIdentity?🔹

vpcEndpointId?🔹