CfnSearchJobProps

class aws_cdk.aws_backupsearch.CfnSearchJobProps(*, search_scope, name=None, tags=None)

Bases: object

Properties for defining a CfnSearchJob.

Parameters:
  • search_scope (Union[IResolvable, SearchScopeProperty, Dict[str, Any]]) – The search scope for the search job.

  • name (Optional[str]) – The name of the search job.

  • tags (Optional[Sequence[Union[TagsItemsProperty, Dict[str, Any]]]]) – Tags associated with the search job.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_backupsearch as backupsearch

cfn_search_job_props = backupsearch.CfnSearchJobProps(
    search_scope=backupsearch.CfnSearchJob.SearchScopeProperty(
        backup_resource_types=["backupResourceTypes"]
    ),

    # the properties below are optional
    name="name",
    tags=[backupsearch.CfnSearchJob.TagsItemsProperty(
        key="key",
        value="value"
    )]
)

Attributes

name

The name of the search job.

See:

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

search_scope

The search scope for the search job.

See:

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

tags

Tags associated with the search job.

See:

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