Package software.amazon.awscdk.services.resourceexplorer2

Class CfnView

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.resourceexplorer2.CfnView
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:08.759Z") @Stability(Stable) public class CfnView extends CfnResource implements IInspectable, ITaggable
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()))
         .scope("scope")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnViewProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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 Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • 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.

    • 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.

    • 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.

    • 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.

    • getScope

      @Stability(Stable) @Nullable public String getScope()
      The root ARN of the account, an organizational unit (OU), or an organization ARN.

    • setScope

      @Stability(Stable) public void setScope(@Nullable String value)
      The root ARN of the account, an organizational unit (OU), or an organization ARN.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      Tag key and value pairs that are attached to the view.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      Tag key and value pairs that are attached to the view.