Interface CfnLifecyclePolicy.IEventParametersProperty

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

Namespace: Amazon.CDK.AWS.DLM

Assembly: Amazon.CDK.AWS.DLM.dll

Syntax (csharp)

public interface IEventParametersProperty

Syntax (vb)

Public Interface IEventParametersProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DLM;

var eventParametersProperty = new EventParametersProperty {
    EventType = "eventType",
    SnapshotOwner = new [] { "snapshotOwner" },

    // the properties below are optional
    DescriptionRegex = "descriptionRegex"
};

Synopsis

Properties

DescriptionRegex	The snapshot description that can trigger the policy.
EventType	The type of event.
SnapshotOwner	The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account.

Properties

DescriptionRegex

The snapshot description that can trigger the policy.

virtual string DescriptionRegex { get; }

Property Value

System.String

Remarks

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.

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

EventType

The type of event.

string EventType { get; }

Property Value

System.String

Remarks

Currently, only snapshot sharing events are supported.

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

SnapshotOwner

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

string[] SnapshotOwner { get; }

Property Value

System.String[]

Remarks

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

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