Package com.pulumi.aws.rds

Class ProxyEndpoint

  • public class ProxyEndpoint
extends com.pulumi.resources.CustomResource
    Provides an RDS DB proxy endpoint resource. For additional information, see the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-endpoints.html). ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.rds.ProxyEndpoint;
 import com.pulumi.aws.rds.ProxyEndpointArgs;
 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 ProxyEndpoint("example", ProxyEndpointArgs.builder()
             .dbProxyName(test.name())
             .dbProxyEndpointName("example")
             .vpcSubnetIds(testAwsSubnet.stream().map(element -> element.id()).collect(toList()))
             .targetRole("READ_ONLY")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import DB proxy endpoints using the `DB-PROXY-NAME/DB-PROXY-ENDPOINT-NAME`. For example: ```sh $ pulumi import aws:rds/proxyEndpoint:ProxyEndpoint example 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

    • 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> dbProxyEndpointName()  
      com.pulumi.core.Output<java.lang.String> dbProxyName()  
      com.pulumi.core.Output<java.lang.String> endpoint()  
      static ProxyEndpoint get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ProxyEndpointState 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.Boolean> isDefault()  
      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<java.lang.String>> targetRole()  
      com.pulumi.core.Output<java.lang.String> vpcId()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSubnetIds()  

      • 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

      • ProxyEndpoint

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

      • ProxyEndpoint

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

      • ProxyEndpoint

        public ProxyEndpoint​(java.lang.String name,
                     ProxyEndpointArgs 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:
        ARN for the proxy endpoint.

      • dbProxyEndpointName

        public com.pulumi.core.Output<java.lang.String> dbProxyEndpointName()
        Returns:
        Identifier for the proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

      • dbProxyName

        public com.pulumi.core.Output<java.lang.String> dbProxyName()
        Returns:
        Name of the DB proxy associated with the DB proxy endpoint that you create.

      • endpoint

        public com.pulumi.core.Output<java.lang.String> endpoint()
        Returns:
        Endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.

      • isDefault

        public com.pulumi.core.Output<java.lang.Boolean> isDefault()
        Returns:
        Whether this endpoint is the default endpoint for the associated DB proxy.

      • 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:
        Map of tags to assign to the resource.

      • tagsAll

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

      • targetRole

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> targetRole()
        Returns:
        Whether the DB proxy endpoint can be used for read/write or read-only operations. The default is `READ_WRITE`. Valid values are `READ_WRITE` and `READ_ONLY`.

      • vpcId

        public com.pulumi.core.Output<java.lang.String> vpcId()
        Returns:
        VPC ID of the DB proxy endpoint.

      • vpcSecurityGroupIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds()
        Returns:
        One or more VPC security group IDs to associate with the new proxy.

      • vpcSubnetIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSubnetIds()
        Returns:
        One or more VPC subnet IDs to associate with the new proxy.

      • get

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