aws-cdk-lib.aws_dlm.CfnLifecyclePolicy.EventParametersProperty

EventParametersProperty Struct

[Event-based policies only] Specifies an event that activates an event-based policy.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dlm as dlm } from 'aws-cdk-lib';
const eventParametersProperty: dlm.CfnLifecyclePolicy.EventParametersProperty = {
  eventType: 'eventType',
  snapshotOwner: ['snapshotOwner'],

  // the properties below are optional
  descriptionRegex: 'descriptionRegex',
};

Properties

descriptionRegex?optionalstringdescription_regex?optionalstrdescriptionRegex?optionalStringDescriptionRegex?optionalstringDescriptionRegex?optional*string#

The snapshot description that can trigger the policy.

notes

The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.

For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.

eventTypestringevent_typestreventTypeStringEventTypestringEventType*stringrequired#

The type of event.

Currently, only snapshot sharing events are supported.

snapshotOwnerstring[]snapshot_ownertyping.List[str]snapshotOwnerList<String>SnapshotOwnerstring[]SnapshotOwner*[]*stringrequired#

The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account.

The policy only runs if one of the specified AWS accounts shares a snapshot with your account.