Package com.pulumi.aws.neptune

Class ClusterEndpoint

  • public class ClusterEndpoint
extends com.pulumi.resources.CustomResource
    Provides an Neptune Cluster Endpoint Resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.neptune.ClusterEndpoint;
 import com.pulumi.aws.neptune.ClusterEndpointArgs;
 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 ClusterEndpoint("example", ClusterEndpointArgs.builder()
             .clusterIdentifier(test.clusterIdentifier())
             .clusterEndpointIdentifier("example")
             .endpointType("READER")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.neptune.ClusterEndpoint` using the `cluster-identifier:endpoint-identfier`. For example: ```sh $ pulumi import aws:neptune/clusterEndpoint:ClusterEndpoint example my-cluster:my-endpoint ```

    • 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> arn()  
      com.pulumi.core.Output<java.lang.String> clusterEndpointIdentifier()  
      com.pulumi.core.Output<java.lang.String> clusterIdentifier()  
      com.pulumi.core.Output<java.lang.String> endpoint()  
      com.pulumi.core.Output<java.lang.String> endpointType()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> excludedMembers()  
      static ClusterEndpoint get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ClusterEndpointState 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<java.util.List<java.lang.String>>> staticMembers()  
      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()  

      • 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

      • ClusterEndpoint

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

      • ClusterEndpoint

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

      • ClusterEndpoint

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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        Neptune Cluster Endpoint ARN.

      • clusterEndpointIdentifier

        public com.pulumi.core.Output<java.lang.String> clusterEndpointIdentifier()
        Returns:
        The identifier of the endpoint.

      • clusterIdentifier

        public com.pulumi.core.Output<java.lang.String> clusterIdentifier()
        Returns:
        The DB cluster identifier of the DB cluster associated with the endpoint.

      • endpoint

        public com.pulumi.core.Output<java.lang.String> endpoint()
        Returns:
        The DNS address of the endpoint.

      • endpointType

        public com.pulumi.core.Output<java.lang.String> endpointType()
        Returns:
        The type of the endpoint. One of: `READER`, `WRITER`, `ANY`.

      • excludedMembers

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> excludedMembers()
        Returns:
        List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

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

      • staticMembers

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> staticMembers()
        Returns:
        List of DB instance identifiers that are part of the custom endpoint group.

      • 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 Neptune cluster. 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()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

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