Package com.pulumi.aws.opensearchingest

Class Pipeline

  • public class Pipeline
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS OpenSearch Ingestion Pipeline. ## 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.GetRegionArgs;
 import com.pulumi.aws.iam.Role;
 import com.pulumi.aws.iam.RoleArgs;
 import com.pulumi.aws.opensearchingest.Pipeline;
 import com.pulumi.aws.opensearchingest.PipelineArgs;
 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.getRegion(GetRegionArgs.builder()
             .build());
 
         var exampleRole = new Role("exampleRole", RoleArgs.builder()
             .assumeRolePolicy(serializeJson(
                 jsonObject(
                     jsonProperty("Version", "2012-10-17"),
                     jsonProperty("Statement", jsonArray(jsonObject(
                         jsonProperty("Action", "sts:AssumeRole"),
                         jsonProperty("Effect", "Allow"),
                         jsonProperty("Sid", ""),
                         jsonProperty("Principal", jsonObject(
                             jsonProperty("Service", "osis-pipelines.amazonaws.com")
                         ))
                     )))
                 )))
             .build());
 
         var example = new Pipeline("example", PipelineArgs.builder()
             .pipelineName("example")
             .pipelineConfigurationBody(exampleRole.arn().applyValue(_arn -> """
 version: \"2\"
 example-pipeline:
   source:
     http:
       path: \"/example\"
   sink:
     - s3:
         aws:
           sts_role_arn: \"%s\"
           region: \"%s\"
         bucket: \"example\"
         threshold:
           event_collect_timeout: \"60s\"
         codec:
           ndjson:
 ", _arn,current.region())))
             .maxUnits(1)
             .minUnits(1)
             .build());
 
     }
 }
    ### Using file function 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.opensearchingest.Pipeline;
 import com.pulumi.aws.opensearchingest.PipelineArgs;
 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 Pipeline("example", PipelineArgs.builder()
             .pipelineName("example")
             .pipelineConfigurationBody(StdFunctions.file(FileArgs.builder()
                 .input("example.yaml")
                 .build()).result())
             .maxUnits(1)
             .minUnits(1)
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `name` (String) Name of the pipeline. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import OpenSearch Ingestion Pipeline using the `pipelineName`. For example: ```sh $ pulumi import aws:opensearchingest/pipeline:Pipeline example 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Pipeline​(java.lang.String name)  
      Pipeline​(java.lang.String name, PipelineArgs args)  
      Pipeline​(java.lang.String name, PipelineArgs 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.util.Optional<PipelineBufferOptions>> bufferOptions()  
      com.pulumi.core.Output<java.util.Optional<PipelineEncryptionAtRestOptions>> encryptionAtRestOptions()  
      static Pipeline get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PipelineState 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.List<java.lang.String>> ingestEndpointUrls()  
      com.pulumi.core.Output<java.util.Optional<PipelineLogPublishingOptions>> logPublishingOptions()  
      com.pulumi.core.Output<java.lang.Integer> maxUnits()  
      com.pulumi.core.Output<java.lang.Integer> minUnits()  
      com.pulumi.core.Output<java.lang.String> pipelineArn()  
      com.pulumi.core.Output<java.lang.String> pipelineConfigurationBody()  
      com.pulumi.core.Output<java.lang.String> pipelineName()  
      com.pulumi.core.Output<java.lang.String> pipelineRoleArn()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<PipelineTimeouts>> timeouts()  
      com.pulumi.core.Output<java.util.Optional<PipelineVpcOptions>> vpcOptions()  

      • 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

      • Pipeline

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

      • Pipeline

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

      • Pipeline

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

      • bufferOptions

        public com.pulumi.core.Output<java.util.Optional<PipelineBufferOptions>> bufferOptions()
        Returns:
        Key-value pairs to configure persistent buffering for the pipeline. See `bufferOptions` below.

      • encryptionAtRestOptions

        public com.pulumi.core.Output<java.util.Optional<PipelineEncryptionAtRestOptions>> encryptionAtRestOptions()
        Returns:
        Key-value pairs to configure encryption for data that is written to a persistent buffer. See `encryptionAtRestOptions` below.

      • ingestEndpointUrls

        public com.pulumi.core.Output<java.util.List<java.lang.String>> ingestEndpointUrls()
        Returns:
        The list of ingestion endpoints for the pipeline, which you can send data to.

      • logPublishingOptions

        public com.pulumi.core.Output<java.util.Optional<PipelineLogPublishingOptions>> logPublishingOptions()
        Returns:
        Key-value pairs to configure log publishing. See `logPublishingOptions` below.

      • maxUnits

        public com.pulumi.core.Output<java.lang.Integer> maxUnits()
        Returns:
        The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

      • minUnits

        public com.pulumi.core.Output<java.lang.Integer> minUnits()
        Returns:
        The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

      • pipelineArn

        public com.pulumi.core.Output<java.lang.String> pipelineArn()
        Returns:
        ARN of the pipeline.

      • pipelineConfigurationBody

        public com.pulumi.core.Output<java.lang.String> pipelineConfigurationBody()
        Returns:
        The pipeline configuration in YAML format. This argument accepts the pipeline configuration as a string or within a `.yaml` file. If you provide the configuration as a string, each new line must be escaped with `\n`.

      • pipelineName

        public com.pulumi.core.Output<java.lang.String> pipelineName()
        Returns:
        Name of the pipeline. Pipeline names are unique across the pipelines owned by an account within an AWS Region. The following arguments are optional:

      • pipelineRoleArn

        public com.pulumi.core.Output<java.lang.String> pipelineRoleArn()
        Returns:
        ARN of the IAM role that grants the pipeline permission to access AWS resources.

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

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the pipeline. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<PipelineTimeouts>> timeouts()

      • vpcOptions

        public com.pulumi.core.Output<java.util.Optional<PipelineVpcOptions>> vpcOptions()
        Returns:
        Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint. See `vpcOptions` below.

      • get

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