1.204.0

interface CfnViewProps

LanguageType name
.NETAmazon.CDK.AWS.ResourceExplorer2.CfnViewProps
Javasoftware.amazon.awscdk.services.resourceexplorer2.CfnViewProps
Pythonaws_cdk.aws_resourceexplorer2.CfnViewProps
TypeScript @aws-cdk/aws-resourceexplorer2 » CfnViewProps

Properties for defining a CfnView.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as resourceexplorer2 from '@aws-cdk/aws-resourceexplorer2';
const cfnViewProps: resourceexplorer2.CfnViewProps = {
  viewName: 'viewName',

  // the properties below are optional
  filters: {
    filterString: 'filterString',
  },
  includedProperties: [{
    name: 'name',
  }],
  tags: {
    tagsKey: 'tags',
  },
};

Properties

NameTypeDescription
viewNamestringThe name of the new view.
filters?FiltersProperty | IResolvableAn array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view.
includedProperties?IResolvable | IResolvable | IncludedPropertyProperty[]A list of fields that provide additional information about the view.
tags?{ [string]: string }Tag key and value pairs that are attached to the view.

viewName

Type: string

The name of the new view.

filters?

Type: FiltersProperty | IResolvable (optional)

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 logical AND operator.

For information about the supported syntax, see Search query reference for Resource Explorer 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 .

includedProperties?

Type: IResolvable | IResolvable | IncludedPropertyProperty[] (optional)

A list of fields that provide additional information about the view.

tags?

Type: { [string]: string } (optional)

Tag key and value pairs that are attached to the view.

← PreviousNext →