We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 24, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 24, 2026 by Pulumi
Creates a legal hold on recovery points (backups). A legal hold prevents backups from being deleted while under hold.
Create LegalHold Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LegalHold(name: string, args: LegalHoldArgs, opts?: CustomResourceOptions);@overload
def LegalHold(resource_name: str,
args: LegalHoldArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LegalHold(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
recovery_point_selection: Optional[RecoveryPointSelectionPropertiesArgs] = None,
title: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewLegalHold(ctx *Context, name string, args LegalHoldArgs, opts ...ResourceOption) (*LegalHold, error)public LegalHold(string name, LegalHoldArgs args, CustomResourceOptions? opts = null)
public LegalHold(String name, LegalHoldArgs args)
public LegalHold(String name, LegalHoldArgs args, CustomResourceOptions options)
type: aws-native:backup:LegalHold
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_backup_legal_hold" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args LegalHoldArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args LegalHoldArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args LegalHoldArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LegalHoldArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LegalHoldArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
LegalHold Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LegalHold resource accepts the following input properties:
- Description string
- The description of the legal hold.
- Recovery
Point Pulumi.Selection Aws Native. Backup. Inputs. Recovery Point Selection Properties - The criteria to assign a set of resources, such as resource types or backup vaults.
- Title string
- The title of the legal hold.
-
List<Pulumi.
Aws Native. Inputs. Tag> - Optional tags to include.
- Description string
- The description of the legal hold.
- Recovery
Point RecoverySelection Point Selection Properties Args - The criteria to assign a set of resources, such as resource types or backup vaults.
- Title string
- The title of the legal hold.
-
Tag
Args - Optional tags to include.
- description string
- The description of the legal hold.
- recovery_
point_ objectselection - The criteria to assign a set of resources, such as resource types or backup vaults.
- title string
- The title of the legal hold.
- list(object)
- Optional tags to include.
- description String
- The description of the legal hold.
- recovery
Point RecoverySelection Point Selection Properties - The criteria to assign a set of resources, such as resource types or backup vaults.
- title String
- The title of the legal hold.
- List<Tag>
- Optional tags to include.
- description string
- The description of the legal hold.
- recovery
Point RecoverySelection Point Selection Properties - The criteria to assign a set of resources, such as resource types or backup vaults.
- title string
- The title of the legal hold.
- Tag[]
- Optional tags to include.
- description str
- The description of the legal hold.
- recovery_
point_ Recoveryselection Point Selection Properties Args - The criteria to assign a set of resources, such as resource types or backup vaults.
- title str
- The title of the legal hold.
-
Sequence[Tag
Args] - Optional tags to include.
- description String
- The description of the legal hold.
- recovery
Point Property MapSelection - The criteria to assign a set of resources, such as resource types or backup vaults.
- title String
- The title of the legal hold.
- List<Property Map>
- Optional tags to include.
Outputs
All input properties are implicitly available as output properties. Additionally, the LegalHold resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the legal hold.
- Creation
Date string - The time when the legal hold was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Legal
Hold stringId - The ID of the legal hold.
- Status
Pulumi.
Aws Native. Backup. Legal Hold Status - The status of the legal hold.
- Arn string
- The Amazon Resource Name (ARN) of the legal hold.
- Creation
Date string - The time when the legal hold was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Legal
Hold stringId - The ID of the legal hold.
- Status
Legal
Hold Status - The status of the legal hold.
- arn string
- The Amazon Resource Name (ARN) of the legal hold.
- creation_
date string - The time when the legal hold was created.
- id string
- The provider-assigned unique ID for this managed resource.
- legal_
hold_ stringid - The ID of the legal hold.
- status "CREATING" | "ACTIVE" | "CANCELING" | "CANCELED"
- The status of the legal hold.
- arn String
- The Amazon Resource Name (ARN) of the legal hold.
- creation
Date String - The time when the legal hold was created.
- id String
- The provider-assigned unique ID for this managed resource.
- legal
Hold StringId - The ID of the legal hold.
- status
Legal
Hold Status - The status of the legal hold.
- arn string
- The Amazon Resource Name (ARN) of the legal hold.
- creation
Date string - The time when the legal hold was created.
- id string
- The provider-assigned unique ID for this managed resource.
- legal
Hold stringId - The ID of the legal hold.
- status
Legal
Hold Status - The status of the legal hold.
- arn str
- The Amazon Resource Name (ARN) of the legal hold.
- creation_
date str - The time when the legal hold was created.
- id str
- The provider-assigned unique ID for this managed resource.
- legal_
hold_ strid - The ID of the legal hold.
- status
Legal
Hold Status - The status of the legal hold.
- arn String
- The Amazon Resource Name (ARN) of the legal hold.
- creation
Date String - The time when the legal hold was created.
- id String
- The provider-assigned unique ID for this managed resource.
- legal
Hold StringId - The ID of the legal hold.
- status "CREATING" | "ACTIVE" | "CANCELING" | "CANCELED"
- The status of the legal hold.
Supporting Types
LegalHoldStatus, LegalHoldStatusArgs
- Creating
CREATING- Active
ACTIVE- Canceling
CANCELING- Canceled
CANCELED
- Legal
Hold Status Creating CREATING- Legal
Hold Status Active ACTIVE- Legal
Hold Status Canceling CANCELING- Legal
Hold Status Canceled CANCELED
- "CREATING"
CREATING- "ACTIVE"
ACTIVE- "CANCELING"
CANCELING- "CANCELED"
CANCELED
- Creating
CREATING- Active
ACTIVE- Canceling
CANCELING- Canceled
CANCELED
- Creating
CREATING- Active
ACTIVE- Canceling
CANCELING- Canceled
CANCELED
- CREATING
CREATING- ACTIVE
ACTIVE- CANCELING
CANCELING- CANCELED
CANCELED
- "CREATING"
CREATING- "ACTIVE"
ACTIVE- "CANCELING"
CANCELING- "CANCELED"
CANCELED
RecoveryPointSelectionProperties, RecoveryPointSelectionPropertiesArgs
The criteria to assign a set of resources, such as resource types or backup vaults.- Date
Range Pulumi.Aws Native. Backup. Inputs. Recovery Point Selection Properties Date Range Properties - A date range for filtering recovery points.
- Resource
Identifiers List<string> - The resources included in the resource selection.
- Vault
Names List<string> - The names of the vaults in which the selected recovery points are contained.
- Date
Range RecoveryPoint Selection Properties Date Range Properties - A date range for filtering recovery points.
- Resource
Identifiers []string - The resources included in the resource selection.
- Vault
Names []string - The names of the vaults in which the selected recovery points are contained.
- date_
range object - A date range for filtering recovery points.
- resource_
identifiers list(string) - The resources included in the resource selection.
- vault_
names list(string) - The names of the vaults in which the selected recovery points are contained.
- date
Range RecoveryPoint Selection Properties Date Range Properties - A date range for filtering recovery points.
- resource
Identifiers List<String> - The resources included in the resource selection.
- vault
Names List<String> - The names of the vaults in which the selected recovery points are contained.
- date
Range RecoveryPoint Selection Properties Date Range Properties - A date range for filtering recovery points.
- resource
Identifiers string[] - The resources included in the resource selection.
- vault
Names string[] - The names of the vaults in which the selected recovery points are contained.
- date_
range RecoveryPoint Selection Properties Date Range Properties - A date range for filtering recovery points.
- resource_
identifiers Sequence[str] - The resources included in the resource selection.
- vault_
names Sequence[str] - The names of the vaults in which the selected recovery points are contained.
- date
Range Property Map - A date range for filtering recovery points.
- resource
Identifiers List<String> - The resources included in the resource selection.
- vault
Names List<String> - The names of the vaults in which the selected recovery points are contained.
RecoveryPointSelectionPropertiesDateRangeProperties, RecoveryPointSelectionPropertiesDateRangePropertiesArgs
A date range for filtering recovery points.Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 24, 2026 by Pulumi