Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cloudsearch
  5. Domain
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.cloudsearch.Domain

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

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", {
    name: "example-domain",
    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",
        },
    ],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.cloudsearch.Domain("example",
    name="example-domain",
    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",
        },
    ])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name: pulumi.String("example-domain"),
			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"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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()
    {
        Name = "example-domain",
        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",
            },
        },
    });

});
Copy
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.List;
import java.util.ArrayList;
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()
            .name("example-domain")
            .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())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:cloudsearch:Domain
    properties:
      name: example-domain
      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
Copy

Create Domain Resource

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

Constructor syntax

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

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           endpoint_options: Optional[DomainEndpointOptionsArgs] = None,
           index_fields: Optional[Sequence[DomainIndexFieldArgs]] = None,
           multi_az: Optional[bool] = None,
           name: Optional[str] = None,
           scaling_parameters: Optional[DomainScalingParametersArgs] = None)
func NewDomain(ctx *Context, name string, args *DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs? args = null, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

type: aws:cloudsearch:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DomainArgs
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 domainResource = new Aws.CloudSearch.Domain("domainResource", new()
{
    EndpointOptions = new Aws.CloudSearch.Inputs.DomainEndpointOptionsArgs
    {
        EnforceHttps = false,
        TlsSecurityPolicy = "string",
    },
    IndexFields = new[]
    {
        new Aws.CloudSearch.Inputs.DomainIndexFieldArgs
        {
            Name = "string",
            Type = "string",
            AnalysisScheme = "string",
            DefaultValue = "string",
            Facet = false,
            Highlight = false,
            Return = false,
            Search = false,
            Sort = false,
            SourceFields = "string",
        },
    },
    MultiAz = false,
    Name = "string",
    ScalingParameters = new Aws.CloudSearch.Inputs.DomainScalingParametersArgs
    {
        DesiredInstanceType = "string",
        DesiredPartitionCount = 0,
        DesiredReplicationCount = 0,
    },
});
Copy
example, err := cloudsearch.NewDomain(ctx, "domainResource", &cloudsearch.DomainArgs{
	EndpointOptions: &cloudsearch.DomainEndpointOptionsArgs{
		EnforceHttps:      pulumi.Bool(false),
		TlsSecurityPolicy: pulumi.String("string"),
	},
	IndexFields: cloudsearch.DomainIndexFieldArray{
		&cloudsearch.DomainIndexFieldArgs{
			Name:           pulumi.String("string"),
			Type:           pulumi.String("string"),
			AnalysisScheme: pulumi.String("string"),
			DefaultValue:   pulumi.String("string"),
			Facet:          pulumi.Bool(false),
			Highlight:      pulumi.Bool(false),
			Return:         pulumi.Bool(false),
			Search:         pulumi.Bool(false),
			Sort:           pulumi.Bool(false),
			SourceFields:   pulumi.String("string"),
		},
	},
	MultiAz: pulumi.Bool(false),
	Name:    pulumi.String("string"),
	ScalingParameters: &cloudsearch.DomainScalingParametersArgs{
		DesiredInstanceType:     pulumi.String("string"),
		DesiredPartitionCount:   pulumi.Int(0),
		DesiredReplicationCount: pulumi.Int(0),
	},
})
Copy
var domainResource = new Domain("domainResource", DomainArgs.builder()
    .endpointOptions(DomainEndpointOptionsArgs.builder()
        .enforceHttps(false)
        .tlsSecurityPolicy("string")
        .build())
    .indexFields(DomainIndexFieldArgs.builder()
        .name("string")
        .type("string")
        .analysisScheme("string")
        .defaultValue("string")
        .facet(false)
        .highlight(false)
        .return_(false)
        .search(false)
        .sort(false)
        .sourceFields("string")
        .build())
    .multiAz(false)
    .name("string")
    .scalingParameters(DomainScalingParametersArgs.builder()
        .desiredInstanceType("string")
        .desiredPartitionCount(0)
        .desiredReplicationCount(0)
        .build())
    .build());
Copy
domain_resource = aws.cloudsearch.Domain("domainResource",
    endpoint_options={
        "enforce_https": False,
        "tls_security_policy": "string",
    },
    index_fields=[{
        "name": "string",
        "type": "string",
        "analysis_scheme": "string",
        "default_value": "string",
        "facet": False,
        "highlight": False,
        "return_": False,
        "search": False,
        "sort": False,
        "source_fields": "string",
    }],
    multi_az=False,
    name="string",
    scaling_parameters={
        "desired_instance_type": "string",
        "desired_partition_count": 0,
        "desired_replication_count": 0,
    })
Copy
const domainResource = new aws.cloudsearch.Domain("domainResource", {
    endpointOptions: {
        enforceHttps: false,
        tlsSecurityPolicy: "string",
    },
    indexFields: [{
        name: "string",
        type: "string",
        analysisScheme: "string",
        defaultValue: "string",
        facet: false,
        highlight: false,
        "return": false,
        search: false,
        sort: false,
        sourceFields: "string",
    }],
    multiAz: false,
    name: "string",
    scalingParameters: {
        desiredInstanceType: "string",
        desiredPartitionCount: 0,
        desiredReplicationCount: 0,
    },
});
Copy
type: aws:cloudsearch:Domain
properties:
    endpointOptions:
        enforceHttps: false
        tlsSecurityPolicy: string
    indexFields:
        - analysisScheme: string
          defaultValue: string
          facet: false
          highlight: false
          name: string
          return: false
          search: false
          sort: false
          sourceFields: string
          type: string
    multiAz: false
    name: string
    scalingParameters:
        desiredInstanceType: string
        desiredPartitionCount: 0
        desiredReplicationCount: 0
Copy

Domain 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 Domain resource accepts the following input properties:

EndpointOptions DomainEndpointOptions
Domain endpoint options. Documented below.
IndexFields List<DomainIndexField>
The index fields for documents added to the domain. Documented below.
MultiAz bool
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
Name Changes to this property will trigger replacement. string
The name of the CloudSearch domain.
ScalingParameters DomainScalingParameters
Domain scaling parameters. Documented below.
EndpointOptions DomainEndpointOptionsArgs
Domain endpoint options. Documented below.
IndexFields []DomainIndexFieldArgs
The index fields for documents added to the domain. Documented below.
MultiAz bool
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
Name Changes to this property will trigger replacement. string
The name of the CloudSearch domain.
ScalingParameters DomainScalingParametersArgs
Domain scaling parameters. Documented below.
endpointOptions DomainEndpointOptions
Domain endpoint options. Documented below.
indexFields List<DomainIndexField>
The index fields for documents added to the domain. Documented below.
multiAz Boolean
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
name Changes to this property will trigger replacement. String
The name of the CloudSearch domain.
scalingParameters DomainScalingParameters
Domain scaling parameters. Documented below.
endpointOptions DomainEndpointOptions
Domain endpoint options. Documented below.
indexFields DomainIndexField[]
The index fields for documents added to the domain. Documented below.
multiAz boolean
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
name Changes to this property will trigger replacement. string
The name of the CloudSearch domain.
scalingParameters DomainScalingParameters
Domain scaling parameters. Documented below.
endpoint_options DomainEndpointOptionsArgs
Domain endpoint options. Documented below.
index_fields Sequence[DomainIndexFieldArgs]
The index fields for documents added to the domain. Documented below.
multi_az bool
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
name Changes to this property will trigger replacement. str
The name of the CloudSearch domain.
scaling_parameters DomainScalingParametersArgs
Domain scaling parameters. Documented below.
endpointOptions Property Map
Domain endpoint options. Documented below.
indexFields List<Property Map>
The index fields for documents added to the domain. Documented below.
multiAz Boolean
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
name Changes to this property will trigger replacement. String
The name of the CloudSearch domain.
scalingParameters Property Map
Domain scaling parameters. Documented below.

Outputs

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

Arn string
The domain's ARN.
DocumentServiceEndpoint string
The service endpoint for updating documents in a search domain.
DomainId string
An internally generated unique identifier for the domain.
Id string
The provider-assigned unique ID for this managed resource.
SearchServiceEndpoint string
The service endpoint for requesting search results from a search domain.
Arn string
The domain's ARN.
DocumentServiceEndpoint string
The service endpoint for updating documents in a search domain.
DomainId string
An internally generated unique identifier for the domain.
Id string
The provider-assigned unique ID for this managed resource.
SearchServiceEndpoint string
The service endpoint for requesting search results from a search domain.
arn String
The domain's ARN.
documentServiceEndpoint String
The service endpoint for updating documents in a search domain.
domainId String
An internally generated unique identifier for the domain.
id String
The provider-assigned unique ID for this managed resource.
searchServiceEndpoint String
The service endpoint for requesting search results from a search domain.
arn string
The domain's ARN.
documentServiceEndpoint string
The service endpoint for updating documents in a search domain.
domainId string
An internally generated unique identifier for the domain.
id string
The provider-assigned unique ID for this managed resource.
searchServiceEndpoint string
The service endpoint for requesting search results from a search domain.
arn str
The domain's ARN.
document_service_endpoint str
The service endpoint for updating documents in a search domain.
domain_id str
An internally generated unique identifier for the domain.
id str
The provider-assigned unique ID for this managed resource.
search_service_endpoint str
The service endpoint for requesting search results from a search domain.
arn String
The domain's ARN.
documentServiceEndpoint String
The service endpoint for updating documents in a search domain.
domainId String
An internally generated unique identifier for the domain.
id String
The provider-assigned unique ID for this managed resource.
searchServiceEndpoint String
The service endpoint for requesting search results from a search domain.

Look up Existing Domain Resource

Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        document_service_endpoint: Optional[str] = None,
        domain_id: Optional[str] = None,
        endpoint_options: Optional[DomainEndpointOptionsArgs] = None,
        index_fields: Optional[Sequence[DomainIndexFieldArgs]] = None,
        multi_az: Optional[bool] = None,
        name: Optional[str] = None,
        scaling_parameters: Optional[DomainScalingParametersArgs] = None,
        search_service_endpoint: Optional[str] = None) -> Domain
