AWS::BackupSearch::SearchJob

BackupSearch SearchJob

Definition of AWS::BackupSearch::SearchJob Resource Type

Properties

3 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`SearchScope`	`SearchScope`	RequiredCreate-only
`Name`	`string`	Create-only
`Tags`	`Array<object>`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreationTime`	`string`	The date and time the search job was created.
`SearchJobArn`	`string`	The Amazon Resource Name (ARN) of the search job.
`SearchJobIdentifier`	`string`	The unique identifier of the search job.
`Status`	`string`	The current status of the search job.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::BackupSearch::SearchJob

Resources:
  MyResource:
    Type: AWS::BackupSearch::SearchJob
    Properties:
      SearchScope: "value"
      Tags:
        - Key: Environment
          Value: Production
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

backup-search:GetSearchJobbackup-search:ListTagsForResource

list

backup-search:ListSearchJobs

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceBackupSearch

Properties7

Required1

TaggingSupported

Primary IDSearchJobArn

Supported Operations

ReadList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

NameSearchScopeTags

External Links

AWS Documentation