Class CfnLifecyclePolicy.EventParametersProperty

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

Inheritance
object
CfnLifecyclePolicy.EventParametersProperty
Inherited Members
Namespace: Amazon.CDK.AWS.DLM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLifecyclePolicy.EventParametersProperty : CfnLifecyclePolicy.IEventParametersProperty
Syntax (vb)
Public Class CfnLifecyclePolicy.EventParametersProperty Implements CfnLifecyclePolicy.IEventParametersProperty
Remarks

See: 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

Constructors

EventParametersProperty()

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

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.

Constructors

EventParametersProperty()

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

public EventParametersProperty()
Remarks

See: 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"
             };

Properties

DescriptionRegex

The snapshot description that can trigger the policy.

public string? DescriptionRegex { get; set; }
Property Value

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.

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

EventType

The type of event.

public string EventType { get; set; }
Property Value

string

Remarks

Currently, only snapshot sharing events are supported.

See: 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.

public string[] SnapshotOwner { get; set; }
Property Value

string[]

Remarks

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

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

Implements