Class LegalHold
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LegalHold.Builder,
LegalHold>
A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LegalHold.Builder
builder()
final Instant
This is the time in number format when legal hold was cancelled.final Instant
This is the time in number format when legal hold was created.final String
This is the description of a legal hold.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.final String
ID of specific legal hold on one or more recovery points.static Class
<? extends LegalHold.Builder> final LegalHoldStatus
status()
This is the status of the legal hold.final String
This is the status of the legal hold.final String
title()
This is the title of a legal hold.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
title
This is the title of a legal hold.
- Returns:
- This is the title of a legal hold.
-
status
This is the status of the legal hold. Statuses can be
ACTIVE
,CREATING
,CANCELED
, andCANCELING
.If the service returns an enum value that is not available in the current SDK version,
status
will returnLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- This is the status of the legal hold. Statuses can be
ACTIVE
,CREATING
,CANCELED
, andCANCELING
. - See Also:
-
statusAsString
This is the status of the legal hold. Statuses can be
ACTIVE
,CREATING
,CANCELED
, andCANCELING
.If the service returns an enum value that is not available in the current SDK version,
status
will returnLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- This is the status of the legal hold. Statuses can be
ACTIVE
,CREATING
,CANCELED
, andCANCELING
. - See Also:
-
description
This is the description of a legal hold.
- Returns:
- This is the description of a legal hold.
-
legalHoldId
ID of specific legal hold on one or more recovery points.
- Returns:
- ID of specific legal hold on one or more recovery points.
-
legalHoldArn
This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.- Returns:
- This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
-
creationDate
This is the time in number format when legal hold was created.
- Returns:
- This is the time in number format when legal hold was created.
-
cancellationDate
This is the time in number format when legal hold was cancelled.
- Returns:
- This is the time in number format when legal hold was cancelled.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<LegalHold.Builder,
LegalHold> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-