Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. resourceexplorer2
  5. Index

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.resourceexplorer2.Index

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::ResourceExplorer2::Index Resource Type

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var sampleIndex = new AwsNative.ResourceExplorer2.Index("sampleIndex", new()
    {
        Type = AwsNative.ResourceExplorer2.IndexType.Aggregator,
        Tags = 
        {
            { "purpose", "ResourceExplorer Sample Stack" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/resourceexplorer2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourceexplorer2.NewIndex(ctx, "sampleIndex", &resourceexplorer2.IndexArgs{
			Type: resourceexplorer2.IndexTypeAggregator,
			Tags: pulumi.StringMap{
				"purpose": pulumi.String("ResourceExplorer Sample Stack"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

sample_index = aws_native.resourceexplorer2.Index("sampleIndex",
    type=aws_native.resourceexplorer2.IndexType.AGGREGATOR,
    tags={
        "purpose": "ResourceExplorer Sample Stack",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const sampleIndex = new aws_native.resourceexplorer2.Index("sampleIndex", {
    type: aws_native.resourceexplorer2.IndexType.Aggregator,
    tags: {
        purpose: "ResourceExplorer Sample Stack",
    },
});

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var sampleIndex = new AwsNative.ResourceExplorer2.Index("sampleIndex", new()
    {
        Type = AwsNative.ResourceExplorer2.IndexType.Aggregator,
        Tags = 
        {
            { "purpose", "ResourceExplorer Sample Stack" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/resourceexplorer2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourceexplorer2.NewIndex(ctx, "sampleIndex", &resourceexplorer2.IndexArgs{
			Type: resourceexplorer2.IndexTypeAggregator,
			Tags: pulumi.StringMap{
				"purpose": pulumi.String("ResourceExplorer Sample Stack"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

sample_index = aws_native.resourceexplorer2.Index("sampleIndex",
    type=aws_native.resourceexplorer2.IndexType.AGGREGATOR,
    tags={
        "purpose": "ResourceExplorer Sample Stack",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const sampleIndex = new aws_native.resourceexplorer2.Index("sampleIndex", {
    type: aws_native.resourceexplorer2.IndexType.Aggregator,
    tags: {
        purpose: "ResourceExplorer Sample Stack",
    },
});

    Coming soon!

    Create Index Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Index(name: string, args: IndexArgs, opts?: CustomResourceOptions);
    @overload
def Index(resource_name: str,
          args: IndexArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Index(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          type: Optional[IndexType] = None,
          tags: Optional[Mapping[str, str]] = None)
    func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)
    public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)
    public Index(String name, IndexArgs args)
public Index(String name, IndexArgs args, CustomResourceOptions options)

    type: aws-native:resourceexplorer2:Index
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Index Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Index resource accepts the following input properties:

    Type Pulumi.AwsNative.ResourceExplorer2.IndexType
    Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index in the AWS Resource Explorer User Guide. .
    Tags Dictionary<string, string>
    The specified tags are attached to only the index created in this AWS Region . The tags don't attach to any of the resources listed in the index.
    Type IndexType
    Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index in the AWS Resource Explorer User Guide. .
    Tags map[string]string
    The specified tags are attached to only the index created in this AWS Region . The tags don't attach to any of the resources listed in the index.
    type IndexType
    Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index in the AWS Resource Explorer User Guide. .
    tags Map<String,String>
    The specified tags are attached to only the index created in this AWS Region . The tags don't attach to any of the resources listed in the index.
    type IndexType
    Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index in the AWS Resource Explorer User Guide. .
    tags {[key: string]: string}
    The specified tags are attached to only the index created in this AWS Region . The tags don't attach to any of the resources listed in the index.
    type IndexType
    Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index in the AWS Resource Explorer User Guide. .
    tags Mapping[str, str]
    The specified tags are attached to only the index created in this AWS Region . The tags don't attach to any of the resources listed in the index.
    type "LOCAL" | "AGGREGATOR"
    Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index in the AWS Resource Explorer User Guide. .
    tags Map<String>
    The specified tags are attached to only the index created in this AWS Region . The tags don't attach to any of the resources listed in the index.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Index resource produces the following output properties:

    Arn string

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

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IndexState Pulumi.AwsNative.ResourceExplorer2.IndexState

    Indicates the current state of the index. For example:

    CREATING

    Arn string

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

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IndexState IndexStateEnum

    Indicates the current state of the index. For example:

    CREATING

    arn String

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

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

    id String
    The provider-assigned unique ID for this managed resource.
    indexState IndexState

    Indicates the current state of the index. For example:

    CREATING

    arn string

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

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

    id string
    The provider-assigned unique ID for this managed resource.
    indexState IndexState

    Indicates the current state of the index. For example:

    CREATING

    arn str

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

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

    id str
    The provider-assigned unique ID for this managed resource.
    index_state IndexState

    Indicates the current state of the index. For example:

    CREATING

    arn String

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

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

    id String
    The provider-assigned unique ID for this managed resource.
    indexState "ACTIVE" | "CREATING" | "DELETING" | "DELETED" | "UPDATING"

    Indicates the current state of the index. For example:

    CREATING

    Supporting Types

    IndexState, IndexStateArgs

    Active
    ACTIVE
    Creating
    CREATING
    Deleting
    DELETING
    Deleted
    DELETED
    Updating
    UPDATING
    IndexStateActive
    ACTIVE
    IndexStateCreating
    CREATING
    IndexStateDeleting
    DELETING
    IndexStateDeleted
    DELETED
    IndexStateUpdating
    UPDATING
    Active
    ACTIVE
    Creating
    CREATING
    Deleting
    DELETING
    Deleted
    DELETED
    Updating
    UPDATING
    Active
    ACTIVE
    Creating
    CREATING
    Deleting
    DELETING
    Deleted
    DELETED
    Updating
    UPDATING
    ACTIVE
    ACTIVE
    CREATING
    CREATING
    DELETING
    DELETING
    DELETED
    DELETED
    UPDATING
    UPDATING
    "ACTIVE"
    ACTIVE
    "CREATING"
    CREATING
    "DELETING"
    DELETING
    "DELETED"
    DELETED
    "UPDATING"
    UPDATING

    IndexType, IndexTypeArgs

    Local
    LOCAL
    Aggregator
    AGGREGATOR
    IndexTypeLocal
    LOCAL
    IndexTypeAggregator
    AGGREGATOR
    Local
    LOCAL
    Aggregator
    AGGREGATOR
    Local
    LOCAL
    Aggregator
    AGGREGATOR
    LOCAL
    LOCAL
    AGGREGATOR
    AGGREGATOR
    "LOCAL"
    LOCAL
    "AGGREGATOR"
    AGGREGATOR

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native