@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
190 lines (189 loc) • 6.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides an CloudSearch domain resource.
*
* The provider waits for the domain to become `Active` when applying a configuration.
*
* ## Example Usage
*
* ```typescript
* 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",
* },
* ],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import CloudSearch Domains using the `name`. For example:
*
* ```sh
* $ pulumi import aws:cloudsearch/domain:Domain example example-domain
* ```
*/
export declare class Domain extends pulumi.CustomResource {
/**
* Get an existing Domain resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainState, opts?: pulumi.CustomResourceOptions): Domain;
/**
* Returns true if the given object is an instance of Domain. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Domain;
/**
* The domain's ARN.
*/
readonly arn: pulumi.Output<string>;
/**
* The service endpoint for updating documents in a search domain.
*/
readonly documentServiceEndpoint: pulumi.Output<string>;
/**
* An internally generated unique identifier for the domain.
*/
readonly domainId: pulumi.Output<string>;
/**
* Domain endpoint options. Documented below.
*/
readonly endpointOptions: pulumi.Output<outputs.cloudsearch.DomainEndpointOptions>;
/**
* The index fields for documents added to the domain. Documented below.
*/
readonly indexFields: pulumi.Output<outputs.cloudsearch.DomainIndexField[] | undefined>;
/**
* Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
*/
readonly multiAz: pulumi.Output<boolean>;
/**
* The name of the CloudSearch domain.
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Domain scaling parameters. Documented below.
*/
readonly scalingParameters: pulumi.Output<outputs.cloudsearch.DomainScalingParameters>;
/**
* The service endpoint for requesting search results from a search domain.
*/
readonly searchServiceEndpoint: pulumi.Output<string>;
/**
* Create a Domain resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: DomainArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Domain resources.
*/
export interface DomainState {
/**
* The domain's ARN.
*/
arn?: pulumi.Input<string>;
/**
* The service endpoint for updating documents in a search domain.
*/
documentServiceEndpoint?: pulumi.Input<string>;
/**
* An internally generated unique identifier for the domain.
*/
domainId?: pulumi.Input<string>;
/**
* Domain endpoint options. Documented below.
*/
endpointOptions?: pulumi.Input<inputs.cloudsearch.DomainEndpointOptions>;
/**
* The index fields for documents added to the domain. Documented below.
*/
indexFields?: pulumi.Input<pulumi.Input<inputs.cloudsearch.DomainIndexField>[]>;
/**
* Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
*/
multiAz?: pulumi.Input<boolean>;
/**
* The name of the CloudSearch domain.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Domain scaling parameters. Documented below.
*/
scalingParameters?: pulumi.Input<inputs.cloudsearch.DomainScalingParameters>;
/**
* The service endpoint for requesting search results from a search domain.
*/
searchServiceEndpoint?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Domain resource.
*/
export interface DomainArgs {
/**
* Domain endpoint options. Documented below.
*/
endpointOptions?: pulumi.Input<inputs.cloudsearch.DomainEndpointOptions>;
/**
* The index fields for documents added to the domain. Documented below.
*/
indexFields?: pulumi.Input<pulumi.Input<inputs.cloudsearch.DomainIndexField>[]>;
/**
* Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
*/
multiAz?: pulumi.Input<boolean>;
/**
* The name of the CloudSearch domain.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Domain scaling parameters. Documented below.
*/
scalingParameters?: pulumi.Input<inputs.cloudsearch.DomainScalingParameters>;
}