com.pulumi.aws.cloudsearch.Domain Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.aws.cloudsearch;

import com.pulumi.aws.Utilities;
import com.pulumi.aws.cloudsearch.DomainArgs;
import com.pulumi.aws.cloudsearch.inputs.DomainState;
import com.pulumi.aws.cloudsearch.outputs.DomainEndpointOptions;
import com.pulumi.aws.cloudsearch.outputs.DomainIndexField;
import com.pulumi.aws.cloudsearch.outputs.DomainScalingParameters;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * Provides an CloudSearch domain resource.
 * 
 * The provider waits for the domain to become `Active` when applying a configuration.
 * 
 * ## Example Usage
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * 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());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 * ## Import
 * 
 * Using `pulumi import`, import CloudSearch Domains using the `name`. For example:
 * 
 * ```sh
 * $ pulumi import aws:cloudsearch/domain:Domain example example-domain
 * ```
 * 
 */
@ResourceType(type="aws:cloudsearch/domain:Domain")
public class Domain extends com.pulumi.resources.CustomResource {
    /**
     * The domain's ARN.
     * 
     */
    @Export(name="arn", refs={String.class}, tree="[0]")
    private Output arn;

    /**
     * @return The domain's ARN.
     * 
     */
    public Output arn() {
        return this.arn;
    }
    /**
     * The service endpoint for updating documents in a search domain.
     * 
     */
    @Export(name="documentServiceEndpoint", refs={String.class}, tree="[0]")
    private Output documentServiceEndpoint;

    /**
     * @return The service endpoint for updating documents in a search domain.
     * 
     */
    public Output documentServiceEndpoint() {
        return this.documentServiceEndpoint;
    }
    /**
     * An internally generated unique identifier for the domain.
     * 
     */
    @Export(name="domainId", refs={String.class}, tree="[0]")
    private Output domainId;

    /**
     * @return An internally generated unique identifier for the domain.
     * 
     */
    public Output domainId() {
        return this.domainId;
    }
    /**
     * Domain endpoint options. Documented below.
     * 
     */
    @Export(name="endpointOptions", refs={DomainEndpointOptions.class}, tree="[0]")
    private Output endpointOptions;

    /**
     * @return Domain endpoint options. Documented below.
     * 
     */
    public Output endpointOptions() {
        return this.endpointOptions;
    }
    /**
     * The index fields for documents added to the domain. Documented below.
     * 
     */
    @Export(name="indexFields", refs={List.class,DomainIndexField.class}, tree="[0,1]")
    private Output> indexFields;

    /**
     * @return The index fields for documents added to the domain. Documented below.
     * 
     */
    public Output>> indexFields() {
        return Codegen.optional(this.indexFields);
    }
    /**
     * Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
     * 
     */
    @Export(name="multiAz", refs={Boolean.class}, tree="[0]")
    private Output multiAz;

    /**
     * @return Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.
     * 
     */
    public Output multiAz() {
        return this.multiAz;
    }
    /**
     * The name of the CloudSearch domain.
     * 
     */
    @Export(name="name", refs={String.class}, tree="[0]")
    private Output name;

    /**
     * @return The name of the CloudSearch domain.
     * 
     */
    public Output name() {
        return this.name;
    }
    /**
     * Domain scaling parameters. Documented below.
     * 
     */
    @Export(name="scalingParameters", refs={DomainScalingParameters.class}, tree="[0]")
    private Output scalingParameters;

    /**
     * @return Domain scaling parameters. Documented below.
     * 
     */
    public Output scalingParameters() {
        return this.scalingParameters;
    }
    /**
     * The service endpoint for requesting search results from a search domain.
     * 
     */
    @Export(name="searchServiceEndpoint", refs={String.class}, tree="[0]")
    private Output searchServiceEndpoint;

    /**
     * @return The service endpoint for requesting search results from a search domain.
     * 
     */
    public Output searchServiceEndpoint() {
        return this.searchServiceEndpoint;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public Domain(java.lang.String name) {
        this(name, DomainArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public Domain(java.lang.String name, @Nullable DomainArgs args) {
        this(name, args, null);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param options A bag of options that control this resource's behavior.
     */
    public Domain(java.lang.String name, @Nullable DomainArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:cloudsearch/domain:Domain", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private Domain(java.lang.String name, Output id, @Nullable DomainState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:cloudsearch/domain:Domain", name, state, makeResourceOptions(options, id), false);
    }

    private static DomainArgs makeArgs(@Nullable DomainArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? DomainArgs.Empty : args;
    }

    private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
        var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
            .version(Utilities.getVersion())
            .build();
        return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
    }

    /**
     * Get an existing Host 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
     * @param options Optional settings to control the behavior of the CustomResource.
     */
    public static Domain get(java.lang.String name, Output id, @Nullable DomainState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new Domain(name, id, state, options);
    }
}