Package com.pulumi.aws.opensearch

Class DomainPolicy

  • public class DomainPolicy
extends com.pulumi.resources.CustomResource
    Allows setting policy to an OpenSearch domain while referencing domain attributes (e.g., ARN). ## Example 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.iam.IamFunctions;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementConditionArgs;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
 import com.pulumi.aws.opensearch.DomainPolicy;
 import com.pulumi.aws.opensearch.DomainPolicyArgs;
 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()
             .domainName("tf-test")
             .engineVersion("OpenSearch_1.1")
             .build());
 
         final var main = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
             .statements(GetPolicyDocumentStatementArgs.builder()
                 .conditions(GetPolicyDocumentStatementConditionArgs.builder()
                     .test("IpAddress")
                     .variable("aws:SourceIp")
                     .values("127.0.0.1/32")
                     .build())
                 .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                     .type("*")
                     .identifiers("*")
                     .build())
                 .effect("Allow")
                 .actions("es:*")
                 .resources(example.arn().applyValue(_arn -> String.format("%s/*", _arn)))
                 .build())
             .build());
 
         var mainDomainPolicy = new DomainPolicy("mainDomainPolicy", DomainPolicyArgs.builder()
             .domainName(example.domainName())
             .accessPolicies(main.applyValue(_main -> _main.json()))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import OpenSearch Domain Policy using `domainName` prefixed with `esd-policy-`. For example: ```sh $ pulumi import aws:opensearch/domainPolicy:DomainPolicy example esd-policy-tf-test ```

    • 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> accessPolicies()  
      com.pulumi.core.Output<java.lang.String> domainName()  
      static DomainPolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DomainPolicyState 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()  

      • 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

      • DomainPolicy

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

      • DomainPolicy

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

      • DomainPolicy

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

      • accessPolicies

        public com.pulumi.core.Output<java.lang.String> accessPolicies()
        Returns:
        IAM policy document specifying the access policies for the domain

      • domainName

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

      • get

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