1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. ElasticsearchIndexAlias
elasticstack 0.13.1 published on Thursday, Dec 11, 2025 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

elasticstack.ElasticsearchIndexAlias

elasticstack logo
elasticstack 0.13.1 published on Thursday, Dec 11, 2025 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

    Manages an Elasticsearch alias. See the alias documentation for more details.

    Create ElasticsearchIndexAlias Resource

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

    Constructor syntax

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

@overload
def ElasticsearchIndexAlias(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            name: Optional[str] = None,
                            read_indices: Optional[Sequence[ElasticsearchIndexAliasReadIndexArgs]] = None,
                            write_index: Optional[ElasticsearchIndexAliasWriteIndexArgs] = None)
    func NewElasticsearchIndexAlias(ctx *Context, name string, args *ElasticsearchIndexAliasArgs, opts ...ResourceOption) (*ElasticsearchIndexAlias, error)
    public ElasticsearchIndexAlias(string name, ElasticsearchIndexAliasArgs? args = null, CustomResourceOptions? opts = null)
    public ElasticsearchIndexAlias(String name, ElasticsearchIndexAliasArgs args)
public ElasticsearchIndexAlias(String name, ElasticsearchIndexAliasArgs args, CustomResourceOptions options)

    type: elasticstack:ElasticsearchIndexAlias
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 ElasticsearchIndexAliasArgs
    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 ElasticsearchIndexAliasInitArgs
    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 ElasticsearchIndexAliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ElasticsearchIndexAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ElasticsearchIndexAliasArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var elasticsearchIndexAliasResource = new Elasticstack.ElasticsearchIndexAlias("elasticsearchIndexAliasResource", new()
{
    Name = "string",
    ReadIndices = new[]
    {
        new Elasticstack.Inputs.ElasticsearchIndexAliasReadIndexArgs
        {
            Name = "string",
            Filter = "string",
            IndexRouting = "string",
            IsHidden = false,
            Routing = "string",
            SearchRouting = "string",
        },
    },
    WriteIndex = new Elasticstack.Inputs.ElasticsearchIndexAliasWriteIndexArgs
    {
        Name = "string",
        Filter = "string",
        IndexRouting = "string",
        IsHidden = false,
        Routing = "string",
        SearchRouting = "string",
    },
});

    example, err := elasticstack.NewElasticsearchIndexAlias(ctx, "elasticsearchIndexAliasResource", &elasticstack.ElasticsearchIndexAliasArgs{
	Name: pulumi.String("string"),
	ReadIndices: elasticstack.ElasticsearchIndexAliasReadIndexArray{
		&elasticstack.ElasticsearchIndexAliasReadIndexArgs{
			Name:          pulumi.String("string"),
			Filter:        pulumi.String("string"),
			IndexRouting:  pulumi.String("string"),
			IsHidden:      pulumi.Bool(false),
			Routing:       pulumi.String("string"),
			SearchRouting: pulumi.String("string"),
		},
	},
	WriteIndex: &elasticstack.ElasticsearchIndexAliasWriteIndexArgs{
		Name:          pulumi.String("string"),
		Filter:        pulumi.String("string"),
		IndexRouting:  pulumi.String("string"),
		IsHidden:      pulumi.Bool(false),
		Routing:       pulumi.String("string"),
		SearchRouting: pulumi.String("string"),
	},
})

    var elasticsearchIndexAliasResource = new ElasticsearchIndexAlias("elasticsearchIndexAliasResource", ElasticsearchIndexAliasArgs.builder()
    .name("string")
    .readIndices(ElasticsearchIndexAliasReadIndexArgs.builder()
        .name("string")
        .filter("string")
        .indexRouting("string")
        .isHidden(false)
        .routing("string")
        .searchRouting("string")
        .build())
    .writeIndex(ElasticsearchIndexAliasWriteIndexArgs.builder()
        .name("string")
        .filter("string")
        .indexRouting("string")
        .isHidden(false)
        .routing("string")
        .searchRouting("string")
        .build())
    .build());

    elasticsearch_index_alias_resource = elasticstack.ElasticsearchIndexAlias("elasticsearchIndexAliasResource",
    name="string",
    read_indices=[{
        "name": "string",
        "filter": "string",
        "index_routing": "string",
        "is_hidden": False,
        "routing": "string",
        "search_routing": "string",
    }],
    write_index={
        "name": "string",
        "filter": "string",
        "index_routing": "string",
        "is_hidden": False,
        "routing": "string",
        "search_routing": "string",
    })

    const elasticsearchIndexAliasResource = new elasticstack.ElasticsearchIndexAlias("elasticsearchIndexAliasResource", {
    name: "string",
    readIndices: [{
        name: "string",
        filter: "string",
        indexRouting: "string",
        isHidden: false,
        routing: "string",
        searchRouting: "string",
    }],
    writeIndex: {
        name: "string",
        filter: "string",
        indexRouting: "string",
        isHidden: false,
        routing: "string",
        searchRouting: "string",
    },
});

    type: elasticstack:ElasticsearchIndexAlias
