github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/cloudsearch/domain.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package cloudsearch

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Provides an CloudSearch domain resource.
//
// The provider waits for the domain to become `Active` when applying a configuration.
//
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// 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
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Import
//
// Using `pulumi import`, import CloudSearch Domains using the `name`. For example:
//
// ```sh
// $ pulumi import aws:cloudsearch/domain:Domain example example-domain
// ```
type Domain struct {
	pulumi.CustomResourceState

	// The domain's ARN.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The service endpoint for updating documents in a search domain.
	DocumentServiceEndpoint pulumi.StringOutput `pulumi:"documentServiceEndpoint"`
	// An internally generated unique identifier for the domain.
	DomainId pulumi.StringOutput `pulumi:"domainId"`
	// Domain endpoint options. Documented below.
	EndpointOptions DomainEndpointOptionsOutput `pulumi:"endpointOptions"`
	// The index fields for documents added to the domain. Documented below.
	IndexFields DomainIndexFieldArrayOutput `pulumi:"indexFields"`
	// Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
	MultiAz pulumi.BoolOutput `pulumi:"multiAz"`
	// The name of the CloudSearch domain.
	Name pulumi.StringOutput `pulumi:"name"`
	// Domain scaling parameters. Documented below.
	ScalingParameters DomainScalingParametersOutput `pulumi:"scalingParameters"`
	// The service endpoint for requesting search results from a search domain.
	SearchServiceEndpoint pulumi.StringOutput `pulumi:"searchServiceEndpoint"`
}

// NewDomain registers a new resource with the given unique name, arguments, and options.
func NewDomain(ctx *pulumi.Context,
	name string, args *DomainArgs, opts ...pulumi.ResourceOption) (*Domain, error) {
	if args == nil {
		args = &DomainArgs{}
	}

	opts = internal.PkgResourceDefaultOpts(opts)
	var resource Domain
	err := ctx.RegisterResource("aws:cloudsearch/domain:Domain", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetDomain gets an existing Domain resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetDomain(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DomainState, opts ...pulumi.ResourceOption) (*Domain, error) {
	var resource Domain
	err := ctx.ReadResource("aws:cloudsearch/domain:Domain", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering Domain resources.
type domainState struct {
	// The domain's ARN.
	Arn *string `pulumi:"arn"`
	// The service endpoint for updating documents in a search domain.
	DocumentServiceEndpoint *string `pulumi:"documentServiceEndpoint"`
	// An internally generated unique identifier for the domain.
	DomainId *string `pulumi:"domainId"`
	// Domain endpoint options. Documented below.
	EndpointOptions *DomainEndpointOptions `pulumi:"endpointOptions"`
	// The index fields for documents added to the domain. Documented below.
	IndexFields []DomainIndexField `pulumi:"indexFields"`
	// Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
	MultiAz *bool `pulumi:"multiAz"`
	// The name of the CloudSearch domain.
	Name *string `pulumi:"name"`
	// Domain scaling parameters. Documented below.
	ScalingParameters *DomainScalingParameters `pulumi:"scalingParameters"`
	// The service endpoint for requesting search results from a search domain.
	SearchServiceEndpoint *string `pulumi:"searchServiceEndpoint"`
}

type DomainState struct {
	// The domain's ARN.
	Arn pulumi.StringPtrInput
	// The service endpoint for updating documents in a search domain.
	DocumentServiceEndpoint pulumi.StringPtrInput
	// An internally generated unique identifier for the domain.
	DomainId pulumi.StringPtrInput
	// Domain endpoint options. Documented below.
	EndpointOptions DomainEndpointOptionsPtrInput
	// The index fields for documents added to the domain. Documented below.
	IndexFields DomainIndexFieldArrayInput
	// Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
	MultiAz pulumi.BoolPtrInput
	// The name of the CloudSearch domain.
	Name pulumi.StringPtrInput
	// Domain scaling parameters. Documented below.
	ScalingParameters DomainScalingParametersPtrInput
	// The service endpoint for requesting search results from a search domain.
	SearchServiceEndpoint pulumi.StringPtrInput
}

func (DomainState) ElementType() reflect.Type {
	return reflect.TypeOf((*domainState)(nil)).Elem()
}

type domainArgs struct {
	// Domain endpoint options. Documented below.
	EndpointOptions *DomainEndpointOptions `pulumi:"endpointOptions"`
	// The index fields for documents added to the domain. Documented below.
	IndexFields []DomainIndexField `pulumi:"indexFields"`
	// Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
	MultiAz *bool `pulumi:"multiAz"`
	// The name of the CloudSearch domain.
	Name *string `pulumi:"name"`
	// Domain scaling parameters. Documented below.
	ScalingParameters *DomainScalingParameters `pulumi:"scalingParameters"`
}

// The set of arguments for constructing a Domain resource.
type DomainArgs struct {
	// Domain endpoint options. Documented below.
	EndpointOptions DomainEndpointOptionsPtrInput
	// The index fields for documents added to the domain. Documented below.
	IndexFields DomainIndexFieldArrayInput
	// Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
	MultiAz pulumi.BoolPtrInput
	// The name of the CloudSearch domain.
	Name pulumi.StringPtrInput
	// Domain scaling parameters. Documented below.
	ScalingParameters DomainScalingParametersPtrInput
}

func (DomainArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*domainArgs)(nil)).Elem()
}

type DomainInput interface {
	pulumi.Input

	ToDomainOutput() DomainOutput
	ToDomainOutputWithContext(ctx context.Context) DomainOutput
}

func (*Domain) ElementType() reflect.Type {
	return reflect.TypeOf((**Domain)(nil)).Elem()
}

func (i *Domain) ToDomainOutput() DomainOutput {
	return i.ToDomainOutputWithContext(context.Background())
}

func (i *Domain) ToDomainOutputWithContext(ctx context.Context) DomainOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DomainOutput)
}

