KeyEvents

class aws_cdk.mixins_preview.aws_kms.events.KeyEvents(*args: Any, **kwargs)

Bases: object

(experimental) EventBridge event patterns for Key.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kms import events as kms_events
from aws_cdk.interfaces import aws_kms as interfaces_kms

# key_ref: interfaces_kms.IKeyRef

key_events = kms_events.KeyEvents.from_key(key_ref)

Methods

aws_api_call_via_cloud_trail_pattern(*, aws_region=None, event_id=None, event_metadata=None, event_name=None, event_source=None, event_time=None, event_type=None, event_version=None, read_only=None, request_id=None, request_parameters=None, resources=None, response_elements=None, source_ip_address=None, user_agent=None, user_identity=None)

(experimental) EventBridge event pattern for Key AWS API Call via CloudTrail.

Parameters:

aws_region (Optional[Sequence[str]]) – (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
event_id (Optional[Sequence[str]]) – (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
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
event_name (Optional[Sequence[str]]) – (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
event_source (Optional[Sequence[str]]) – (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
event_time (Optional[Sequence[str]]) – (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
event_type (Optional[Sequence[str]]) – (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
event_version (Optional[Sequence[str]]) – (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
read_only (Optional[Sequence[str]]) – (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
request_id (Optional[Sequence[str]]) – (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
request_parameters (Union[RequestParameters, Dict[str, Any], None]) – (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
resources (Optional[Sequence[Union[AwsapiCallViaCloudTrailItem, Dict[str, Any]]]]) – (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
response_elements (Optional[Sequence[str]]) – (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
source_ip_address (Optional[Sequence[str]]) – (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
user_agent (Optional[Sequence[str]]) – (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
user_identity (Union[UserIdentity, Dict[str, Any], None]) – (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

Stability:

experimental

Return type:

EventPattern

kms_cmk_deletion_pattern(*, event_metadata=None, key_id=None)

(experimental) EventBridge event pattern for Key KMS CMK Deletion.

Parameters:

event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
key_id (Optional[Sequence[str]]) – (experimental) key-id property. Specify an array of string values to match this event if the actual value of key-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Key reference

Stability:

experimental

Return type:

EventPattern

kms_cmk_rotation_pattern(*, event_metadata=None, key_id=None)

(experimental) EventBridge event pattern for Key KMS CMK Rotation.

Parameters:

event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
key_id (Optional[Sequence[str]]) – (experimental) key-id property. Specify an array of string values to match this event if the actual value of key-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Key reference

Stability:

experimental

Return type:

EventPattern

kms_imported_key_material_expiration_pattern(*, event_metadata=None, key_id=None)

(experimental) EventBridge event pattern for Key KMS Imported Key Material Expiration.

Parameters:

event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
key_id (Optional[Sequence[str]]) – (experimental) key-id property. Specify an array of string values to match this event if the actual value of key-id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Key reference

Stability:

experimental

Return type:

EventPattern

Static Methods

classmethod from_key(key_ref)

(experimental) Create KeyEvents from a Key reference.

Parameters:: key_ref (IKeyRef)
Stability:: experimental
Return type:: KeyEvents