Package com.pulumi.aws.cloudsearch

Class Domain

  • public class Domain
extends com.pulumi.resources.CustomResource
    Provides an CloudSearch domain resource. The provider waits for the domain to become `Active` when applying a configuration. ## Example Usage 
     
 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.ArrayList;
 import java.util.Arrays;
 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()
             .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())
             .name("example-domain")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import CloudSearch Domains using the `name`. For example: ```sh $ pulumi import aws:cloudsearch/domain:Domain example example-domain ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Domain​(java.lang.String name)  
      Domain​(java.lang.String name, DomainArgs args)  
      Domain​(java.lang.String name, DomainArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> documentServiceEndpoint()  
      com.pulumi.core.Output<java.lang.String> domainId()  
      com.pulumi.core.Output<DomainEndpointOptions> endpointOptions()  
      static Domain get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DomainState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.util.List<DomainIndexField>>> indexFields()  
      com.pulumi.core.Output<java.lang.Boolean> multiAz()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<DomainScalingParameters> scalingParameters()  
      com.pulumi.core.Output<java.lang.String> searchServiceEndpoint()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Domain

        public Domain​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Domain

        public Domain​(java.lang.String name,
              @Nullable
              DomainArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Domain

        public Domain​(java.lang.String name,
              @Nullable
              DomainArgs args,
              @Nullable
              com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The domain's ARN.

      • documentServiceEndpoint

        public com.pulumi.core.Output<java.lang.String> documentServiceEndpoint()
        Returns:
        The service endpoint for updating documents in a search domain.

      • domainId

        public com.pulumi.core.Output<java.lang.String> domainId()
        Returns:
        An internally generated unique identifier for the domain.

      • endpointOptions

        public com.pulumi.core.Output<DomainEndpointOptions> endpointOptions()
        Returns:
        Domain endpoint options. Documented below.

      • indexFields

        public com.pulumi.core.Output<java.util.Optional<java.util.List<DomainIndexField>>> indexFields()
        Returns:
        The index fields for documents added to the domain. Documented below.

      • multiAz

        public com.pulumi.core.Output<java.lang.Boolean> multiAz()
        Returns:
        Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the CloudSearch domain.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • scalingParameters

        public com.pulumi.core.Output<DomainScalingParameters> scalingParameters()
        Returns:
        Domain scaling parameters. Documented below.

      • searchServiceEndpoint

        public com.pulumi.core.Output<java.lang.String> searchServiceEndpoint()
        Returns:
        The service endpoint for requesting search results from a search domain.

      • get

        public static Domain get​(java.lang.String name,
                         com.pulumi.core.Output<java.lang.String> id,
                         @Nullable
                         DomainState state,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.