Package com.pulumi.aws.opensearch

Class DomainSamlOptions

  • public class DomainSamlOptions
extends com.pulumi.resources.CustomResource
    Manages SAML authentication options for an AWS OpenSearch Domain. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.opensearch.Domain;
 import com.pulumi.aws.opensearch.DomainArgs;
 import com.pulumi.aws.opensearch.inputs.DomainClusterConfigArgs;
 import com.pulumi.aws.opensearch.inputs.DomainSnapshotOptionsArgs;
 import com.pulumi.aws.opensearch.DomainSamlOptions;
 import com.pulumi.aws.opensearch.DomainSamlOptionsArgs;
 import com.pulumi.aws.opensearch.inputs.DomainSamlOptionsSamlOptionsArgs;
 import com.pulumi.aws.opensearch.inputs.DomainSamlOptionsSamlOptionsIdpArgs;
 import com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.FileArgs;
 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()
             .clusterConfig(DomainClusterConfigArgs.builder()
                 .instanceType("r4.large.search")
                 .build())
             .snapshotOptions(DomainSnapshotOptionsArgs.builder()
                 .automatedSnapshotStartHour(23)
                 .build())
             .domainName("example")
             .engineVersion("OpenSearch_1.1")
             .tags(Map.of("Domain", "TestDomain"))
             .build());
 
         var exampleDomainSamlOptions = new DomainSamlOptions("exampleDomainSamlOptions", DomainSamlOptionsArgs.builder()
             .samlOptions(DomainSamlOptionsSamlOptionsArgs.builder()
                 .idp(DomainSamlOptionsSamlOptionsIdpArgs.builder()
                     .entityId("https://example.com")
                     .metadataContent(StdFunctions.file(FileArgs.builder()
                         .input("./saml-metadata.xml")
                         .build()).result())
                     .build())
                 .enabled(true)
                 .build())
             .domainName(example.domainName())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import OpenSearch domains using the `domainName`. For example: ```sh $ pulumi import aws:opensearch/domainSamlOptions:DomainSamlOptions example domain_name ```

    • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> domainName()  
      static DomainSamlOptions get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DomainSamlOptionsState 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.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<DomainSamlOptionsSamlOptions>> samlOptions()  

      • 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

      • DomainSamlOptions

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

      • DomainSamlOptions

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

      • DomainSamlOptions

        public DomainSamlOptions​(java.lang.String name,
                         DomainSamlOptionsArgs 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

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        Name of the domain. The following arguments are optional:

      • 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.

      • samlOptions

        public com.pulumi.core.Output<java.util.Optional<DomainSamlOptionsSamlOptions>> samlOptions()
        Returns:
        SAML authentication options for an AWS OpenSearch Domain.

      • get

        public static DomainSamlOptions get​(java.lang.String name,
                                    com.pulumi.core.Output<java.lang.String> id,
                                    @Nullable
                                    DomainSamlOptionsState 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.