Package software.amazon.awscdk.mixins.preview.services.s3.events

Interface BucketEvents.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
BucketEvents.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps.Jsii$Proxy
Enclosing class:
BucketEvents.AWSAPICallViaCloudTrail
@Stability(Experimental) public static interface BucketEvents.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps extends software.amazon.jsii.JsiiSerializable
(experimental) Props type for Bucket aws.s3@AWSAPICallViaCloudTrail event.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.s3.events.*;
 AWSAPICallViaCloudTrailProps aWSAPICallViaCloudTrailProps = AWSAPICallViaCloudTrailProps.builder()
         .additionalEventData(AdditionalEventData.builder()
                 .authenticationMethod(List.of("authenticationMethod"))
                 .bytesTransferredIn(List.of("bytesTransferredIn"))
                 .bytesTransferredOut(List.of("bytesTransferredOut"))
                 .cipherSuite(List.of("cipherSuite"))
                 .objectRetentionInfo(ObjectRetentionInfo.builder()
                         .legalHoldInfo(LegalHoldInfo.builder()
                                 .isUnderLegalHold(List.of("isUnderLegalHold"))
                                 .lastModifiedTime(List.of("lastModifiedTime"))
                                 .build())
                         .retentionInfo(RetentionInfo.builder()
                                 .lastModifiedTime(List.of("lastModifiedTime"))
                                 .retainUntilMode(List.of("retainUntilMode"))
                                 .retainUntilTime(List.of("retainUntilTime"))
                                 .build())
                         .build())
                 .signatureVersion(List.of("signatureVersion"))
                 .xAmzId2(List.of("xAmzId2"))
                 .build())
         .awsRegion(List.of("awsRegion"))
         .errorCode(List.of("errorCode"))
         .errorMessage(List.of("errorMessage"))
         .eventCategory(List.of("eventCategory"))
         .eventId(List.of("eventId"))
         .eventMetadata(AWSEventMetadataProps.builder()
                 .region(List.of("region"))
                 .resources(List.of("resources"))
                 .version(List.of("version"))
                 .build())
         .eventName(List.of("eventName"))
         .eventSource(List.of("eventSource"))
         .eventTime(List.of("eventTime"))
         .eventType(List.of("eventType"))
         .eventVersion(List.of("eventVersion"))
         .managementEvent(List.of("managementEvent"))
         .readOnly(List.of("readOnly"))
         .recipientAccountId(List.of("recipientAccountId"))
         .requestId(List.of("requestId"))
         .requestParameters(RequestParameters.builder()
                 .bucketName(List.of("bucketName"))
                 .host(List.of("host"))
                 .key(List.of("key"))
                 .legalHold(List.of("legalHold"))
                 .retention(List.of("retention"))
                 .build())
         .resources(List.of(AwsapiCallViaCloudTrailItem.builder()
                 .accountId(List.of("accountId"))
                 .arn(List.of("arn"))
                 .type(List.of("type"))
                 .build()))
         .responseElements(List.of("responseElements"))
         .sourceIpAddress(List.of("sourceIpAddress"))
         .tlsDetails(TlsDetails.builder()
                 .cipherSuite(List.of("cipherSuite"))
                 .clientProvidedHostHeader(List.of("clientProvidedHostHeader"))
                 .tlsVersion(List.of("tlsVersion"))
                 .build())
         .userAgent(List.of("userAgent"))
         .userIdentity(UserIdentity.builder()
                 .accessKeyId(List.of("accessKeyId"))
                 .accountId(List.of("accountId"))
                 .arn(List.of("arn"))
                 .principalId(List.of("principalId"))
                 .sessionContext(SessionContext.builder()
                         .attributes(Attributes.builder()
                                 .creationDate(List.of("creationDate"))
                                 .mfaAuthenticated(List.of("mfaAuthenticated"))
                                 .build())
                         .sessionIssuer(SessionIssuer.builder()
                                 .accountId(List.of("accountId"))
                                 .arn(List.of("arn"))
                                 .principalId(List.of("principalId"))
                                 .type(List.of("type"))
                                 .userName(List.of("userName"))
                                 .build())
                         .webIdFederationData(List.of("webIdFederationData"))
                         .build())
                 .type(List.of("type"))
                 .build())
         .vpcEndpointId(List.of("vpcEndpointId"))
         .build();

  • Method Details

    • getAdditionalEventData

      @Stability(Experimental) @Nullable default BucketEvents.AWSAPICallViaCloudTrail.AdditionalEventData getAdditionalEventData()
      (experimental) 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.

      Default: - Do not filter on this field

    • getAwsRegion

      @Stability(Experimental) @Nullable default List<String> getAwsRegion()
      (experimental) 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.

      Default: - Do not filter on this field

    • getErrorCode

      @Stability(Experimental) @Nullable default List<String> getErrorCode()
      (experimental) 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.

      Default: - Do not filter on this field

    • getErrorMessage

      @Stability(Experimental) @Nullable default List<String> getErrorMessage()
      (experimental) 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.

      Default: - Do not filter on this field

    • getEventCategory

      @Stability(Experimental) @Nullable default List<String> getEventCategory()
      (experimental) 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.

      Default: - Do not filter on this field

    • getEventId

      @Stability(Experimental) @Nullable default List<String> getEventId()
      (experimental) 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.

      Default: - Do not filter on this field

    • getEventMetadata

      @Stability(Experimental) @Nullable default AWSEventMetadataProps getEventMetadata()
      (experimental) EventBridge event metadata.

      Default: - -

    • getEventName

      @Stability(Experimental) @Nullable default List<String> getEventName()
      (experimental) 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.

      Default: - Do not filter on this field

    • getEventSource

      @Stability(Experimental) @Nullable default List<String> getEventSource()
      (experimental) 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.

      Default: - Do not filter on this field

    • getEventTime

      @Stability(Experimental) @Nullable default List<String> getEventTime()
      (experimental) 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.

      Default: - Do not filter on this field

    • getEventType

      @Stability(Experimental) @Nullable default List<String> getEventType()
      (experimental) 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.

      Default: - Do not filter on this field

    • getEventVersion

      @Stability(Experimental) @Nullable default List<String> getEventVersion()
      (experimental) 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.

      Default: - Do not filter on this field

    • getManagementEvent

      @Stability(Experimental) @Nullable default List<String> getManagementEvent()
      (experimental) 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.

      Default: - Do not filter on this field

    • getReadOnly

      @Stability(Experimental) @Nullable default List<String> getReadOnly()
      (experimental) 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.

      Default: - Do not filter on this field

    • getRecipientAccountId

      @Stability(Experimental) @Nullable default List<String> getRecipientAccountId()
      (experimental) 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.

      Default: - Do not filter on this field

    • getRequestId

      @Stability(Experimental) @Nullable default List<String> getRequestId()
      (experimental) 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.

      Default: - Do not filter on this field

    • getRequestParameters

      @Stability(Experimental) @Nullable default BucketEvents.AWSAPICallViaCloudTrail.RequestParameters getRequestParameters()
      (experimental) 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.

      Default: - Do not filter on this field

    • getResources

      @Stability(Experimental) @Nullable default List<BucketEvents.AWSAPICallViaCloudTrail.AwsapiCallViaCloudTrailItem> getResources()
      (experimental) 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.

      Default: - Do not filter on this field

    • getResponseElements

      @Stability(Experimental) @Nullable default List<String> getResponseElements()
      (experimental) 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.

      Default: - Do not filter on this field

    • getSourceIpAddress

      @Stability(Experimental) @Nullable default List<String> getSourceIpAddress()
      (experimental) 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.

      Default: - Do not filter on this field

    • getTlsDetails

      @Stability(Experimental) @Nullable default BucketEvents.AWSAPICallViaCloudTrail.TlsDetails getTlsDetails()
      (experimental) 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.

      Default: - Do not filter on this field

    • getUserAgent

      @Stability(Experimental) @Nullable default List<String> getUserAgent()
      (experimental) 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.

      Default: - Do not filter on this field

    • getUserIdentity

      @Stability(Experimental) @Nullable default BucketEvents.AWSAPICallViaCloudTrail.UserIdentity getUserIdentity()
      (experimental) 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.

      Default: - Do not filter on this field

    • getVpcEndpointId

      @Stability(Experimental) @Nullable default List<String> getVpcEndpointId()
      (experimental) 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.

      Default: - Do not filter on this field

    • builder

      @Stability(Experimental) static BucketEvents.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps.Builder builder()
      Returns:
      a BucketEvents.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps.Builder of BucketEvents.AWSAPICallViaCloudTrail.AWSAPICallViaCloudTrailProps