Package software.amazon.awscdk.services.backupsearch

Class CfnSearchJob

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.backupsearch.CfnSearchJob
All Implemented Interfaces:
IInspectable, ISearchJobRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:50:57.527Z") @Stability(Stable) public class CfnSearchJob extends CfnResource implements IInspectable, ISearchJobRef, ITaggableV2
Definition of AWS::BackupSearch::SearchJob Resource Type.

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.*;
 CfnSearchJob cfnSearchJob = CfnSearchJob.Builder.create(this, "MyCfnSearchJob")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSearchJob

      protected CfnSearchJob(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSearchJob

      protected CfnSearchJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSearchJob

      @Stability(Stable) public CfnSearchJob(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSearchJobProps props)
      Create a new AWS::BackupSearch::SearchJob.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForSearchJob

      @Stability(Stable) @NotNull public static String arnForSearchJob(@NotNull ISearchJobRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnSearchJob

      @Stability(Stable) @NotNull public static Boolean isCfnSearchJob(@NotNull Object x)
      Checks whether the given object is a CfnSearchJob.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The date and time the search job was created.

    • getAttrSearchJobArn

      @Stability(Stable) @NotNull public String getAttrSearchJobArn()
      The Amazon Resource Name (ARN) of the search job.

    • getAttrSearchJobIdentifier

      @Stability(Stable) @NotNull public String getAttrSearchJobIdentifier()
      The unique identifier of the search job.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the search job.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getSearchJobRef

      @Stability(Stable) @NotNull public SearchJobReference getSearchJobRef()
      A reference to a SearchJob resource.
      Specified by:
      getSearchJobRef in interface ISearchJobRef

    • getSearchScope

      @Stability(Stable) @NotNull public Object getSearchScope()
      The search scope for the search job.

      Returns union: either IResolvable or CfnSearchJob.SearchScopeProperty

    • setSearchScope

      @Stability(Stable) public void setSearchScope(@NotNull IResolvable value)
      The search scope for the search job.

    • setSearchScope

      @Stability(Stable) public void setSearchScope(@NotNull CfnSearchJob.SearchScopeProperty value)
      The search scope for the search job.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the search job.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the search job.

    • getTags

      @Stability(Stable) @Nullable public List<CfnSearchJob.TagsItemsProperty> getTags()
      Tags associated with the search job.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnSearchJob.TagsItemsProperty> value)
      Tags associated with the search job.