Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. backup
  6. getLegalHold

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

Viewing docs for AWS Cloud Control v1.75.0
published on Monday, Aug 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.backup.getLegalHold

aws-native logo aws-native logo

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

Viewing docs for AWS Cloud Control v1.75.0
published on Monday, Aug 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Creates a legal hold on recovery points (backups). A legal hold prevents backups from being deleted while under hold.

    Using getLegalHold

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLegalHold(args: GetLegalHoldArgs, opts?: InvokeOptions): Promise<GetLegalHoldResult>
function getLegalHoldOutput(args: GetLegalHoldOutputArgs, opts?: InvokeOutputOptions): Output<GetLegalHoldResult>
    def get_legal_hold(arn: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetLegalHoldResult
def get_legal_hold_output(arn: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetLegalHoldResult]
    func LookupLegalHold(ctx *Context, args *LookupLegalHoldArgs, opts ...InvokeOption) (*LookupLegalHoldResult, error)
func LookupLegalHoldOutput(ctx *Context, args *LookupLegalHoldOutputArgs, opts ...InvokeOption) LookupLegalHoldResultOutput

    > Note: This function is named LookupLegalHold in the Go SDK.

    public static class GetLegalHold 
{
    public static Task<GetLegalHoldResult> InvokeAsync(GetLegalHoldArgs args, InvokeOptions? opts = null)
    public static Output<GetLegalHoldResult> Invoke(GetLegalHoldInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetLegalHoldResult> Invoke(GetLegalHoldInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetLegalHoldResult> getLegalHold(GetLegalHoldArgs args, InvokeOptions options)
public static Output<GetLegalHoldResult> getLegalHold(GetLegalHoldArgs args, InvokeOptions options)
public static Output<GetLegalHoldResult> getLegalHold(GetLegalHoldArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:backup:getLegalHold
  arguments:
    # arguments dictionary
    data "aws-native_backup_get_legal_hold" "name" {
    # arguments
}

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the legal hold.
    Arn string
    The Amazon Resource Name (ARN) of the legal hold.
    arn string
    The Amazon Resource Name (ARN) of the legal hold.
    arn String
    The Amazon Resource Name (ARN) of the legal hold.
    arn string
    The Amazon Resource Name (ARN) of the legal hold.
    arn str
    The Amazon Resource Name (ARN) of the legal hold.
    arn String
    The Amazon Resource Name (ARN) of the legal hold.

    getLegalHold Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the legal hold.
    CreationDate string
    The time when the legal hold was created.
    LegalHoldId string
    The ID of the legal hold.
    Status Pulumi.AwsNative.Backup.LegalHoldStatus
    The status of the legal hold.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Optional tags to include.
    Arn string
    The Amazon Resource Name (ARN) of the legal hold.
    CreationDate string
    The time when the legal hold was created.
    LegalHoldId string
    The ID of the legal hold.
    Status LegalHoldStatus
    The status of the legal hold.
    Tags Tag
    Optional tags to include.
    arn string
    The Amazon Resource Name (ARN) of the legal hold.
    creation_date string
    The time when the legal hold was created.
    legal_hold_id string
    The ID of the legal hold.
    status "CREATING" | "ACTIVE" | "CANCELING" | "CANCELED"
    The status of the legal hold.
    tags list(object)
    Optional tags to include.
    arn String
    The Amazon Resource Name (ARN) of the legal hold.
    creationDate String
    The time when the legal hold was created.
    legalHoldId String
    The ID of the legal hold.
    status LegalHoldStatus
    The status of the legal hold.
    tags List<Tag>
    Optional tags to include.
    arn string
    The Amazon Resource Name (ARN) of the legal hold.
    creationDate string
    The time when the legal hold was created.
    legalHoldId string
    The ID of the legal hold.
    status LegalHoldStatus
    The status of the legal hold.
    tags Tag[]
    Optional tags to include.
    arn str
    The Amazon Resource Name (ARN) of the legal hold.
    creation_date str
    The time when the legal hold was created.
    legal_hold_id str
    The ID of the legal hold.
    status LegalHoldStatus
    The status of the legal hold.
    tags Sequence[root_Tag]
    Optional tags to include.
    arn String
    The Amazon Resource Name (ARN) of the legal hold.
    creationDate String
    The time when the legal hold was created.
    legalHoldId String
    The ID of the legal hold.
    status "CREATING" | "ACTIVE" | "CANCELING" | "CANCELED"
    The status of the legal hold.
    tags List<Property Map>
    Optional tags to include.

    Supporting Types

    LegalHoldStatus

    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 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.75.0
    published on Monday, Aug 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial