Domain class

Provides an CloudSearch domain resource.

The provider waits for the domain to become Active when applying a configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.cloudsearch.Domain("example", {
    scalingParameters: {
        desiredInstanceType: "search.medium",
    },
    indexFields: [
        {
            name: "headline",
            type: "text",
            search: true,
            "return": true,
            sort: true,
            highlight: false,
            analysisScheme: "_en_default_",
        },
        {
            name: "price",
            type: "double",
            search: true,
            facet: true,
            "return": true,
            sort: true,
            sourceFields: "headline",
        },
    ],
    name: "example-domain",
});
import pulumi
import pulumi_aws as aws

example = aws.cloudsearch.Domain("example",
    scaling_parameters={
        "desired_instance_type": "search.medium",
    },
    index_fields=[
        {
            "name": "headline",
            "type": "text",
            "search": True,
            "return_": True,
            "sort": True,
            "highlight": False,
            "analysis_scheme": "_en_default_",
        },
        {
            "name": "price",
            "type": "double",
            "search": True,
            "facet": True,
            "return_": True,
            "sort": True,
            "source_fields": "headline",
        },
    ],
    name="example-domain")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.CloudSearch.Domain("example", new()
    {
        ScalingParameters = new Aws.CloudSearch.Inputs.DomainScalingParametersArgs
        {
            DesiredInstanceType = "search.medium",
        },
        IndexFields = new[]
        {
            new Aws.CloudSearch.Inputs.DomainIndexFieldArgs
            {
                Name = "headline",
                Type = "text",
                Search = true,
                Return = true,
                Sort = true,
                Highlight = false,
                AnalysisScheme = "_en_default_",
            },
            new Aws.CloudSearch.Inputs.DomainIndexFieldArgs
            {
                Name = "price",
                Type = "double",
                Search = true,
                Facet = true,
                Return = true,
                Sort = true,
                SourceFields = "headline",
            },
        },
        Name = "example-domain",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudsearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudsearch.NewDomain(ctx, "example", &cloudsearch.DomainArgs{
			ScalingParameters: &cloudsearch.DomainScalingParametersArgs{
				DesiredInstanceType: pulumi.String("search.medium"),
			},
			IndexFields: cloudsearch.DomainIndexFieldArray{
				&cloudsearch.DomainIndexFieldArgs{
					Name:           pulumi.String("headline"),
					Type:           pulumi.String("text"),
					Search:         pulumi.Bool(true),
					Return:         pulumi.Bool(true),
					Sort:           pulumi.Bool(true),
					Highlight:      pulumi.Bool(false),
					AnalysisScheme: pulumi.String("_en_default_"),
				},
				&cloudsearch.DomainIndexFieldArgs{
					Name:         pulumi.String("price"),
					Type:         pulumi.String("double"),
					Search:       pulumi.Bool(true),
					Facet:        pulumi.Bool(true),
					Return:       pulumi.Bool(true),
					Sort:         pulumi.Bool(true),
					SourceFields: pulumi.String("headline"),
				},
			},
			Name: pulumi.String("example-domain"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cloudsearch_domain" "example" {
  scaling_parameters = {
    desired_instance_type = "search.medium"
  }
  index_fields {
    name            = "headline"
    type            = "text"
    search          = true
    return          = true
    sort            = true
    highlight       = false
    analysis_scheme = "_en_default_"
  }
  index_fields {
    name          = "price"
    type          = "double"
    search        = true
    facet         = true
    return        = true
    sort          = true
    source_fields = "headline"
  }
  name = "example-domain"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudsearch.Domain;
import com.pulumi.aws.cloudsearch.DomainArgs;
import com.pulumi.aws.cloudsearch.inputs.DomainScalingParametersArgs;
import com.pulumi.aws.cloudsearch.inputs.DomainIndexFieldArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Domain("example", DomainArgs.builder()
            .scalingParameters(DomainScalingParametersArgs.builder()
                .desiredInstanceType("search.medium")
                .build())
            .indexFields(
                DomainIndexFieldArgs.builder()
                    .name("headline")
                    .type("text")
                    .search(true)
                    .return_(true)
                    .sort(true)
                    .highlight(false)
                    .analysisScheme("_en_default_")
                    .build(),
                DomainIndexFieldArgs.builder()
                    .name("price")
                    .type("double")
                    .search(true)
                    .facet(true)
                    .return_(true)
                    .sort(true)
                    .sourceFields("headline")
                    .build())
            .name("example-domain")
            .build());

    }
}
resources:
  example:
    type: aws:cloudsearch:Domain
    properties:
      scalingParameters:
        desiredInstanceType: search.medium
      indexFields:
        - name: headline
          type: text
          search: true
          return: true
          sort: true
          highlight: false
          analysisScheme: _en_default_
        - name: price
          type: double
          search: true
          facet: true
          return: true
          sort: true
          sourceFields: headline
      name: example-domain

Import

Using pulumi import, import CloudSearch Domains using the name. For example:

$ pulumi import aws:cloudsearch/domain:Domain example example-domain

Constructors

Domain(String name, {DomainArgs? args, CustomResourceOptions? options})
Creates a new Domain. name The Pulumi resource name. args Arguments used to configure this Domain. The set of arguments for Domain. options Resource options controlling this resource's behavior.
Domain.reference(String urn)
Creates a typed reference to an existing Domain resource.

Properties

arn ↔ Output<String>
The domain's ARN.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
documentServiceEndpoint ↔ Output<String>
The service endpoint for updating documents in a search domain.
latefinal
domainId ↔ Output<String>
An internally generated unique identifier for the domain.
latefinal
endpointOptions ↔ Output<DomainEndpointOptions>
Domain endpoint options. Documented below.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
indexFields ↔ Output<List<DomainIndexField>?>
The index fields for documents added to the domain. Documented below.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
multiAz ↔ Output<bool>
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
latefinal
name ↔ Output<String>
The name of the CloudSearch domain.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scalingParameters ↔ Output<DomainScalingParameters>
Domain scaling parameters. Documented below.
latefinal
searchServiceEndpoint ↔ Output<String>
The service endpoint for requesting search results from a search domain.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DomainState? state, CustomResourceOptions? options}) → Domain
Gets an existing Domain resource's state with the given name and id.