interface EventParametersProperty

Language	Type name
.NET	Amazon.CDK.AWS.DLM.CfnLifecyclePolicy.EventParametersProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdlm#CfnLifecyclePolicy_EventParametersProperty
Java	software.amazon.awscdk.services.dlm.CfnLifecyclePolicy.EventParametersProperty
Python	aws_cdk.aws_dlm.CfnLifecyclePolicy.EventParametersProperty
TypeScript	aws-cdk-lib » aws_dlm » CfnLifecyclePolicy » EventParametersProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html

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

Name	Type	Description
eventType	string	The type of event.
snapshotOwner	string[]	The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account.
descriptionRegex?	string	The snapshot description that can trigger the policy.

---

eventType

Type: string

The type of event.

Currently, only snapshot sharing events are supported.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html#cfn-dlm-lifecyclepolicy-eventparameters-eventtype

---

snapshotOwner

Type: string[]

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html#cfn-dlm-lifecyclepolicy-eventparameters-snapshotowner

---

descriptionRegex?

Type: string (optional)

The snapshot description that can trigger the policy.

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html#cfn-dlm-lifecyclepolicy-eventparameters-descriptionregex