Class CfnIndexPropsMixin

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

Inheritance

object

Mixin

CfnIndexPropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.Mixins.Preview.AWS.ResourceExplorer2.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnIndexPropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnIndexPropsMixin Inherits Mixin Implements IMixin

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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ResourceExplorer2.Mixins;

             var cfnIndexPropsMixin = new CfnIndexPropsMixin(new CfnIndexMixinProps {
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Synopsis

Constructors

CfnIndexPropsMixin(ICfnIndexMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::ResourceExplorer2::Index.

Properties

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

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnIndexPropsMixin(ICfnIndexMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::ResourceExplorer2::Index.

public CfnIndexPropsMixin(ICfnIndexMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnIndexMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

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

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

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

protected static string[] CFN_PROPERTY_KEYS { 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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ResourceExplorer2.Mixins;

             var cfnIndexPropsMixin = new CfnIndexPropsMixin(new CfnIndexMixinProps {
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Props

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

protected virtual ICfnIndexMixinProps Props { get; }

Property Value

ICfnIndexMixinProps

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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ResourceExplorer2.Mixins;

             var cfnIndexPropsMixin = new CfnIndexPropsMixin(new CfnIndexMixinProps {
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Strategy

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

protected virtual PropertyMergeStrategy Strategy { get; }

Property Value

PropertyMergeStrategy

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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ResourceExplorer2.Mixins;

             var cfnIndexPropsMixin = new CfnIndexPropsMixin(new CfnIndexMixinProps {
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override IConstruct ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Returns

IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

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

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

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

Mixin: true

ExampleMetadata: fixture=_generated

Implements

IMixin