Class CfnIndex

Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnIndex
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.ResourceExplorer2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIndex : CfnResource, IInspectable, IIndexRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnIndex Inherits CfnResource Implements IInspectable, IIndexRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

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 cfnIndex = new CfnIndex(this, "MyCfnIndex", new CfnIndexProps {
                 Type = "type",

                 // the properties below are optional
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnIndex(Construct, string, ICfnIndexProps)

Create a new AWS::ResourceExplorer2::Index.

Properties

AttrArn

The ARN of the new index for the AWS Region . For example:.
AttrIndexState

Indicates the current state of the index. For example:.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index.
IndexRef

A reference to a Index resource.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

The specified tags are attached to only the index created in this AWS Region .
Type

Specifies the type of the index in this Region.

Methods

ArnForIndex(IIndexRef)

Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnIndex(object)

Checks whether the given object is a CfnIndex.
RenderProperties(IDictionary<string, object>)

Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index.

Constructors

CfnIndex(Construct, string, ICfnIndexProps)

Create a new AWS::ResourceExplorer2::Index.

public CfnIndex(Construct scope, string id, ICfnIndexProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnIndexProps

Resource properties.

Remarks

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN of the new index for the AWS Region . For example:.

public virtual string AttrArn { get; }
Property Value

string

Remarks

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

CloudformationAttribute: Arn

AttrIndexState

Indicates the current state of the index. For example:.

public virtual string AttrIndexState { get; }
Property Value

string

Remarks

CREATING

CloudformationAttribute: IndexState

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

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

ExampleMetadata: fixture=_generated

CfnProperties

Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index.

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

IDictionary<string, object>

Overrides
Remarks

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

ExampleMetadata: fixture=_generated

IndexRef

A reference to a Index resource.

public virtual IIndexReference IndexRef { get; }
Property Value

IIndexReference

Remarks

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

ExampleMetadata: fixture=_generated

TagsRaw

The specified tags are attached to only the index created in this AWS Region .

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

IDictionary<string, string>

Remarks

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

ExampleMetadata: fixture=_generated

Type

Specifies the type of the index in this Region.

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

string

Remarks

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

ExampleMetadata: fixture=_generated

Methods

ArnForIndex(IIndexRef)

Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index.

public static string ArnForIndex(IIndexRef resource)
Parameters
resource IIndexRef
Returns

string

Remarks

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

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 cfnIndex = new CfnIndex(this, "MyCfnIndex", new CfnIndexProps {
                 Type = "type",

                 // the properties below are optional
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

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

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

ExampleMetadata: fixture=_generated

IsCfnIndex(object)

Checks whether the given object is a CfnIndex.

public static bool IsCfnIndex(object x)
Parameters
x object
Returns

bool

Remarks

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index.

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

IDictionary<string, object>

Overrides
Remarks

Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .

For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.

If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.

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

CloudformationResource: AWS::ResourceExplorer2::Index

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable