Show / Hide Table of Contents

Class CfnView

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 .

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnView
Implements
IInspectable
ITaggable
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.ResourceExplorer2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnView : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnView Inherits CfnResource Implements IInspectable, ITaggable
Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ResourceExplorer2;

             var cfnView = new CfnView(this, "MyCfnView", new CfnViewProps {
                 ViewName = "viewName",

                 // the properties below are optional
                 Filters = new FiltersProperty {
                     FilterString = "filterString"
                 },
                 IncludedProperties = new [] { new IncludedPropertyProperty {
                     Name = "name"
                 } },
                 Scope = "scope",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnView(Construct, string, ICfnViewProps)

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 .

Properties

AttrViewArn

The ARN of the new view. For example:.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties

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 .

Filters

An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view.

IncludedProperties

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

Scope

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

Tags

Tag Manager which manages the tags for this resource.

TagsRaw

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

ViewName

The name of the new view.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<string, object>)

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 .

Constructors

CfnView(Construct, string, ICfnViewProps)

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 .

public CfnView(Construct scope, string id, ICfnViewProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnViewProps

Resource properties.

Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

Properties

AttrViewArn

The ARN of the new view. For example:.

public virtual string AttrViewArn { get; }
Property Value

string

Remarks

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

CloudformationAttribute: ViewArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

CfnProperties

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 .

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

Filters

An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view.

public virtual object? Filters { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

IncludedProperties

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

public virtual object? IncludedProperties { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

Scope

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

public virtual string? Scope { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual IDictionary<string, string>? TagsRaw { get; set; }
Property Value

IDictionary<string, string>

Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

ViewName

The name of the new view.

public virtual string ViewName { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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 .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

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

CloudformationResource: AWS::ResourceExplorer2::View

ExampleMetadata: fixture=_generated

Implements

IInspectable
ITaggable
Back to top Generated by DocFX