Package com.pulumi.aws.opensearchingest

Class ResourcePolicy

  • public class ResourcePolicy
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS OpenSearch Ingestion Resource Policy. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.AwsFunctions;
 import com.pulumi.aws.inputs.GetCallerIdentityArgs;
 import com.pulumi.aws.opensearchingest.Pipeline;
 import com.pulumi.aws.opensearchingest.PipelineArgs;
 import com.pulumi.aws.opensearchingest.ResourcePolicy;
 import com.pulumi.aws.opensearchingest.ResourcePolicyArgs;
 import static com.pulumi.codegen.internal.Serialization.*;
 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) {
         final var current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
             .build());
 
         var examplePipeline = new Pipeline("examplePipeline", PipelineArgs.builder()
             .pipelineName("example")
             .pipelineConfigurationBody("""
 version: \"2\"
 example-pipeline:
   source:
     http:
       path: \"/example\"
   sink:
     - s3:
         aws:
           sts_role_arn: \"arn:aws:iam::%s:role/Example\"
           region: \"us-east-1\"
         bucket: \"example\"
         threshold:
           event_collect_timeout: \"60s\"
         codec:
           ndjson:
 ", current.accountId()))
             .maxUnits(1)
             .minUnits(1)
             .build());
 
         var example = new ResourcePolicy("example", ResourcePolicyArgs.builder()
             .resourceArn(examplePipeline.pipelineArn())
             .policy(examplePipeline.pipelineArn().applyValue(_pipelineArn -> serializeJson(
                 jsonObject(
                     jsonProperty("Version", "2012-10-17"),
                     jsonProperty("Statement", jsonArray(jsonObject(
                         jsonProperty("Effect", "Allow"),
                         jsonProperty("Principal", jsonObject(
                             jsonProperty("AWS", String.format("arn:aws:iam::%s:root", current.accountId()))
                         )),
                         jsonProperty("Action", "osis:CreatePipelineEndpoint"),
                         jsonProperty("Resource", _pipelineArn)
                     )))
                 ))))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `resourceArn` (String) ARN of the resource the policy is attached to. Using `pulumi import`, import OpenSearch Ingestion Resource Policy using the `resourceArn`. For example: ```sh $ pulumi import aws:opensearchingest/resourcePolicy:ResourcePolicy example arn:aws:osis:us-east-1:123456789012:pipeline/example ```

    • 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
      static ResourcePolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ResourcePolicyState 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> policy()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> resourceArn()  

      • 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

      • ResourcePolicy

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

      • ResourcePolicy

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

      • ResourcePolicy

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

      • policy

        public com.pulumi.core.Output<java.lang.String> policy()
        Returns:
        JSON-formatted policy to attach to the resource.

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

      • resourceArn

        public com.pulumi.core.Output<java.lang.String> resourceArn()
        Returns:
        ARN of the resource to attach the policy to. The following arguments are optional:

      • get

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