ProxyTarget class
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:
$ pulumi import aws:rds/proxyTarget:ProxyTarget example example-proxy/default/RDS_INSTANCE/example-instance
Provisioned Clusters:
$ pulumi import aws:rds/proxyTarget:ProxyTarget example example-proxy/default/TRACKED_CLUSTER/example-cluster
Constructors
- ProxyTarget(String name, {ProxyTargetArgs? args, CustomResourceOptions? options})
-
Creates a new ProxyTarget.
nameThe Pulumi resource name.argsArguments used to configure this ProxyTarget. The set of arguments for ProxyTarget.optionsResource options controlling this resource's behavior. - ProxyTarget.reference(String urn)
- Creates a typed reference to an existing ProxyTarget resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
dbClusterIdentifier
↔ Output<
String?> -
DB cluster identifier.
latefinal
-
dbInstanceIdentifier
↔ Output<
String?> -
DB instance identifier.
latefinal
-
dbProxyName
↔ Output<
String> -
The name of the DB proxy.
latefinal
-
endpoint
↔ Output<
String> -
Hostname for the target RDS DB Instance. Only returned for
RDS_INSTANCEtype.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
port
↔ Output<
int> -
Port for the target RDS DB Instance or Aurora DB Cluster.
latefinal
-
rdsResourceId
↔ Output<
String> -
Identifier representing the DB Instance or DB Cluster target.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
targetArn
↔ Output<
String> -
ARN for the DB instance or DB cluster. Currently not returned by the RDS API.
latefinal
-
targetGroupName
↔ Output<
String> -
The name of the target group.
latefinal
-
trackedClusterId
↔ Output<
String> -
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an
RDS_INSTANCEtarget that is part of a DB Cluster.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
type
↔ Output<
String> -
Type of targetE.g.,
RDS_INSTANCEorTRACKED_CLUSTERlatefinal -
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ProxyTargetState? state, CustomResourceOptions? options}) → ProxyTarget -
Gets an existing ProxyTarget resource's state with the given
nameandid.