CfnViewProps
- class aws_cdk.aws_resourceexplorer2.CfnViewProps(*, view_name, filters=None, included_properties=None, tags=None)
Bases:
object
Properties for defining a
CfnView
.- Parameters:
view_name (
str
) – The name of the new view.filters (
Union
[FiltersProperty
,Dict
[str
,Any
],IResolvable
,None
]) – An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view. When you use this view in a Search operation, the filter string is combined with the search’sQueryString
parameter using a logicalAND
operator. For information about the supported syntax, see Search query reference for Resource Explorer 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 stringregion:us* service:ec2 -tag:stage=prod
includes all Amazon EC2 resources in any AWS Region that begin with the lettersus
and are not tagged with a keyStage
that has the valueprod
.included_properties (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,IncludedPropertyProperty
,Dict
[str
,Any
]]],None
]) – A list of fields that provide additional information about the view.tags (
Optional
[Mapping
[str
,str
]]) – Tag key and value pairs that are attached to the view.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_resourceexplorer2 as resourceexplorer2 cfn_view_props = resourceexplorer2.CfnViewProps( view_name="viewName", # the properties below are optional filters=resourceexplorer2.CfnView.FiltersProperty( filter_string="filterString" ), included_properties=[resourceexplorer2.CfnView.IncludedPropertyProperty( name="name" )], tags={ "tags_key": "tags" } )
Attributes
- filters
An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view.
When you use this view in a Search operation, the filter string is combined with the search’s
QueryString
parameter using a logicalAND
operator.For information about the supported syntax, see Search query reference for Resource Explorer 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`` .
- included_properties
A list of fields that provide additional information about the view.
- tags
Tag key and value pairs that are attached to the view.
- view_name
The name of the new view.