Package software.amazon.awscdk.services.backupsearch

Interface CfnSearchJobProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSearchJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:50:57.529Z")
@Stability(Stable)
public interface CfnSearchJobProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSearchJob.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.backupsearch.*;
 CfnSearchJobProps cfnSearchJobProps = CfnSearchJobProps.builder()
         .searchScope(SearchScopeProperty.builder()
                 .backupResourceTypes(List.of("backupResourceTypes"))
                 .build())
         // the properties below are optional
         .name("name")
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupsearch-searchjob.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSearchJobProps.Builder	A builder for CfnSearchJobProps
static final class	CfnSearchJobProps.Jsii$Proxy	An implementation for CfnSearchJobProps

Method Summary

Modifier and Type	Method	Description
static CfnSearchJobProps.Builder	builder()
default String	getName()	The name of the search job.
Object	getSearchScope()	The search scope for the search job.
default List<CfnSearchJob.TagsItemsProperty>	getTags()	Tags associated with the search job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSearchScope

@Stability(Stable)
@NotNull
Object getSearchScope()

The search scope for the search job.

Returns union: either IResolvable or CfnSearchJob.SearchScopeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupsearch-searchjob.html#cfn-backupsearch-searchjob-searchscope

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the search job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupsearch-searchjob.html#cfn-backupsearch-searchjob-name

getTags

@Stability(Stable)
@Nullable
default List<CfnSearchJob.TagsItemsProperty> getTags()

Tags associated with the search job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupsearch-searchjob.html#cfn-backupsearch-searchjob-tags

builder

@Stability(Stable)
static CfnSearchJobProps.Builder builder()

Returns:

a CfnSearchJobProps.Builder of CfnSearchJobProps