Package software.amazon.awscdk.services.resourceexplorer2

Interface CfnView.SearchFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnView.SearchFilterProperty.Jsii$Proxy

Enclosing class:

CfnView

@Stability(Stable)
public static interface CfnView.SearchFilterProperty
extends software.amazon.jsii.JsiiSerializable

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

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.resourceexplorer2.*;
 SearchFilterProperty searchFilterProperty = SearchFilterProperty.builder()
         .filterString("filterString")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-searchfilter.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnView.SearchFilterProperty.Builder	A builder for CfnView.SearchFilterProperty
static final class	CfnView.SearchFilterProperty.Jsii$Proxy	An implementation for CfnView.SearchFilterProperty

Method Summary

Modifier and Type	Method	Description
static CfnView.SearchFilterProperty.Builder	builder()
String	getFilterString()	The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a Search operation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFilterString

@Stability(Stable)
@NotNull
String getFilterString()

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 .

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 Also:

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

builder

@Stability(Stable)
static CfnView.SearchFilterProperty.Builder builder()

Returns:

a CfnView.SearchFilterProperty.Builder of CfnView.SearchFilterProperty