Package software.amazon.awscdk.services.rds

Interface IDatabaseProxy.Jsii$Default

All Superinterfaces:
IConstruct, software.constructs.IConstruct, IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Default, IDatabaseProxy, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IDatabaseProxy.Jsii$Proxy
Enclosing interface:
IDatabaseProxy
@Internal public static interface IDatabaseProxy.Jsii$Default extends IDatabaseProxy, IResource.Jsii$Default
Internal default implementation for IDatabaseProxy.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default ConstructNode getNode()
      The construct tree node for this construct.
      Specified by:
      getNode in interface IConstruct
      Specified by:
      getNode in interface IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getDbProxyArn

      @Stability(Stable) @NotNull default String getDbProxyArn()
      DB Proxy ARN.
      Specified by:
      getDbProxyArn in interface IDatabaseProxy

    • getDbProxyName

      @Stability(Stable) @NotNull default String getDbProxyName()
      DB Proxy Name.
      Specified by:
      getDbProxyName in interface IDatabaseProxy

    • getEndpoint

      @Stability(Stable) @NotNull default String getEndpoint()
      Endpoint.
      Specified by:
      getEndpoint in interface IDatabaseProxy

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • grantConnect

      @Stability(Stable) @NotNull default Grant grantConnect(@NotNull IGrantable grantee, @Nullable String dbUser)
      Grant the given identity connection access to the proxy.

      Default: - if the Proxy had been provided a single Secret value, the user will be taken from that Secret

      Specified by:
      grantConnect in interface IDatabaseProxy
      Parameters:
      grantee - the Principal to grant the permissions to. This parameter is required.
      dbUser - the name of the database user to allow connecting as to the proxy.