Package software.amazon.awscdk.services.dlm

Interface CfnLifecyclePolicy.EventParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecyclePolicy.EventParametersProperty.Jsii$Proxy

Enclosing class:

CfnLifecyclePolicy

@Stability(Stable)
public static interface CfnLifecyclePolicy.EventParametersProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dlm.*;
 EventParametersProperty eventParametersProperty = EventParametersProperty.builder()
         .eventType("eventType")
         .snapshotOwner(List.of("snapshotOwner"))
         // the properties below are optional
         .descriptionRegex("descriptionRegex")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLifecyclePolicy.EventParametersProperty.Builder	A builder for CfnLifecyclePolicy.EventParametersProperty
static final class	CfnLifecyclePolicy.EventParametersProperty.Jsii$Proxy	An implementation for CfnLifecyclePolicy.EventParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnLifecyclePolicy.EventParametersProperty.Builder	builder()
default String	getDescriptionRegex()	The snapshot description that can trigger the policy.
String	getEventType()	The type of event.
List<String>	getSnapshotOwner()	The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventType

@Stability(Stable)
@NotNull
String getEventType()

The type of event.

Currently, only snapshot sharing events are supported.

getSnapshotOwner

@Stability(Stable)
@NotNull
List<String> getSnapshotOwner()

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.

getDescriptionRegex

@Stability(Stable)
@Nullable
default String getDescriptionRegex()

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.

builder

@Stability(Stable)
static CfnLifecyclePolicy.EventParametersProperty.Builder builder()

Returns:

a CfnLifecyclePolicy.EventParametersProperty.Builder of CfnLifecyclePolicy.EventParametersProperty