Class CfnIndex
Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index.
Inherited Members
Namespace: Amazon.CDK.AWS.ResourceExplorer2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIndex : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnIndex
Inherits CfnResource
Implements IInspectable, 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.
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIndex(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnIndex(Construct, String, ICfnIndexProps) |
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 | |
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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnIndex(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIndex(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIndex(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIndex(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnIndex(Construct, String, ICfnIndexProps)
public CfnIndex(Construct scope, string id, ICfnIndexProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnIndexProps
Resource properties.
Properties
AttrArn
The ARN of the new index for the AWS Region . For example:.
public virtual string AttrArn { get; }
Property Value
System.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
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
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
System.Collections.Generic.IDictionary<System.String, System.String>
Type
Specifies the type of the index in this Region.
public virtual string Type { get; set; }
Property Value
System.String
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>