// DomainArrayInput is an input type that accepts DomainArray and DomainArrayOutput values.
// You can construct a concrete instance of `DomainArrayInput` via:
//
//	DomainArray{ DomainArgs{...} }
type DomainArrayInput interface {
	pulumi.Input

	ToDomainArrayOutput() DomainArrayOutput
	ToDomainArrayOutputWithContext(context.Context) DomainArrayOutput
}

type DomainArray []DomainInput

func (DomainArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*Domain)(nil)).Elem()
}

func (i DomainArray) ToDomainArrayOutput() DomainArrayOutput {
	return i.ToDomainArrayOutputWithContext(context.Background())
}

func (i DomainArray) ToDomainArrayOutputWithContext(ctx context.Context) DomainArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DomainArrayOutput)
}

// DomainMapInput is an input type that accepts DomainMap and DomainMapOutput values.
// You can construct a concrete instance of `DomainMapInput` via:
//
//	DomainMap{ "key": DomainArgs{...} }
type DomainMapInput interface {
	pulumi.Input

	ToDomainMapOutput() DomainMapOutput
	ToDomainMapOutputWithContext(context.Context) DomainMapOutput
}

type DomainMap map[string]DomainInput

func (DomainMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*Domain)(nil)).Elem()
}

func (i DomainMap) ToDomainMapOutput() DomainMapOutput {
	return i.ToDomainMapOutputWithContext(context.Background())
}

func (i DomainMap) ToDomainMapOutputWithContext(ctx context.Context) DomainMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DomainMapOutput)
}

type DomainOutput struct{ *pulumi.OutputState }

func (DomainOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**Domain)(nil)).Elem()
}

func (o DomainOutput) ToDomainOutput() DomainOutput {
	return o
}

func (o DomainOutput) ToDomainOutputWithContext(ctx context.Context) DomainOutput {
	return o
}

// The domain's ARN.
func (o DomainOutput) Arn() pulumi.StringOutput {
	return o.ApplyT(func(v *Domain) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput)
}

// The service endpoint for updating documents in a search domain.
func (o DomainOutput) DocumentServiceEndpoint() pulumi.StringOutput {
	return o.ApplyT(func(v *Domain) pulumi.StringOutput { return v.DocumentServiceEndpoint }).(pulumi.StringOutput)
}

// An internally generated unique identifier for the domain.
func (o DomainOutput) DomainId() pulumi.StringOutput {
	return o.ApplyT(func(v *Domain) pulumi.StringOutput { return v.DomainId }).(pulumi.StringOutput)
}

// Domain endpoint options. Documented below.
func (o DomainOutput) EndpointOptions() DomainEndpointOptionsOutput {
	return o.ApplyT(func(v *Domain) DomainEndpointOptionsOutput { return v.EndpointOptions }).(DomainEndpointOptionsOutput)
}

// The index fields for documents added to the domain. Documented below.
func (o DomainOutput) IndexFields() DomainIndexFieldArrayOutput {
	return o.ApplyT(func(v *Domain) DomainIndexFieldArrayOutput { return v.IndexFields }).(DomainIndexFieldArrayOutput)
}

// Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
func (o DomainOutput) MultiAz() pulumi.BoolOutput {
	return o.ApplyT(func(v *Domain) pulumi.BoolOutput { return v.MultiAz }).(pulumi.BoolOutput)
}

// The name of the CloudSearch domain.
func (o DomainOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v *Domain) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}

// Domain scaling parameters. Documented below.
func (o DomainOutput) ScalingParameters() DomainScalingParametersOutput {
	return o.ApplyT(func(v *Domain) DomainScalingParametersOutput { return v.ScalingParameters }).(DomainScalingParametersOutput)
}

// The service endpoint for requesting search results from a search domain.
func (o DomainOutput) SearchServiceEndpoint() pulumi.StringOutput {
	return o.ApplyT(func(v *Domain) pulumi.StringOutput { return v.SearchServiceEndpoint }).(pulumi.StringOutput)
}

type DomainArrayOutput struct{ *pulumi.OutputState }

func (DomainArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*Domain)(nil)).Elem()
}

func (o DomainArrayOutput) ToDomainArrayOutput() DomainArrayOutput {
	return o
}

func (o DomainArrayOutput) ToDomainArrayOutputWithContext(ctx context.Context) DomainArrayOutput {
	return o
}

func (o DomainArrayOutput) Index(i pulumi.IntInput) DomainOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *Domain {
		return vs[0].([]*Domain)[vs[1].(int)]
	}).(DomainOutput)
}

type DomainMapOutput struct{ *pulumi.OutputState }

func (DomainMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*Domain)(nil)).Elem()
}

func (o DomainMapOutput) ToDomainMapOutput() DomainMapOutput {
	return o
}

func (o DomainMapOutput) ToDomainMapOutputWithContext(ctx context.Context) DomainMapOutput {
	return o
}

func (o DomainMapOutput) MapIndex(k pulumi.StringInput) DomainOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *Domain {
		return vs[0].(map[string]*Domain)[vs[1].(string)]
	}).(DomainOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*DomainInput)(nil)).Elem(), &Domain{})
	pulumi.RegisterInputType(reflect.TypeOf((*DomainArrayInput)(nil)).Elem(), DomainArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*DomainMapInput)(nil)).Elem(), DomainMap{})
	pulumi.RegisterOutputType(DomainOutput{})
	pulumi.RegisterOutputType(DomainArrayOutput{})
	pulumi.RegisterOutputType(DomainMapOutput{})
}