func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
resources:  _:    type: aws:cloudsearch:Domain    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Arn string
The domain's ARN.
DocumentServiceEndpoint string
The service endpoint for updating documents in a search domain.
DomainId string
An internally generated unique identifier for the domain.
EndpointOptions DomainEndpointOptions
Domain endpoint options. Documented below.
IndexFields List<DomainIndexField>
The index fields for documents added to the domain. Documented below.
MultiAz bool
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
Name Changes to this property will trigger replacement. string
The name of the CloudSearch domain.
ScalingParameters DomainScalingParameters
Domain scaling parameters. Documented below.
SearchServiceEndpoint string
The service endpoint for requesting search results from a search domain.
Arn string
The domain's ARN.
DocumentServiceEndpoint string
The service endpoint for updating documents in a search domain.
DomainId string
An internally generated unique identifier for the domain.
EndpointOptions DomainEndpointOptionsArgs
Domain endpoint options. Documented below.
IndexFields []DomainIndexFieldArgs
The index fields for documents added to the domain. Documented below.
MultiAz bool
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
Name Changes to this property will trigger replacement. string
The name of the CloudSearch domain.
ScalingParameters DomainScalingParametersArgs
Domain scaling parameters. Documented below.
SearchServiceEndpoint string
The service endpoint for requesting search results from a search domain.
arn String
The domain's ARN.
documentServiceEndpoint String
The service endpoint for updating documents in a search domain.
domainId String
An internally generated unique identifier for the domain.
endpointOptions DomainEndpointOptions
Domain endpoint options. Documented below.
indexFields List<DomainIndexField>
The index fields for documents added to the domain. Documented below.
multiAz Boolean
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
name Changes to this property will trigger replacement. String
The name of the CloudSearch domain.
scalingParameters DomainScalingParameters
Domain scaling parameters. Documented below.
searchServiceEndpoint String
The service endpoint for requesting search results from a search domain.
arn string
The domain's ARN.
documentServiceEndpoint string
The service endpoint for updating documents in a search domain.
domainId string
An internally generated unique identifier for the domain.
endpointOptions DomainEndpointOptions
Domain endpoint options. Documented below.
indexFields DomainIndexField[]
The index fields for documents added to the domain. Documented below.
multiAz boolean
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
name Changes to this property will trigger replacement. string
The name of the CloudSearch domain.
scalingParameters DomainScalingParameters
Domain scaling parameters. Documented below.
searchServiceEndpoint string
The service endpoint for requesting search results from a search domain.
arn str
The domain's ARN.
document_service_endpoint str
The service endpoint for updating documents in a search domain.
domain_id str
An internally generated unique identifier for the domain.
endpoint_options DomainEndpointOptionsArgs
Domain endpoint options. Documented below.
index_fields Sequence[DomainIndexFieldArgs]
The index fields for documents added to the domain. Documented below.
multi_az bool
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
name Changes to this property will trigger replacement. str
The name of the CloudSearch domain.
scaling_parameters DomainScalingParametersArgs
Domain scaling parameters. Documented below.
search_service_endpoint str
The service endpoint for requesting search results from a search domain.
arn String
The domain's ARN.
documentServiceEndpoint String
The service endpoint for updating documents in a search domain.
domainId String
An internally generated unique identifier for the domain.
endpointOptions Property Map
Domain endpoint options. Documented below.
indexFields List<Property Map>
The index fields for documents added to the domain. Documented below.
multiAz Boolean
Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
name Changes to this property will trigger replacement. String
The name of the CloudSearch domain.
scalingParameters Property Map
Domain scaling parameters. Documented below.
searchServiceEndpoint String
The service endpoint for requesting search results from a search domain.