properties:
    name: string
    readIndices:
        - filter: string
          indexRouting: string
          isHidden: false
          name: string
          routing: string
          searchRouting: string
    writeIndex:
        filter: string
        indexRouting: string
        isHidden: false
        name: string
        routing: string
        searchRouting: string

    ElasticsearchIndexAlias Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ElasticsearchIndexAlias resource accepts the following input properties:

    Name string
    The alias name.
    ReadIndices List<ElasticsearchIndexAliasReadIndex>
    Set of read indices for the alias.
    WriteIndex ElasticsearchIndexAliasWriteIndex
    The write index for the alias. Only one write index is allowed per alias.
    Name string
    The alias name.
    ReadIndices []ElasticsearchIndexAliasReadIndexArgs
    Set of read indices for the alias.
    WriteIndex ElasticsearchIndexAliasWriteIndexArgs
    The write index for the alias. Only one write index is allowed per alias.
    name String
    The alias name.
    readIndices List<ElasticsearchIndexAliasReadIndex>
    Set of read indices for the alias.
    writeIndex ElasticsearchIndexAliasWriteIndex
    The write index for the alias. Only one write index is allowed per alias.
    name string
    The alias name.
    readIndices ElasticsearchIndexAliasReadIndex[]
    Set of read indices for the alias.
    writeIndex ElasticsearchIndexAliasWriteIndex
    The write index for the alias. Only one write index is allowed per alias.
    name str
    The alias name.
    read_indices Sequence[ElasticsearchIndexAliasReadIndexArgs]
    Set of read indices for the alias.
    write_index ElasticsearchIndexAliasWriteIndexArgs
    The write index for the alias. Only one write index is allowed per alias.
    name String
    The alias name.
    readIndices List<Property Map>
    Set of read indices for the alias.
    writeIndex Property Map
    The write index for the alias. Only one write index is allowed per alias.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ElasticsearchIndexAlias Resource

    Get an existing ElasticsearchIndexAlias resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ElasticsearchIndexAliasState, opts?: CustomResourceOptions): ElasticsearchIndexAlias
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        read_indices: Optional[Sequence[ElasticsearchIndexAliasReadIndexArgs]] = None,
        write_index: Optional[ElasticsearchIndexAliasWriteIndexArgs] = None) -> ElasticsearchIndexAlias
    func GetElasticsearchIndexAlias(ctx *Context, name string, id IDInput, state *ElasticsearchIndexAliasState, opts ...ResourceOption) (*ElasticsearchIndexAlias, error)
    public static ElasticsearchIndexAlias Get(string name, Input<string> id, ElasticsearchIndexAliasState? state, CustomResourceOptions? opts = null)
    public static ElasticsearchIndexAlias get(String name, Output<String> id, ElasticsearchIndexAliasState state, CustomResourceOptions options)
    resources:  _:    type: elasticstack:ElasticsearchIndexAlias    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Name string
    The alias name.
    ReadIndices List<ElasticsearchIndexAliasReadIndex>
    Set of read indices for the alias.
    WriteIndex ElasticsearchIndexAliasWriteIndex
    The write index for the alias. Only one write index is allowed per alias.
    Name string
    The alias name.
    ReadIndices []ElasticsearchIndexAliasReadIndexArgs
    Set of read indices for the alias.
    WriteIndex ElasticsearchIndexAliasWriteIndexArgs
    The write index for the alias. Only one write index is allowed per alias.
    name String
    The alias name.
    readIndices List<ElasticsearchIndexAliasReadIndex>
    Set of read indices for the alias.
    writeIndex ElasticsearchIndexAliasWriteIndex
    The write index for the alias. Only one write index is allowed per alias.
    name string
    The alias name.
    readIndices ElasticsearchIndexAliasReadIndex[]
    Set of read indices for the alias.
    writeIndex ElasticsearchIndexAliasWriteIndex
    The write index for the alias. Only one write index is allowed per alias.
    name str
    The alias name.
    read_indices Sequence[ElasticsearchIndexAliasReadIndexArgs]
    Set of read indices for the alias.
    write_index ElasticsearchIndexAliasWriteIndexArgs
    The write index for the alias. Only one write index is allowed per alias.
    name String
    The alias name.
    readIndices List<Property Map>
    Set of read indices for the alias.
    writeIndex Property Map
    The write index for the alias. Only one write index is allowed per alias.

    Supporting Types

    ElasticsearchIndexAliasReadIndex, ElasticsearchIndexAliasReadIndexArgs

    Name string
    Name of the read index.
    Filter string
    Query used to limit documents the alias can access.
    IndexRouting string
    Value used to route indexing operations to a specific shard.
    IsHidden bool
    If true, the alias is hidden.
    Routing string
    Value used to route indexing and search operations to a specific shard.
    SearchRouting string
    Value used to route search operations to a specific shard.
    Name string
    Name of the read index.
    Filter string
    Query used to limit documents the alias can access.
    IndexRouting string
    Value used to route indexing operations to a specific shard.
    IsHidden bool
    If true, the alias is hidden.
    Routing string
    Value used to route indexing and search operations to a specific shard.
    SearchRouting string
    Value used to route search operations to a specific shard.
    name String
    Name of the read index.
    filter String
    Query used to limit documents the alias can access.
    indexRouting String
    Value used to route indexing operations to a specific shard.
    isHidden Boolean
    If true, the alias is hidden.
    routing String
    Value used to route indexing and search operations to a specific shard.
    searchRouting String
    Value used to route search operations to a specific shard.
    name string
    Name of the read index.
    filter string
    Query used to limit documents the alias can access.
    indexRouting string
    Value used to route indexing operations to a specific shard.
    isHidden boolean
    If true, the alias is hidden.
    routing string
    Value used to route indexing and search operations to a specific shard.
    searchRouting string
    Value used to route search operations to a specific shard.
    name str
    Name of the read index.
    filter str
    Query used to limit documents the alias can access.
    index_routing str
    Value used to route indexing operations to a specific shard.
    is_hidden bool
    If true, the alias is hidden.
    routing str
    Value used to route indexing and search operations to a specific shard.
    search_routing str
    Value used to route search operations to a specific shard.
    name String
    Name of the read index.
    filter String
    Query used to limit documents the alias can access.
    indexRouting String
    Value used to route indexing operations to a specific shard.
    isHidden Boolean
    If true, the alias is hidden.
    routing String
    Value used to route indexing and search operations to a specific shard.
    searchRouting String
    Value used to route search operations to a specific shard.

    ElasticsearchIndexAliasWriteIndex, ElasticsearchIndexAliasWriteIndexArgs

    Name string
    Name of the write index.
    Filter string
    Query used to limit documents the alias can access.
    IndexRouting string
    Value used to route indexing operations to a specific shard.
    IsHidden bool
    If true, the alias is hidden.
    Routing string
    Value used to route indexing and search operations to a specific shard.
    SearchRouting string
    Value used to route search operations to a specific shard.
    Name string
    Name of the write index.
    Filter string
    Query used to limit documents the alias can access.
    IndexRouting string
    Value used to route indexing operations to a specific shard.
    IsHidden bool
    If true, the alias is hidden.
    Routing string
    Value used to route indexing and search operations to a specific shard.
    SearchRouting string
    Value used to route search operations to a specific shard.
    name String
    Name of the write index.
    filter String
    Query used to limit documents the alias can access.
    indexRouting String
    Value used to route indexing operations to a specific shard.
    isHidden Boolean
    If true, the alias is hidden.
    routing String
    Value used to route indexing and search operations to a specific shard.
    searchRouting String
    Value used to route search operations to a specific shard.
    name string
    Name of the write index.
    filter string
    Query used to limit documents the alias can access.
    indexRouting string
    Value used to route indexing operations to a specific shard.
    isHidden boolean
    If true, the alias is hidden.
    routing string
    Value used to route indexing and search operations to a specific shard.
    searchRouting string
    Value used to route search operations to a specific shard.
    name str
    Name of the write index.
    filter str
    Query used to limit documents the alias can access.
    index_routing str
    Value used to route indexing operations to a specific shard.
    is_hidden bool
    If true, the alias is hidden.
    routing str
    Value used to route indexing and search operations to a specific shard.
    search_routing str
    Value used to route search operations to a specific shard.
    name String
    Name of the write index.
    filter String
    Query used to limit documents the alias can access.
    indexRouting String
    Value used to route indexing operations to a specific shard.
    isHidden Boolean
    If true, the alias is hidden.
    routing String
    Value used to route indexing and search operations to a specific shard.
    searchRouting String
    Value used to route search operations to a specific shard.

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    elasticstack logo
    elasticstack 0.13.1 published on Thursday, Dec 11, 2025 by elastic
    Schema (JSON)
    elastic/terraform-provider-elasticstack
      Meet Neo: Your AI Platform Teammate