Package software.amazon.awscdk.cfnpropertymixins.services.dlm

Interface CfnLifecyclePolicyPropsMixin.EventParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecyclePolicyPropsMixin.EventParametersProperty.Jsii$Proxy

Enclosing class:

CfnLifecyclePolicyPropsMixin

@Stability(Stable)
public static interface CfnLifecyclePolicyPropsMixin.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.cfnpropertymixins.services.dlm.*;
 EventParametersProperty eventParametersProperty = EventParametersProperty.builder()
         .descriptionRegex("descriptionRegex")
         .eventType("eventType")
         .snapshotOwner(List.of("snapshotOwner"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLifecyclePolicyPropsMixin.EventParametersProperty.Builder	builder()
default String	getDescriptionRegex()	The snapshot description that can trigger the policy.
default String	getEventType()	The type of event.
default 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

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.

See Also:

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

getEventType

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

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

getSnapshotOwner

@Stability(Stable)
@Nullable
default 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.

See Also:

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

builder

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

Returns:

a CfnLifecyclePolicyPropsMixin.EventParametersProperty.Builder of CfnLifecyclePolicyPropsMixin.EventParametersProperty