Supporting Types

DomainEndpointOptions
, DomainEndpointOptionsArgs

EnforceHttps bool
Enables or disables the requirement that all requests to the domain arrive over HTTPS.
TlsSecurityPolicy string
The minimum required TLS version. See the AWS documentation for valid values.
EnforceHttps bool
Enables or disables the requirement that all requests to the domain arrive over HTTPS.
TlsSecurityPolicy string
The minimum required TLS version. See the AWS documentation for valid values.
enforceHttps Boolean
Enables or disables the requirement that all requests to the domain arrive over HTTPS.
tlsSecurityPolicy String
The minimum required TLS version. See the AWS documentation for valid values.
enforceHttps boolean
Enables or disables the requirement that all requests to the domain arrive over HTTPS.
tlsSecurityPolicy string
The minimum required TLS version. See the AWS documentation for valid values.
enforce_https bool
Enables or disables the requirement that all requests to the domain arrive over HTTPS.
tls_security_policy str
The minimum required TLS version. See the AWS documentation for valid values.
enforceHttps Boolean
Enables or disables the requirement that all requests to the domain arrive over HTTPS.
tlsSecurityPolicy String
The minimum required TLS version. See the AWS documentation for valid values.

DomainIndexField
, DomainIndexFieldArgs

Name This property is required. string
A unique name for the field. Field names must begin with a letter and be at least 1 and no more than 64 characters long. The allowed characters are: a-z (lower-case letters), 0-9, and _ (underscore). The name score is reserved and cannot be used as a field name.
Type This property is required. string
The field type. Valid values: date, date-array, double, double-array, int, int-array, literal, literal-array, text, text-array.
AnalysisScheme string
The analysis scheme you want to use for a text field. The analysis scheme specifies the language-specific text processing options that are used during indexing.
DefaultValue string
The default value for the field. This value is used when no value is specified for the field in the document data.
Facet bool
You can get facet information by enabling this.
Highlight bool
You can highlight information.
Return bool
You can enable returning the value of all searchable fields.
Search bool
You can set whether this index should be searchable or not.
Sort bool
You can enable the property to be sortable.
SourceFields string
A comma-separated list of source fields to map to the field. Specifying a source field copies data from one field to another, enabling you to use the same source data in different ways by configuring different options for the fields.
Name This property is required. string
A unique name for the field. Field names must begin with a letter and be at least 1 and no more than 64 characters long. The allowed characters are: a-z (lower-case letters), 0-9, and _ (underscore). The name score is reserved and cannot be used as a field name.
Type This property is required. string
The field type. Valid values: date, date-array, double, double-array, int, int-array, literal, literal-array, text, text-array.
AnalysisScheme string
The analysis scheme you want to use for a text field. The analysis scheme specifies the language-specific text processing options that are used during indexing.
DefaultValue string
The default value for the field. This value is used when no value is specified for the field in the document data.
Facet bool
You can get facet information by enabling this.
Highlight bool
You can highlight information.
Return bool
You can enable returning the value of all searchable fields.
Search bool
You can set whether this index should be searchable or not.
Sort bool
You can enable the property to be sortable.
SourceFields string
A comma-separated list of source fields to map to the field. Specifying a source field copies data from one field to another, enabling you to use the same source data in different ways by configuring different options for the fields.
name This property is required. String
A unique name for the field. Field names must begin with a letter and be at least 1 and no more than 64 characters long. The allowed characters are: a-z (lower-case letters), 0-9, and _ (underscore). The name score is reserved and cannot be used as a field name.
type This property is required. String
The field type. Valid values: date, date-array, double, double-array, int, int-array, literal, literal-array, text, text-array.
analysisScheme String
The analysis scheme you want to use for a text field. The analysis scheme specifies the language-specific text processing options that are used during indexing.
defaultValue String
The default value for the field. This value is used when no value is specified for the field in the document data.
facet Boolean
You can get facet information by enabling this.
highlight Boolean
You can highlight information.
return_ Boolean
You can enable returning the value of all searchable fields.
search Boolean
You can set whether this index should be searchable or not.
sort Boolean
You can enable the property to be sortable.
sourceFields String
A comma-separated list of source fields to map to the field. Specifying a source field copies data from one field to another, enabling you to use the same source data in different ways by configuring different options for the fields.
name This property is required. string
A unique name for the field. Field names must begin with a letter and be at least 1 and no more than 64 characters long. The allowed characters are: a-z (lower-case letters), 0-9, and _ (underscore). The name score is reserved and cannot be used as a field name.
type This property is required. string
The field type. Valid values: date, date-array, double, double-array, int, int-array, literal, literal-array, text, text-array.
analysisScheme string
The analysis scheme you want to use for a text field. The analysis scheme specifies the language-specific text processing options that are used during indexing.
defaultValue string
The default value for the field. This value is used when no value is specified for the field in the document data.
facet boolean
You can get facet information by enabling this.
highlight boolean
You can highlight information.
return boolean
You can enable returning the value of all searchable fields.
search boolean
You can set whether this index should be searchable or not.
sort boolean
You can enable the property to be sortable.
sourceFields string
A comma-separated list of source fields to map to the field. Specifying a source field copies data from one field to another, enabling you to use the same source data in different ways by configuring different options for the fields.
name This property is required. str
A unique name for the field. Field names must begin with a letter and be at least 1 and no more than 64 characters long. The allowed characters are: a-z (lower-case letters), 0-9, and _ (underscore). The name score is reserved and cannot be used as a field name.
type This property is required. str
The field type. Valid values: date, date-array, double, double-array, int, int-array, literal, literal-array, text, text-array.
analysis_scheme str
The analysis scheme you want to use for a text field. The analysis scheme specifies the language-specific text processing options that are used during indexing.
default_value str
The default value for the field. This value is used when no value is specified for the field in the document data.
facet bool
You can get facet information by enabling this.
highlight bool
You can highlight information.
return_ bool
You can enable returning the value of all searchable fields.
search bool
You can set whether this index should be searchable or not.
sort bool
You can enable the property to be sortable.
source_fields str
A comma-separated list of source fields to map to the field. Specifying a source field copies data from one field to another, enabling you to use the same source data in different ways by configuring different options for the fields.
name This property is required. String
A unique name for the field. Field names must begin with a letter and be at least 1 and no more than 64 characters long. The allowed characters are: a-z (lower-case letters), 0-9, and _ (underscore). The name score is reserved and cannot be used as a field name.
type This property is required. String
The field type. Valid values: date, date-array, double, double-array, int, int-array, literal, literal-array, text, text-array.
analysisScheme String
The analysis scheme you want to use for a text field. The analysis scheme specifies the language-specific text processing options that are used during indexing.
defaultValue String
The default value for the field. This value is used when no value is specified for the field in the document data.
facet Boolean
You can get facet information by enabling this.
highlight Boolean
You can highlight information.
return Boolean
You can enable returning the value of all searchable fields.
search Boolean
You can set whether this index should be searchable or not.
sort Boolean
You can enable the property to be sortable.
sourceFields String
A comma-separated list of source fields to map to the field. Specifying a source field copies data from one field to another, enabling you to use the same source data in different ways by configuring different options for the fields.

