CfnViewPropsMixin

class aws_cdk.mixins_preview.aws_resourceexplorer2.mixins.CfnViewPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view’s Filters .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html
CloudformationResource:: AWS::ResourceExplorer2::View
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_resourceexplorer2 import mixins as resourceexplorer2_mixins

cfn_view_props_mixin = resourceexplorer2_mixins.CfnViewPropsMixin(resourceexplorer2_mixins.CfnViewMixinProps(
    filters=resourceexplorer2_mixins.CfnViewPropsMixin.FiltersProperty(
        filter_string="filterString"
    ),
    included_properties=[resourceexplorer2_mixins.CfnViewPropsMixin.IncludedPropertyProperty(
        name="name"
    )],
    scope="scope",
    tags={
        "tags_key": "tags"
    },
    view_name="viewName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ResourceExplorer2::View.

Parameters:

props (Union[CfnViewMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['filters', 'includedProperties', 'scope', 'tags', 'viewName']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

FiltersProperty

class CfnViewPropsMixin.FiltersProperty(*, filter_string=None)

Bases: object

Parameters:: filter_string (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-filters.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.mixins_preview.aws_resourceexplorer2 import mixins as resourceexplorer2_mixins

filters_property = resourceexplorer2_mixins.CfnViewPropsMixin.FiltersProperty(
    filter_string="filterString"
)

Attributes

filter_string

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-filters.html#cfn-resourceexplorer2-view-filters-filterstring

Type:: see

IncludedPropertyProperty

class CfnViewPropsMixin.IncludedPropertyProperty(*, name=None)

Bases: object

Information about an additional property that describes a resource, that you can optionally include in a view.

Parameters:: name (Optional[str]) – The name of the property that is included in this view.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-includedproperty.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.mixins_preview.aws_resourceexplorer2 import mixins as resourceexplorer2_mixins

included_property_property = resourceexplorer2_mixins.CfnViewPropsMixin.IncludedPropertyProperty(
    name="name"
)

Attributes

name

The name of the property that is included in this view.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-includedproperty.html#cfn-resourceexplorer2-view-includedproperty-name

SearchFilterProperty

class CfnViewPropsMixin.SearchFilterProperty(*, filter_string=None)

Bases: object

A search filter defines which resources can be part of a search query result set.

Parameters:: filter_string (Optional[str]) – The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a Search operation. For information about the supported syntax, see Search query reference in the AWS Resource Explorer User Guide . .. epigraph:: This query string in the context of this operation supports only filter prefixes with optional operators . It doesn’t support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any AWS Region that begin with the letters us and are not tagged with a key Stage that has the value prod .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-searchfilter.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.mixins_preview.aws_resourceexplorer2 import mixins as resourceexplorer2_mixins

search_filter_property = resourceexplorer2_mixins.CfnViewPropsMixin.SearchFilterProperty(
    filter_string="filterString"
)

Attributes

filter_string

The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a Search operation.

For information about the supported syntax, see Search query reference in the AWS Resource Explorer User Guide . .. epigraph:

This query string in the context of this operation supports only `filter prefixes <https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters>`_ with optional `operators <https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators>`_ . It doesn't support free-form text. For example, the string ``region:us* service:ec2 -tag:stage=prod`` includes all Amazon EC2 resources in any AWS Region that begin with the letters ``us`` and are *not* tagged with a key ``Stage`` that has the value ``prod`` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-searchfilter.html#cfn-resourceexplorer2-view-searchfilter-filterstring