Package software.amazon.awscdk.services.resourceexplorer2

Class CfnView

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.resourceexplorer2.CfnView
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:34.974Z") @Stability(Stable) public class CfnView extends CfnResource implements IInspectable
A CloudFormation AWS::ResourceExplorer2::View.

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 .

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.*;
 CfnView cfnView = CfnView.Builder.create(this, "MyCfnView")
         .viewName("viewName")
         // the properties below are optional
         .filters(FiltersProperty.builder()
                 .filterString("filterString")
                 .build())
         .includedProperties(List.of(IncludedPropertyProperty.builder()
                 .name("name")
                 .build()))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnView

      protected CfnView(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnView

      protected CfnView(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnView

      @Stability(Stable) public CfnView(@NotNull Construct scope, @NotNull String id, @NotNull CfnViewProps props)
      Create a new AWS::ResourceExplorer2::View.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrViewArn

      @Stability(Stable) @NotNull public String getAttrViewArn()
      The ARN of the new view. For example:.

      arn:aws:resource-explorer-2:us-east-1:123456789012:view/MyView/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag key and value pairs that are attached to the view.

    • getViewName

      @Stability(Stable) @NotNull public String getViewName()
      The name of the new view.

    • setViewName

      @Stability(Stable) public void setViewName(@NotNull String value)
      The name of the new view.

    • getFilters

      @Stability(Stable) @Nullable public 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 .

    • setFilters

      @Stability(Stable) public void setFilters(@Nullable CfnView.FiltersProperty value)
      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 .

    • setFilters

      @Stability(Stable) public void setFilters(@Nullable IResolvable value)
      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 .

    • getIncludedProperties

      @Stability(Stable) @Nullable public Object getIncludedProperties()
      A list of fields that provide additional information about the view.

    • setIncludedProperties

      @Stability(Stable) public void setIncludedProperties(@Nullable IResolvable value)
      A list of fields that provide additional information about the view.

    • setIncludedProperties

      @Stability(Stable) public void setIncludedProperties(@Nullable List<Object> value)
      A list of fields that provide additional information about the view.