1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. backup
  6. LegalHold

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.76.0
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.
    RecoveryPointSelection Pulumi.AwsNative.Backup.Inputs.RecoveryPointSelectionProperties
    The criteria to assign a set of resources, such as resource types or backup vaults.
    Title string
    The title of the legal hold.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Optional tags to include.
    Description string
    The description of the legal hold.
    RecoveryPointSelection RecoveryPointSelectionPropertiesArgs
    The criteria to assign a set of resources, such as resource types or backup vaults.
    Title string
    The title of the legal hold.
    Tags TagArgs
    Optional tags to include.
    description string
    The description of the legal hold.
    recovery_point_selection object
    The criteria to assign a set of resources, such as resource types or backup vaults.
    title string
    The title of the legal hold.
    tags list(object)
    Optional tags to include.
    description String
    The description of the legal hold.
    recoveryPointSelection RecoveryPointSelectionProperties
    The criteria to assign a set of resources, such as resource types or backup vaults.
    title String
    The title of the legal hold.
    tags List<Tag>
    Optional tags to include.
    description string
    The description of the legal hold.
    recoveryPointSelection RecoveryPointSelectionProperties
    The criteria to assign a set of resources, such as resource types or backup vaults.
    title string
    The title of the legal hold.
    tags Tag[]
    Optional tags to include.
    description str
    The description of the legal hold.
    recovery_point_selection RecoveryPointSelectionPropertiesArgs
    The criteria to assign a set of resources, such as resource types or backup vaults.
    title str
    The title of the legal hold.
    tags Sequence[TagArgs]
    Optional tags to include.
    description String
    The description of the legal hold.
    recoveryPointSelection Property Map
    The criteria to assign a set of resources, such as resource types or backup vaults.
    title String
    The title of the legal hold.
    tags 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.
    CreationDate string
    The time when the legal hold was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LegalHoldId string
    The ID of the legal hold.
    Status Pulumi.AwsNative.Backup.LegalHoldStatus
    The status of the legal hold.
    Arn string
    The Amazon Resource Name (ARN) of the legal hold.
    CreationDate string
    The time when the legal hold was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LegalHoldId string
    The ID of the legal hold.
    Status LegalHoldStatus
    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_id string
    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.
    creationDate String
    The time when the legal hold was created.
    id String
    The provider-assigned unique ID for this managed resource.
    legalHoldId String
    The ID of the legal hold.
    status LegalHoldStatus
    The status of the legal hold.
    arn string
    The Amazon Resource Name (ARN) of the legal hold.
    creationDate string
    The time when the legal hold was created.
    id string
    The provider-assigned unique ID for this managed resource.
    legalHoldId string
    The ID of the legal hold.
    status LegalHoldStatus
    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_id str
    The ID of the legal hold.
    status LegalHoldStatus
    The status of the legal hold.
    arn String
    The Amazon Resource Name (ARN) of the legal hold.
    creationDate String
    The time when the legal hold was created.
    id String
    The provider-assigned unique ID for this managed resource.
    legalHoldId String
    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
    LegalHoldStatusCreating
    CREATING
    LegalHoldStatusActive
    ACTIVE
    LegalHoldStatusCanceling
    CANCELING
    LegalHoldStatusCanceled
    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.
    DateRange Pulumi.AwsNative.Backup.Inputs.RecoveryPointSelectionPropertiesDateRangeProperties
    A date range for filtering recovery points.
    ResourceIdentifiers List<string>
    The resources included in the resource selection.
    VaultNames List<string>
    The names of the vaults in which the selected recovery points are contained.
    DateRange RecoveryPointSelectionPropertiesDateRangeProperties
    A date range for filtering recovery points.
    ResourceIdentifiers []string
    The resources included in the resource selection.
    VaultNames []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.
    dateRange RecoveryPointSelectionPropertiesDateRangeProperties
    A date range for filtering recovery points.
    resourceIdentifiers List<String>
    The resources included in the resource selection.
    vaultNames List<String>
    The names of the vaults in which the selected recovery points are contained.
    dateRange RecoveryPointSelectionPropertiesDateRangeProperties
    A date range for filtering recovery points.
    resourceIdentifiers string[]
    The resources included in the resource selection.
    vaultNames string[]
    The names of the vaults in which the selected recovery points are contained.
    date_range RecoveryPointSelectionPropertiesDateRangeProperties
    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.
    dateRange Property Map
    A date range for filtering recovery points.
    resourceIdentifiers List<String>
    The resources included in the resource selection.
    vaultNames List<String>
    The names of the vaults in which the selected recovery points are contained.

    RecoveryPointSelectionPropertiesDateRangeProperties, RecoveryPointSelectionPropertiesDateRangePropertiesArgs

    A date range for filtering recovery points.
    FromDate string
    The beginning date, inclusive. ISO 8601 date-time.
    ToDate string
    The end date, inclusive. ISO 8601 date-time.
    FromDate string
    The beginning date, inclusive. ISO 8601 date-time.
    ToDate string
    The end date, inclusive. ISO 8601 date-time.
    from_date string
    The beginning date, inclusive. ISO 8601 date-time.
    to_date string
    The end date, inclusive. ISO 8601 date-time.
    fromDate String
    The beginning date, inclusive. ISO 8601 date-time.
    toDate String
    The end date, inclusive. ISO 8601 date-time.
    fromDate string
    The beginning date, inclusive. ISO 8601 date-time.
    toDate string
    The end date, inclusive. ISO 8601 date-time.
    from_date str
    The beginning date, inclusive. ISO 8601 date-time.
    to_date str
    The end date, inclusive. ISO 8601 date-time.
    fromDate String
    The beginning date, inclusive. ISO 8601 date-time.
    toDate String
    The end date, inclusive. ISO 8601 date-time.

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.76.0
    published on Monday, Aug 24, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial