Package com.pulumi.aws.rds

Class ProxyTarget

  • public class ProxyTarget
extends com.pulumi.resources.CustomResource
    Provides an RDS DB proxy target resource. > **NOTE:** When the associated `aws.rds.Proxy` resource is replaced, Terraform will lose track of this resource, causing unexpected differences on the next apply. To ensure proper dependency management, add a `lifecycle` block with `replaceTriggeredBy` referencing the `aws.rds.Proxy` resource's `id` attribute. ## Import Provisioned Clusters: **Using `pulumi import` to import** RDS DB Proxy Targets using the `dbProxyName`, `targetGroupName`, target type (such as `RDS_INSTANCE` or `TRACKED_CLUSTER`), and resource identifier separated by forward slashes (`/`). For example: Instances: ```sh $ pulumi import aws:rds/proxyTarget:ProxyTarget example example-proxy/default/RDS_INSTANCE/example-instance ``` Provisioned Clusters: ```sh $ pulumi import aws:rds/proxyTarget:ProxyTarget example example-proxy/default/TRACKED_CLUSTER/example-cluster ```

    • 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.util.Optional<java.lang.String>> dbClusterIdentifier()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> dbInstanceIdentifier()  
      com.pulumi.core.Output<java.lang.String> dbProxyName()  
      com.pulumi.core.Output<java.lang.String> endpoint()  
      static ProxyTarget get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ProxyTargetState 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.Integer> port()  
      com.pulumi.core.Output<java.lang.String> rdsResourceId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> targetArn()  
      com.pulumi.core.Output<java.lang.String> targetGroupName()  
      com.pulumi.core.Output<java.lang.String> trackedClusterId()  
      com.pulumi.core.Output<java.lang.String> type()  

      • 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

      • ProxyTarget

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

      • ProxyTarget

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

      • ProxyTarget

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

      • dbClusterIdentifier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> dbClusterIdentifier()
        Returns:
        DB cluster identifier.

      • dbInstanceIdentifier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> dbInstanceIdentifier()
        Returns:
        DB instance identifier.

      • dbProxyName

        public com.pulumi.core.Output<java.lang.String> dbProxyName()
        Returns:
        Name of the DB proxy.

      • endpoint

        public com.pulumi.core.Output<java.lang.String> endpoint()
        Returns:
        Hostname for the target RDS DB Instance. Only returned for `RDS_INSTANCE` type.

      • port

        public com.pulumi.core.Output<java.lang.Integer> port()
        Returns:
        Port for the target RDS DB Instance or Aurora DB Cluster.

      • rdsResourceId

        public com.pulumi.core.Output<java.lang.String> rdsResourceId()
        Returns:
        Identifier representing the DB Instance or DB Cluster target.

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

      • targetArn

        public com.pulumi.core.Output<java.lang.String> targetArn()
        Returns:
        ARN for the DB instance or DB cluster. Currently not returned by the RDS API.

      • targetGroupName

        public com.pulumi.core.Output<java.lang.String> targetGroupName()
        Returns:
        Name of the target group.

      • trackedClusterId

        public com.pulumi.core.Output<java.lang.String> trackedClusterId()
        Returns:
        DB Cluster identifier for the DB Instance target. Not returned unless manually importing an `RDS_INSTANCE` target that is part of a DB Cluster.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Type of targetE.g., `RDS_INSTANCE` or `TRACKED_CLUSTER`

      • get

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