CfnSearchJobPropsMixin

class aws_cdk.cfn_property_mixins.aws_backupsearch.CfnSearchJobPropsMixin(props, *, strategy=None)

Bases: Mixin

Definition of AWS::BackupSearch::SearchJob Resource Type.

See:

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

CloudformationResource:

AWS::BackupSearch::SearchJob

Mixin:

true

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.cfn_property_mixins import aws_backupsearch as backupsearch
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_search_job_props_mixin = backupsearch.CfnSearchJobPropsMixin(backupsearch.CfnSearchJobMixinProps(
    name="name",
    search_scope=backupsearch.CfnSearchJobPropsMixin.SearchScopeProperty(
        backup_resource_types=["backupResourceTypes"]
    ),
    tags=[backupsearch.CfnSearchJobPropsMixin.TagsItemsProperty(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::BackupSearch::SearchJob.

Parameters:
  • props (Union[CfnSearchJobMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['name', 'searchScope', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

SearchScopeProperty

class CfnSearchJobPropsMixin.SearchScopeProperty(*, backup_resource_types=None)

Bases: object

The search scope for the search job.

Parameters:

backup_resource_types (Optional[Sequence[str]]) – The resource types included in a search.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backupsearch-searchjob-searchscope.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.cfn_property_mixins import aws_backupsearch as backupsearch

search_scope_property = backupsearch.CfnSearchJobPropsMixin.SearchScopeProperty(
    backup_resource_types=["backupResourceTypes"]
)

Attributes

backup_resource_types

The resource types included in a search.

See:

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

TagsItemsProperty

class CfnSearchJobPropsMixin.TagsItemsProperty(*, key=None, value=None)

Bases: object

Parameters:
  • key (Optional[str])

  • value (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backupsearch-searchjob-tagsitems.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.cfn_property_mixins import aws_backupsearch as backupsearch

tags_items_property = backupsearch.CfnSearchJobPropsMixin.TagsItemsProperty(
    key="key",
    value="value"
)

Attributes

key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backupsearch-searchjob-tagsitems.html#cfn-backupsearch-searchjob-tagsitems-key

Type:

see

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backupsearch-searchjob-tagsitems.html#cfn-backupsearch-searchjob-tagsitems-value

Type:

see