cloudsearch

package
v5.43.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type 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"`
}

Provides an CloudSearch domain resource.

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

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/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{
			IndexFields: cloudsearch.DomainIndexFieldArray{
				&cloudsearch.DomainIndexFieldArgs{
					AnalysisScheme: pulumi.String("_en_default_"),
					Highlight:      pulumi.Bool(false),
					Name:           pulumi.String("headline"),
					Return:         pulumi.Bool(true),
					Search:         pulumi.Bool(true),
					Sort:           pulumi.Bool(true),
					Type:           pulumi.String("text"),
				},
				&cloudsearch.DomainIndexFieldArgs{
					Facet:        pulumi.Bool(true),
					Name:         pulumi.String("price"),
					Return:       pulumi.Bool(true),
					Search:       pulumi.Bool(true),
					Sort:         pulumi.Bool(true),
					SourceFields: pulumi.String("headline"),
					Type:         pulumi.String("double"),
				},
			},
			ScalingParameters: &cloudsearch.DomainScalingParametersArgs{
				DesiredInstanceType: pulumi.String("search.medium"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

CloudSearch Domains can be imported using the `name`, e.g.,

```sh 

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

```

func GetDomain 

func GetDomain(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DomainState, opts ...pulumi.ResourceOption) (*Domain, error)

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 NewDomain 

func NewDomain(ctx *pulumi.Context,
	name string, args *DomainArgs, opts ...pulumi.ResourceOption) (*Domain, error)

NewDomain registers a new resource with the given unique name, arguments, and options.

func (*Domain) ElementType 

func (*Domain) ElementType() reflect.Type

func (*Domain) ToDomainOutput 

func (i *Domain) ToDomainOutput() DomainOutput

func (*Domain) ToDomainOutputWithContext 

func (i *Domain) ToDomainOutputWithContext(ctx context.Context) DomainOutput

type DomainArgs 

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
}

The set of arguments for constructing a Domain resource.

func (DomainArgs) ElementType 

func (DomainArgs) ElementType() reflect.Type

type DomainArray 

type DomainArray []DomainInput

func (DomainArray) ElementType 

func (DomainArray) ElementType() reflect.Type

func (DomainArray) ToDomainArrayOutput 

func (i DomainArray) ToDomainArrayOutput() DomainArrayOutput

func (DomainArray) ToDomainArrayOutputWithContext 

func (i DomainArray) ToDomainArrayOutputWithContext(ctx context.Context) DomainArrayOutput

type DomainArrayInput 

type DomainArrayInput interface {
	pulumi.Input

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

DomainArrayInput is an input type that accepts DomainArray and DomainArrayOutput values. You can construct a concrete instance of `DomainArrayInput` via: 

DomainArray{ DomainArgs{...} }

type DomainArrayOutput 

type DomainArrayOutput struct{ *pulumi.OutputState }

func (DomainArrayOutput) ElementType 

func (DomainArrayOutput) ElementType() reflect.Type

func (DomainArrayOutput) Index 

func (o DomainArrayOutput) Index(i pulumi.IntInput) DomainOutput

func (DomainArrayOutput) ToDomainArrayOutput 

func (o DomainArrayOutput) ToDomainArrayOutput() DomainArrayOutput

func (DomainArrayOutput) ToDomainArrayOutputWithContext 

func (o DomainArrayOutput) ToDomainArrayOutputWithContext(ctx context.Context) DomainArrayOutput

type DomainEndpointOptions 

type DomainEndpointOptions struct {
	// Enables or disables the requirement that all requests to the domain arrive over HTTPS.
	EnforceHttps *bool `pulumi:"enforceHttps"`
	// The minimum required TLS version. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_DomainEndpointOptions.html) for valid values.
	TlsSecurityPolicy *string `pulumi:"tlsSecurityPolicy"`
}

type DomainEndpointOptionsArgs 

type DomainEndpointOptionsArgs struct {
	// Enables or disables the requirement that all requests to the domain arrive over HTTPS.
	EnforceHttps pulumi.BoolPtrInput `pulumi:"enforceHttps"`
	// The minimum required TLS version. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_DomainEndpointOptions.html) for valid values.
	TlsSecurityPolicy pulumi.StringPtrInput `pulumi:"tlsSecurityPolicy"`
}

func (DomainEndpointOptionsArgs) ElementType 

func (DomainEndpointOptionsArgs) ElementType() reflect.Type

func (DomainEndpointOptionsArgs) ToDomainEndpointOptionsOutput 

func (i DomainEndpointOptionsArgs) ToDomainEndpointOptionsOutput() DomainEndpointOptionsOutput

func (DomainEndpointOptionsArgs) ToDomainEndpointOptionsOutputWithContext 

func (i DomainEndpointOptionsArgs) ToDomainEndpointOptionsOutputWithContext(ctx context.Context) DomainEndpointOptionsOutput

func (DomainEndpointOptionsArgs) ToDomainEndpointOptionsPtrOutput 

func (i DomainEndpointOptionsArgs) ToDomainEndpointOptionsPtrOutput() DomainEndpointOptionsPtrOutput

func (DomainEndpointOptionsArgs) ToDomainEndpointOptionsPtrOutputWithContext 

func (i DomainEndpointOptionsArgs) ToDomainEndpointOptionsPtrOutputWithContext(ctx context.Context) DomainEndpointOptionsPtrOutput

type DomainEndpointOptionsInput 

type DomainEndpointOptionsInput interface {
	pulumi.Input

	ToDomainEndpointOptionsOutput() DomainEndpointOptionsOutput
	ToDomainEndpointOptionsOutputWithContext(context.Context) DomainEndpointOptionsOutput
}

DomainEndpointOptionsInput is an input type that accepts DomainEndpointOptionsArgs and DomainEndpointOptionsOutput values. You can construct a concrete instance of `DomainEndpointOptionsInput` via: 

DomainEndpointOptionsArgs{...}

type DomainEndpointOptionsOutput 

type DomainEndpointOptionsOutput struct{ *pulumi.OutputState }

func (DomainEndpointOptionsOutput) ElementType 

func (DomainEndpointOptionsOutput) ElementType() reflect.Type

func (DomainEndpointOptionsOutput) EnforceHttps 

func (o DomainEndpointOptionsOutput) EnforceHttps() pulumi.BoolPtrOutput

Enables or disables the requirement that all requests to the domain arrive over HTTPS.

func (DomainEndpointOptionsOutput) TlsSecurityPolicy 

func (o DomainEndpointOptionsOutput) TlsSecurityPolicy() pulumi.StringPtrOutput

The minimum required TLS version. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_DomainEndpointOptions.html) for valid values.

func (DomainEndpointOptionsOutput) ToDomainEndpointOptionsOutput 

func (o DomainEndpointOptionsOutput) ToDomainEndpointOptionsOutput() DomainEndpointOptionsOutput

func (DomainEndpointOptionsOutput) ToDomainEndpointOptionsOutputWithContext 

func (o DomainEndpointOptionsOutput) ToDomainEndpointOptionsOutputWithContext(ctx context.Context) DomainEndpointOptionsOutput

func (DomainEndpointOptionsOutput) ToDomainEndpointOptionsPtrOutput 

func (o DomainEndpointOptionsOutput) ToDomainEndpointOptionsPtrOutput() DomainEndpointOptionsPtrOutput

func (DomainEndpointOptionsOutput) ToDomainEndpointOptionsPtrOutputWithContext 

func (o DomainEndpointOptionsOutput) ToDomainEndpointOptionsPtrOutputWithContext(ctx context.Context) DomainEndpointOptionsPtrOutput

type DomainEndpointOptionsPtrInput 

type DomainEndpointOptionsPtrInput interface {
	pulumi.Input

	ToDomainEndpointOptionsPtrOutput() DomainEndpointOptionsPtrOutput
	ToDomainEndpointOptionsPtrOutputWithContext(context.Context) DomainEndpointOptionsPtrOutput
}

DomainEndpointOptionsPtrInput is an input type that accepts DomainEndpointOptionsArgs, DomainEndpointOptionsPtr and DomainEndpointOptionsPtrOutput values. You can construct a concrete instance of `DomainEndpointOptionsPtrInput` via: 

        DomainEndpointOptionsArgs{...}

or:

        nil

func DomainEndpointOptionsPtr 

func DomainEndpointOptionsPtr(v *DomainEndpointOptionsArgs) DomainEndpointOptionsPtrInput

type DomainEndpointOptionsPtrOutput 

type DomainEndpointOptionsPtrOutput struct{ *pulumi.OutputState }

func (DomainEndpointOptionsPtrOutput) Elem 

func (o DomainEndpointOptionsPtrOutput) Elem() DomainEndpointOptionsOutput

func (DomainEndpointOptionsPtrOutput) ElementType 

func (DomainEndpointOptionsPtrOutput) ElementType() reflect.Type

func (DomainEndpointOptionsPtrOutput) EnforceHttps 

func (o DomainEndpointOptionsPtrOutput) EnforceHttps() pulumi.BoolPtrOutput

Enables or disables the requirement that all requests to the domain arrive over HTTPS.

func (DomainEndpointOptionsPtrOutput) TlsSecurityPolicy 

func (o DomainEndpointOptionsPtrOutput) TlsSecurityPolicy() pulumi.StringPtrOutput

The minimum required TLS version. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_DomainEndpointOptions.html) for valid values.

func (DomainEndpointOptionsPtrOutput) ToDomainEndpointOptionsPtrOutput 

func (o DomainEndpointOptionsPtrOutput) ToDomainEndpointOptionsPtrOutput() DomainEndpointOptionsPtrOutput

func (DomainEndpointOptionsPtrOutput) ToDomainEndpointOptionsPtrOutputWithContext 

func (o DomainEndpointOptionsPtrOutput) ToDomainEndpointOptionsPtrOutputWithContext(ctx context.Context) DomainEndpointOptionsPtrOutput

type DomainIndexField 

type DomainIndexField struct {
	// 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.
	AnalysisScheme *string `pulumi:"analysisScheme"`
	// The default value for the field. This value is used when no value is specified for the field in the document data.
	DefaultValue *string `pulumi:"defaultValue"`
	// You can get facet information by enabling this.
	Facet *bool `pulumi:"facet"`
	// You can highlight information.
	Highlight *bool `pulumi:"highlight"`
	// A unique name for the field. Field names must begin with a letter and be at least 3 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.
	Name string `pulumi:"name"`
	// You can enable returning the value of all searchable fields.
	Return *bool `pulumi:"return"`
	// You can set whether this index should be searchable or not.
	Search *bool `pulumi:"search"`
	// You can enable the property to be sortable.
	Sort *bool `pulumi:"sort"`
	// 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.
	SourceFields *string `pulumi:"sourceFields"`
	// The field type. Valid values: `date`, `date-array`, `double`, `double-array`, `int`, `int-array`, `literal`, `literal-array`, `text`, `text-array`.
	Type string `pulumi:"type"`
}

type DomainIndexFieldArgs 

type DomainIndexFieldArgs struct {
	// 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.
	AnalysisScheme pulumi.StringPtrInput `pulumi:"analysisScheme"`
	// The default value for the field. This value is used when no value is specified for the field in the document data.
	DefaultValue pulumi.StringPtrInput `pulumi:"defaultValue"`
	// You can get facet information by enabling this.
	Facet pulumi.BoolPtrInput `pulumi:"facet"`
	// You can highlight information.
	Highlight pulumi.BoolPtrInput `pulumi:"highlight"`
	// A unique name for the field. Field names must begin with a letter and be at least 3 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.
	Name pulumi.StringInput `pulumi:"name"`
	// You can enable returning the value of all searchable fields.
	Return pulumi.BoolPtrInput `pulumi:"return"`
	// You can set whether this index should be searchable or not.
	Search pulumi.BoolPtrInput `pulumi:"search"`
	// You can enable the property to be sortable.
	Sort pulumi.BoolPtrInput `pulumi:"sort"`
	// 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.
	SourceFields pulumi.StringPtrInput `pulumi:"sourceFields"`
	// The field type. Valid values: `date`, `date-array`, `double`, `double-array`, `int`, `int-array`, `literal`, `literal-array`, `text`, `text-array`.
	Type pulumi.StringInput `pulumi:"type"`
}

func (DomainIndexFieldArgs) ElementType 

func (DomainIndexFieldArgs) ElementType() reflect.Type

func (DomainIndexFieldArgs) ToDomainIndexFieldOutput 

func (i DomainIndexFieldArgs) ToDomainIndexFieldOutput() DomainIndexFieldOutput

func (DomainIndexFieldArgs) ToDomainIndexFieldOutputWithContext 

func (i DomainIndexFieldArgs) ToDomainIndexFieldOutputWithContext(ctx context.Context) DomainIndexFieldOutput

type DomainIndexFieldArray 

type DomainIndexFieldArray []DomainIndexFieldInput

func (DomainIndexFieldArray) ElementType 

func (DomainIndexFieldArray) ElementType() reflect.Type

func (DomainIndexFieldArray) ToDomainIndexFieldArrayOutput 

func (i DomainIndexFieldArray) ToDomainIndexFieldArrayOutput() DomainIndexFieldArrayOutput

func (DomainIndexFieldArray) ToDomainIndexFieldArrayOutputWithContext 

func (i DomainIndexFieldArray) ToDomainIndexFieldArrayOutputWithContext(ctx context.Context) DomainIndexFieldArrayOutput

type DomainIndexFieldArrayInput 

type DomainIndexFieldArrayInput interface {
	pulumi.Input

	ToDomainIndexFieldArrayOutput() DomainIndexFieldArrayOutput
	ToDomainIndexFieldArrayOutputWithContext(context.Context) DomainIndexFieldArrayOutput
}

DomainIndexFieldArrayInput is an input type that accepts DomainIndexFieldArray and DomainIndexFieldArrayOutput values. You can construct a concrete instance of `DomainIndexFieldArrayInput` via: 

DomainIndexFieldArray{ DomainIndexFieldArgs{...} }

type DomainIndexFieldArrayOutput 

type DomainIndexFieldArrayOutput struct{ *pulumi.OutputState }

func (DomainIndexFieldArrayOutput) ElementType 

func (DomainIndexFieldArrayOutput) ElementType() reflect.Type

func (DomainIndexFieldArrayOutput) Index 

func (o DomainIndexFieldArrayOutput) Index(i pulumi.IntInput) DomainIndexFieldOutput

func (DomainIndexFieldArrayOutput) ToDomainIndexFieldArrayOutput 

func (o DomainIndexFieldArrayOutput) ToDomainIndexFieldArrayOutput() DomainIndexFieldArrayOutput

func (DomainIndexFieldArrayOutput) ToDomainIndexFieldArrayOutputWithContext 

func (o DomainIndexFieldArrayOutput) ToDomainIndexFieldArrayOutputWithContext(ctx context.Context) DomainIndexFieldArrayOutput

type DomainIndexFieldInput 

type DomainIndexFieldInput interface {
	pulumi.Input

	ToDomainIndexFieldOutput() DomainIndexFieldOutput
	ToDomainIndexFieldOutputWithContext(context.Context) DomainIndexFieldOutput
}

DomainIndexFieldInput is an input type that accepts DomainIndexFieldArgs and DomainIndexFieldOutput values. You can construct a concrete instance of `DomainIndexFieldInput` via: 

DomainIndexFieldArgs{...}

type DomainIndexFieldOutput 

type DomainIndexFieldOutput struct{ *pulumi.OutputState }

func (DomainIndexFieldOutput) AnalysisScheme 

func (o DomainIndexFieldOutput) AnalysisScheme() pulumi.StringPtrOutput

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.

func (DomainIndexFieldOutput) DefaultValue 

func (o DomainIndexFieldOutput) DefaultValue() pulumi.StringPtrOutput

The default value for the field. This value is used when no value is specified for the field in the document data.

func (DomainIndexFieldOutput) ElementType 

func (DomainIndexFieldOutput) ElementType() reflect.Type

func (DomainIndexFieldOutput) Facet 

func (o DomainIndexFieldOutput) Facet() pulumi.BoolPtrOutput

You can get facet information by enabling this.

func (DomainIndexFieldOutput) Highlight 

func (o DomainIndexFieldOutput) Highlight() pulumi.BoolPtrOutput

You can highlight information.

func (DomainIndexFieldOutput) Name 

func (o DomainIndexFieldOutput) Name() pulumi.StringOutput

A unique name for the field. Field names must begin with a letter and be at least 3 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.

func (DomainIndexFieldOutput) Return 

func (o DomainIndexFieldOutput) Return() pulumi.BoolPtrOutput

You can enable returning the value of all searchable fields.

func (DomainIndexFieldOutput) Search 

func (o DomainIndexFieldOutput) Search() pulumi.BoolPtrOutput

You can set whether this index should be searchable or not.

func (DomainIndexFieldOutput) Sort 

func (o DomainIndexFieldOutput) Sort() pulumi.BoolPtrOutput

You can enable the property to be sortable.

func (DomainIndexFieldOutput) SourceFields added in v5.6.0 

func (o DomainIndexFieldOutput) SourceFields() pulumi.StringPtrOutput

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.

func (DomainIndexFieldOutput) ToDomainIndexFieldOutput 

func (o DomainIndexFieldOutput) ToDomainIndexFieldOutput() DomainIndexFieldOutput

func (DomainIndexFieldOutput) ToDomainIndexFieldOutputWithContext 

func (o DomainIndexFieldOutput) ToDomainIndexFieldOutputWithContext(ctx context.Context) DomainIndexFieldOutput

func (DomainIndexFieldOutput) Type 

func (o DomainIndexFieldOutput) Type() pulumi.StringOutput

The field type. Valid values: `date`, `date-array`, `double`, `double-array`, `int`, `int-array`, `literal`, `literal-array`, `text`, `text-array`.

type DomainInput 

type DomainInput interface {
	pulumi.Input

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

type DomainMap 

type DomainMap map[string]DomainInput

func (DomainMap) ElementType 

func (DomainMap) ElementType() reflect.Type

func (DomainMap) ToDomainMapOutput 

func (i DomainMap) ToDomainMapOutput() DomainMapOutput

func (DomainMap) ToDomainMapOutputWithContext 

func (i DomainMap) ToDomainMapOutputWithContext(ctx context.Context) DomainMapOutput

type DomainMapInput 

type DomainMapInput interface {
	pulumi.Input

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

DomainMapInput is an input type that accepts DomainMap and DomainMapOutput values. You can construct a concrete instance of `DomainMapInput` via: 

DomainMap{ "key": DomainArgs{...} }

type DomainMapOutput 

type DomainMapOutput struct{ *pulumi.OutputState }

func (DomainMapOutput) ElementType 

func (DomainMapOutput) ElementType() reflect.Type

func (DomainMapOutput) MapIndex 

func (o DomainMapOutput) MapIndex(k pulumi.StringInput) DomainOutput

func (DomainMapOutput) ToDomainMapOutput 

func (o DomainMapOutput) ToDomainMapOutput() DomainMapOutput

func (DomainMapOutput) ToDomainMapOutputWithContext 

func (o DomainMapOutput) ToDomainMapOutputWithContext(ctx context.Context) DomainMapOutput

type DomainOutput 

type DomainOutput struct{ *pulumi.OutputState }

func (DomainOutput) Arn added in v5.4.0 

func (o DomainOutput) Arn() pulumi.StringOutput

The domain's ARN.

func (DomainOutput) DocumentServiceEndpoint added in v5.4.0 

func (o DomainOutput) DocumentServiceEndpoint() pulumi.StringOutput

The service endpoint for updating documents in a search domain.

func (DomainOutput) DomainId added in v5.4.0 

func (o DomainOutput) DomainId() pulumi.StringOutput

An internally generated unique identifier for the domain.

func (DomainOutput) ElementType 

func (DomainOutput) ElementType() reflect.Type

func (DomainOutput) EndpointOptions added in v5.4.0 

func (o DomainOutput) EndpointOptions() DomainEndpointOptionsOutput

Domain endpoint options. Documented below.

func (DomainOutput) IndexFields added in v5.4.0 

func (o DomainOutput) IndexFields() DomainIndexFieldArrayOutput

The index fields for documents added to the domain. Documented below.

func (DomainOutput) MultiAz added in v5.4.0 

func (o DomainOutput) MultiAz() pulumi.BoolOutput

Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.

func (DomainOutput) Name added in v5.4.0 

func (o DomainOutput) Name() pulumi.StringOutput

The name of the CloudSearch domain.

func (DomainOutput) ScalingParameters added in v5.4.0 

func (o DomainOutput) ScalingParameters() DomainScalingParametersOutput

Domain scaling parameters. Documented below.

func (DomainOutput) SearchServiceEndpoint added in v5.4.0 

func (o DomainOutput) SearchServiceEndpoint() pulumi.StringOutput

The service endpoint for requesting search results from a search domain.

func (DomainOutput) ToDomainOutput 

func (o DomainOutput) ToDomainOutput() DomainOutput

func (DomainOutput) ToDomainOutputWithContext 

func (o DomainOutput) ToDomainOutputWithContext(ctx context.Context) DomainOutput

type DomainScalingParameters 

type DomainScalingParameters struct {
	// The instance type that you want to preconfigure for your domain. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_ScalingParameters.html) for valid values.
	DesiredInstanceType *string `pulumi:"desiredInstanceType"`
	// The number of partitions you want to preconfigure for your domain. Only valid when you select `search.2xlarge` as the instance type.
	DesiredPartitionCount *int `pulumi:"desiredPartitionCount"`
	// The number of replicas you want to preconfigure for each index partition.
	DesiredReplicationCount *int `pulumi:"desiredReplicationCount"`
}

type DomainScalingParametersArgs 

type DomainScalingParametersArgs struct {
	// The instance type that you want to preconfigure for your domain. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_ScalingParameters.html) for valid values.
	DesiredInstanceType pulumi.StringPtrInput `pulumi:"desiredInstanceType"`
	// The number of partitions you want to preconfigure for your domain. Only valid when you select `search.2xlarge` as the instance type.
	DesiredPartitionCount pulumi.IntPtrInput `pulumi:"desiredPartitionCount"`
	// The number of replicas you want to preconfigure for each index partition.
	DesiredReplicationCount pulumi.IntPtrInput `pulumi:"desiredReplicationCount"`
}

func (DomainScalingParametersArgs) ElementType 

func (DomainScalingParametersArgs) ElementType() reflect.Type

func (DomainScalingParametersArgs) ToDomainScalingParametersOutput 

func (i DomainScalingParametersArgs) ToDomainScalingParametersOutput() DomainScalingParametersOutput

func (DomainScalingParametersArgs) ToDomainScalingParametersOutputWithContext 

func (i DomainScalingParametersArgs) ToDomainScalingParametersOutputWithContext(ctx context.Context) DomainScalingParametersOutput

func (DomainScalingParametersArgs) ToDomainScalingParametersPtrOutput 

func (i DomainScalingParametersArgs) ToDomainScalingParametersPtrOutput() DomainScalingParametersPtrOutput

func (DomainScalingParametersArgs) ToDomainScalingParametersPtrOutputWithContext 

func (i DomainScalingParametersArgs) ToDomainScalingParametersPtrOutputWithContext(ctx context.Context) DomainScalingParametersPtrOutput

type DomainScalingParametersInput 

type DomainScalingParametersInput interface {
	pulumi.Input

	ToDomainScalingParametersOutput() DomainScalingParametersOutput
	ToDomainScalingParametersOutputWithContext(context.Context) DomainScalingParametersOutput
}

DomainScalingParametersInput is an input type that accepts DomainScalingParametersArgs and DomainScalingParametersOutput values. You can construct a concrete instance of `DomainScalingParametersInput` via: 

DomainScalingParametersArgs{...}

type DomainScalingParametersOutput 

type DomainScalingParametersOutput struct{ *pulumi.OutputState }

func (DomainScalingParametersOutput) DesiredInstanceType 

func (o DomainScalingParametersOutput) DesiredInstanceType() pulumi.StringPtrOutput

The instance type that you want to preconfigure for your domain. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_ScalingParameters.html) for valid values.

func (DomainScalingParametersOutput) DesiredPartitionCount 

func (o DomainScalingParametersOutput) DesiredPartitionCount() pulumi.IntPtrOutput

The number of partitions you want to preconfigure for your domain. Only valid when you select `search.2xlarge` as the instance type.

func (DomainScalingParametersOutput) DesiredReplicationCount 

func (o DomainScalingParametersOutput) DesiredReplicationCount() pulumi.IntPtrOutput

The number of replicas you want to preconfigure for each index partition.

func (DomainScalingParametersOutput) ElementType 

func (DomainScalingParametersOutput) ElementType() reflect.Type

func (DomainScalingParametersOutput) ToDomainScalingParametersOutput 

func (o DomainScalingParametersOutput) ToDomainScalingParametersOutput() DomainScalingParametersOutput

func (DomainScalingParametersOutput) ToDomainScalingParametersOutputWithContext 

func (o DomainScalingParametersOutput) ToDomainScalingParametersOutputWithContext(ctx context.Context) DomainScalingParametersOutput

func (DomainScalingParametersOutput) ToDomainScalingParametersPtrOutput 

func (o DomainScalingParametersOutput) ToDomainScalingParametersPtrOutput() DomainScalingParametersPtrOutput

func (DomainScalingParametersOutput) ToDomainScalingParametersPtrOutputWithContext 

func (o DomainScalingParametersOutput) ToDomainScalingParametersPtrOutputWithContext(ctx context.Context) DomainScalingParametersPtrOutput

type DomainScalingParametersPtrInput 

type DomainScalingParametersPtrInput interface {
	pulumi.Input

	ToDomainScalingParametersPtrOutput() DomainScalingParametersPtrOutput
	ToDomainScalingParametersPtrOutputWithContext(context.Context) DomainScalingParametersPtrOutput
}

DomainScalingParametersPtrInput is an input type that accepts DomainScalingParametersArgs, DomainScalingParametersPtr and DomainScalingParametersPtrOutput values. You can construct a concrete instance of `DomainScalingParametersPtrInput` via: 

        DomainScalingParametersArgs{...}

or:

        nil

func DomainScalingParametersPtr 

func DomainScalingParametersPtr(v *DomainScalingParametersArgs) DomainScalingParametersPtrInput

type DomainScalingParametersPtrOutput 

type DomainScalingParametersPtrOutput struct{ *pulumi.OutputState }

func (DomainScalingParametersPtrOutput) DesiredInstanceType 

func (o DomainScalingParametersPtrOutput) DesiredInstanceType() pulumi.StringPtrOutput

The instance type that you want to preconfigure for your domain. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_ScalingParameters.html) for valid values.

func (DomainScalingParametersPtrOutput) DesiredPartitionCount 

func (o DomainScalingParametersPtrOutput) DesiredPartitionCount() pulumi.IntPtrOutput

The number of partitions you want to preconfigure for your domain. Only valid when you select `search.2xlarge` as the instance type.

func (DomainScalingParametersPtrOutput) DesiredReplicationCount 

func (o DomainScalingParametersPtrOutput) DesiredReplicationCount() pulumi.IntPtrOutput

The number of replicas you want to preconfigure for each index partition.

func (DomainScalingParametersPtrOutput) Elem 

func (o DomainScalingParametersPtrOutput) Elem() DomainScalingParametersOutput

func (DomainScalingParametersPtrOutput) ElementType 

func (DomainScalingParametersPtrOutput) ElementType() reflect.Type

func (DomainScalingParametersPtrOutput) ToDomainScalingParametersPtrOutput 

func (o DomainScalingParametersPtrOutput) ToDomainScalingParametersPtrOutput() DomainScalingParametersPtrOutput

func (DomainScalingParametersPtrOutput) ToDomainScalingParametersPtrOutputWithContext 

func (o DomainScalingParametersPtrOutput) ToDomainScalingParametersPtrOutputWithContext(ctx context.Context) DomainScalingParametersPtrOutput

type DomainServiceAccessPolicy 

type DomainServiceAccessPolicy struct {
	pulumi.CustomResourceState

	// The access rules you want to configure. These rules replace any existing rules. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) for details.
	AccessPolicy pulumi.StringOutput `pulumi:"accessPolicy"`
	// The CloudSearch domain name the policy applies to.
	DomainName pulumi.StringOutput `pulumi:"domainName"`
}

Provides an CloudSearch domain service access policy resource.

The provider waits for the domain service access policy to become `Active` when applying a configuration.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/cloudsearch"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleDomain, err := cloudsearch.NewDomain(ctx, "exampleDomain", nil)
		if err != nil {
			return err
		}
		examplePolicyDocument, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				{
					Sid:    pulumi.StringRef("search_only"),
					Effect: pulumi.StringRef("Allow"),
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Type: "*",
							Identifiers: []string{
								"*",
							},
						},
					},
					Actions: []string{
						"cloudsearch:search",
						"cloudsearch:document",
					},
					Conditions: []iam.GetPolicyDocumentStatementCondition{
						{
							Test:     "IpAddress",
							Variable: "aws:SourceIp",
							Values: []string{
								"192.0.2.0/32",
							},
						},
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = cloudsearch.NewDomainServiceAccessPolicy(ctx, "exampleDomainServiceAccessPolicy", &cloudsearch.DomainServiceAccessPolicyArgs{
			DomainName:   exampleDomain.ID(),
			AccessPolicy: *pulumi.String(examplePolicyDocument.Json),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

CloudSearch domain service access policies can be imported using the domain name, e.g.,

```sh 

$ pulumi import aws:cloudsearch/domainServiceAccessPolicy:DomainServiceAccessPolicy example example-domain

```

func GetDomainServiceAccessPolicy 

func GetDomainServiceAccessPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DomainServiceAccessPolicyState, opts ...pulumi.ResourceOption) (*DomainServiceAccessPolicy, error)

GetDomainServiceAccessPolicy gets an existing DomainServiceAccessPolicy 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 NewDomainServiceAccessPolicy 

func NewDomainServiceAccessPolicy(ctx *pulumi.Context,
	name string, args *DomainServiceAccessPolicyArgs, opts ...pulumi.ResourceOption) (*DomainServiceAccessPolicy, error)

NewDomainServiceAccessPolicy registers a new resource with the given unique name, arguments, and options.

func (*DomainServiceAccessPolicy) ElementType 

func (*DomainServiceAccessPolicy) ElementType() reflect.Type

func (*DomainServiceAccessPolicy) ToDomainServiceAccessPolicyOutput 

func (i *DomainServiceAccessPolicy) ToDomainServiceAccessPolicyOutput() DomainServiceAccessPolicyOutput

func (*DomainServiceAccessPolicy) ToDomainServiceAccessPolicyOutputWithContext 

func (i *DomainServiceAccessPolicy) ToDomainServiceAccessPolicyOutputWithContext(ctx context.Context) DomainServiceAccessPolicyOutput

type DomainServiceAccessPolicyArgs 

type DomainServiceAccessPolicyArgs struct {
	// The access rules you want to configure. These rules replace any existing rules. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) for details.
	AccessPolicy pulumi.StringInput
	// The CloudSearch domain name the policy applies to.
	DomainName pulumi.StringInput
}

The set of arguments for constructing a DomainServiceAccessPolicy resource.

func (DomainServiceAccessPolicyArgs) ElementType 

func (DomainServiceAccessPolicyArgs) ElementType() reflect.Type

type DomainServiceAccessPolicyArray 

type DomainServiceAccessPolicyArray []DomainServiceAccessPolicyInput

func (DomainServiceAccessPolicyArray) ElementType 

func (DomainServiceAccessPolicyArray) ElementType() reflect.Type

func (DomainServiceAccessPolicyArray) ToDomainServiceAccessPolicyArrayOutput 

func (i DomainServiceAccessPolicyArray) ToDomainServiceAccessPolicyArrayOutput() DomainServiceAccessPolicyArrayOutput

func (DomainServiceAccessPolicyArray) ToDomainServiceAccessPolicyArrayOutputWithContext 

func (i DomainServiceAccessPolicyArray) ToDomainServiceAccessPolicyArrayOutputWithContext(ctx context.Context) DomainServiceAccessPolicyArrayOutput

type DomainServiceAccessPolicyArrayInput 

type DomainServiceAccessPolicyArrayInput interface {
	pulumi.Input

	ToDomainServiceAccessPolicyArrayOutput() DomainServiceAccessPolicyArrayOutput
	ToDomainServiceAccessPolicyArrayOutputWithContext(context.Context) DomainServiceAccessPolicyArrayOutput
}

DomainServiceAccessPolicyArrayInput is an input type that accepts DomainServiceAccessPolicyArray and DomainServiceAccessPolicyArrayOutput values. You can construct a concrete instance of `DomainServiceAccessPolicyArrayInput` via: 

DomainServiceAccessPolicyArray{ DomainServiceAccessPolicyArgs{...} }

type DomainServiceAccessPolicyArrayOutput 

type DomainServiceAccessPolicyArrayOutput struct{ *pulumi.OutputState }

func (DomainServiceAccessPolicyArrayOutput) ElementType 

func (DomainServiceAccessPolicyArrayOutput) ElementType() reflect.Type

func (DomainServiceAccessPolicyArrayOutput) Index 

func (o DomainServiceAccessPolicyArrayOutput) Index(i pulumi.IntInput) DomainServiceAccessPolicyOutput

func (DomainServiceAccessPolicyArrayOutput) ToDomainServiceAccessPolicyArrayOutput 

func (o DomainServiceAccessPolicyArrayOutput) ToDomainServiceAccessPolicyArrayOutput() DomainServiceAccessPolicyArrayOutput

func (DomainServiceAccessPolicyArrayOutput) ToDomainServiceAccessPolicyArrayOutputWithContext 

func (o DomainServiceAccessPolicyArrayOutput) ToDomainServiceAccessPolicyArrayOutputWithContext(ctx context.Context) DomainServiceAccessPolicyArrayOutput

type DomainServiceAccessPolicyInput 

type DomainServiceAccessPolicyInput interface {
	pulumi.Input

	ToDomainServiceAccessPolicyOutput() DomainServiceAccessPolicyOutput
	ToDomainServiceAccessPolicyOutputWithContext(ctx context.Context) DomainServiceAccessPolicyOutput
}

type DomainServiceAccessPolicyMap 

type DomainServiceAccessPolicyMap map[string]DomainServiceAccessPolicyInput

func (DomainServiceAccessPolicyMap) ElementType 

func (DomainServiceAccessPolicyMap) ElementType() reflect.Type

func (DomainServiceAccessPolicyMap) ToDomainServiceAccessPolicyMapOutput 

func (i DomainServiceAccessPolicyMap) ToDomainServiceAccessPolicyMapOutput() DomainServiceAccessPolicyMapOutput

func (DomainServiceAccessPolicyMap) ToDomainServiceAccessPolicyMapOutputWithContext 

func (i DomainServiceAccessPolicyMap) ToDomainServiceAccessPolicyMapOutputWithContext(ctx context.Context) DomainServiceAccessPolicyMapOutput

type DomainServiceAccessPolicyMapInput 

type DomainServiceAccessPolicyMapInput interface {
	pulumi.Input

	ToDomainServiceAccessPolicyMapOutput() DomainServiceAccessPolicyMapOutput
	ToDomainServiceAccessPolicyMapOutputWithContext(context.Context) DomainServiceAccessPolicyMapOutput
}

DomainServiceAccessPolicyMapInput is an input type that accepts DomainServiceAccessPolicyMap and DomainServiceAccessPolicyMapOutput values. You can construct a concrete instance of `DomainServiceAccessPolicyMapInput` via: 

DomainServiceAccessPolicyMap{ "key": DomainServiceAccessPolicyArgs{...} }

type DomainServiceAccessPolicyMapOutput 

type DomainServiceAccessPolicyMapOutput struct{ *pulumi.OutputState }

func (DomainServiceAccessPolicyMapOutput) ElementType 

func (DomainServiceAccessPolicyMapOutput) ElementType() reflect.Type

func (DomainServiceAccessPolicyMapOutput) MapIndex 

func (o DomainServiceAccessPolicyMapOutput) MapIndex(k pulumi.StringInput) DomainServiceAccessPolicyOutput

func (DomainServiceAccessPolicyMapOutput) ToDomainServiceAccessPolicyMapOutput 

func (o DomainServiceAccessPolicyMapOutput) ToDomainServiceAccessPolicyMapOutput() DomainServiceAccessPolicyMapOutput

func (DomainServiceAccessPolicyMapOutput) ToDomainServiceAccessPolicyMapOutputWithContext 

func (o DomainServiceAccessPolicyMapOutput) ToDomainServiceAccessPolicyMapOutputWithContext(ctx context.Context) DomainServiceAccessPolicyMapOutput

type DomainServiceAccessPolicyOutput 

type DomainServiceAccessPolicyOutput struct{ *pulumi.OutputState }

func (DomainServiceAccessPolicyOutput) AccessPolicy added in v5.4.0 

func (o DomainServiceAccessPolicyOutput) AccessPolicy() pulumi.StringOutput

The access rules you want to configure. These rules replace any existing rules. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) for details.

func (DomainServiceAccessPolicyOutput) DomainName added in v5.4.0 

func (o DomainServiceAccessPolicyOutput) DomainName() pulumi.StringOutput

The CloudSearch domain name the policy applies to.

func (DomainServiceAccessPolicyOutput) ElementType 

func (DomainServiceAccessPolicyOutput) ElementType() reflect.Type

func (DomainServiceAccessPolicyOutput) ToDomainServiceAccessPolicyOutput 

func (o DomainServiceAccessPolicyOutput) ToDomainServiceAccessPolicyOutput() DomainServiceAccessPolicyOutput

func (DomainServiceAccessPolicyOutput) ToDomainServiceAccessPolicyOutputWithContext 

func (o DomainServiceAccessPolicyOutput) ToDomainServiceAccessPolicyOutputWithContext(ctx context.Context) DomainServiceAccessPolicyOutput

type DomainServiceAccessPolicyState 

type DomainServiceAccessPolicyState struct {
	// The access rules you want to configure. These rules replace any existing rules. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) for details.
	AccessPolicy pulumi.StringPtrInput
	// The CloudSearch domain name the policy applies to.
	DomainName pulumi.StringPtrInput
}

func (DomainServiceAccessPolicyState) ElementType 

func (DomainServiceAccessPolicyState) ElementType() reflect.Type

type DomainState 

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 

func (DomainState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.