Package software.amazon.awscdk.services.backup

Interface CfnLegalHoldProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLegalHoldProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:50:57.496Z")
@Stability(Stable)
public interface CfnLegalHoldProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLegalHold.

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.backup.*;
 CfnLegalHoldProps cfnLegalHoldProps = CfnLegalHoldProps.builder()
         .description("description")
         .recoveryPointSelection(RecoveryPointSelectionProperty.builder()
                 .dateRange(DateRangeProperty.builder()
                         .fromDate("fromDate")
                         .toDate("toDate")
                         .build())
                 .resourceIdentifiers(List.of("resourceIdentifiers"))
                 .vaultNames(List.of("vaultNames"))
                 .build())
         .title("title")
         // the properties below are optional
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-legalhold.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLegalHoldProps.Builder	builder()
String	getDescription()	The description of the legal hold.
Object	getRecoveryPointSelection()	The criteria to assign a set of resources, such as resource types or backup vaults.
default List<CfnLegalHold.TagsItemsProperty>	getTags()	Optional tags to include.
String	getTitle()	The title of the legal hold.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

The description of the legal hold.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-legalhold.html#cfn-backup-legalhold-description

getRecoveryPointSelection

@Stability(Stable)
@NotNull
Object getRecoveryPointSelection()

The criteria to assign a set of resources, such as resource types or backup vaults.

Returns union: either IResolvable or CfnLegalHold.RecoveryPointSelectionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-legalhold.html#cfn-backup-legalhold-recoverypointselection

getTitle

@Stability(Stable)
@NotNull
String getTitle()

The title of the legal hold.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-legalhold.html#cfn-backup-legalhold-title

getTags

@Stability(Stable)
@Nullable
default List<CfnLegalHold.TagsItemsProperty> getTags()

Optional tags to include.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-legalhold.html#cfn-backup-legalhold-tags

builder

@Stability(Stable)
static CfnLegalHoldProps.Builder builder()

Returns:

a CfnLegalHoldProps.Builder of CfnLegalHoldProps