Package com.pulumi.aws.opensearchingest

Class PipelineEndpoint

  • public class PipelineEndpoint
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS OpenSearch Ingestion Pipeline Endpoint. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.opensearchingest.PipelineEndpoint;
 import com.pulumi.aws.opensearchingest.PipelineEndpointArgs;
 import com.pulumi.aws.opensearchingest.inputs.PipelineEndpointVpcOptionsArgs;
 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 PipelineEndpoint("example", PipelineEndpointArgs.builder()
             .vpcOptions(PipelineEndpointVpcOptionsArgs.builder()
                 .securityGroupIds(exampleAwsSecurityGroup.id())
                 .subnetIds(exampleAwsSubnet.id())
                 .build())
             .pipelineArn(exampleAwsOsisPipeline.pipelineArn())
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `id` (String) ID of the pipeline endpoint. #### 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 Endpoint using the `id`. For example: ```sh $ pulumi import aws:opensearchingest/pipelineEndpoint:PipelineEndpoint example endpoint-id ```

    • 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 PipelineEndpoint get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PipelineEndpointState 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> pipelineArn()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<PipelineEndpointTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.String> vpcId()  
      com.pulumi.core.Output<java.util.Optional<PipelineEndpointVpcOptions>> 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

      • PipelineEndpoint

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

      • PipelineEndpoint

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

      • PipelineEndpoint

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

      • pipelineArn

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

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

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of the endpoint.

      • vpcId

        public com.pulumi.core.Output<java.lang.String> vpcId()
        Returns:
        ID of the VPC. Derived from `subnetIds`.

      • vpcOptions

        public com.pulumi.core.Output<java.util.Optional<PipelineEndpointVpcOptions>> vpcOptions()
        Returns:
        VPC options for the pipeline endpoint. See `vpcOptions` Block below. The following arguments are optional:

      • get

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