DomainScalingParameters
, DomainScalingParametersArgs

DesiredInstanceType string
The instance type that you want to preconfigure for your domain. See the AWS documentation for valid values.
DesiredPartitionCount int
The number of partitions you want to preconfigure for your domain. Only valid when you select search.2xlarge as the instance type.
DesiredReplicationCount int
The number of replicas you want to preconfigure for each index partition.
DesiredInstanceType string
The instance type that you want to preconfigure for your domain. See the AWS documentation for valid values.
DesiredPartitionCount int
The number of partitions you want to preconfigure for your domain. Only valid when you select search.2xlarge as the instance type.
DesiredReplicationCount int
The number of replicas you want to preconfigure for each index partition.
desiredInstanceType String
The instance type that you want to preconfigure for your domain. See the AWS documentation for valid values.
desiredPartitionCount Integer
The number of partitions you want to preconfigure for your domain. Only valid when you select search.2xlarge as the instance type.
desiredReplicationCount Integer
The number of replicas you want to preconfigure for each index partition.
desiredInstanceType string
The instance type that you want to preconfigure for your domain. See the AWS documentation for valid values.
desiredPartitionCount number
The number of partitions you want to preconfigure for your domain. Only valid when you select search.2xlarge as the instance type.
desiredReplicationCount number
The number of replicas you want to preconfigure for each index partition.
desired_instance_type str
The instance type that you want to preconfigure for your domain. See the AWS documentation for valid values.
desired_partition_count int
The number of partitions you want to preconfigure for your domain. Only valid when you select search.2xlarge as the instance type.
desired_replication_count int
The number of replicas you want to preconfigure for each index partition.
desiredInstanceType String
The instance type that you want to preconfigure for your domain. See the AWS documentation for valid values.
desiredPartitionCount Number
The number of partitions you want to preconfigure for your domain. Only valid when you select search.2xlarge as the instance type.
desiredReplicationCount Number
The number of replicas you want to preconfigure for each index partition.

Import

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

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws