Package software.amazon.awscdk.services.resourceexplorer2

Interface CfnViewProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnViewProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:22.668Z")
@Stability(Stable)
public interface CfnViewProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.resourceexplorer2.*;
 CfnViewProps cfnViewProps = CfnViewProps.builder()
         .viewName("viewName")
         // the properties below are optional
         .filters(FiltersProperty.builder()
                 .filterString("filterString")
                 .build())
         .includedProperties(List.of(IncludedPropertyProperty.builder()
                 .name("name")
                 .build()))
         .scope("scope")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnViewProps.Builder	builder()
default Object	getFilters()	An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view.
default Object	getIncludedProperties()	A list of fields that provide additional information about the view.
default String	getScope()	The root ARN of the account, an organizational unit (OU), or an organization ARN.
default Map<String,String>	getTags()	Tag key and value pairs that are attached to the view.
String	getViewName()	The name of the new view.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getViewName

@Stability(Stable)
@NotNull
String getViewName()

The name of the new view.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-viewname

getFilters

@Stability(Stable)
@Nullable
default Object getFilters()

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 .

See Also:

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

getIncludedProperties

@Stability(Stable)
@Nullable
default Object getIncludedProperties()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-includedproperties

getScope

@Stability(Stable)
@Nullable
default String getScope()

The root ARN of the account, an organizational unit (OU), or an organization ARN.

If left empty, the default is account.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-scope

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-tags

builder

@Stability(Stable)
static CfnViewProps.Builder builder()

Returns:

a CfnViewProps.Builder of CfnViewProps