DatabaseProxyEndpoint L2 construct
RDS Database Proxy Endpoint.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';
import { aws_rds as interfaces_rds } from 'aws-cdk-lib/interfaces';
declare const dBProxyRef: interfaces_rds.IDBProxyRef;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpc: ec2.Vpc;
const databaseProxyEndpoint = new rds.DatabaseProxyEndpoint(this, 'MyDatabaseProxyEndpoint', {
dbProxy: dBProxyRef,
vpc: vpc,
// the properties below are optional
dbProxyEndpointName: 'dbProxyEndpointName',
securityGroups: [securityGroup],
targetRole: rds.ProxyEndpointTargetRole.READ_WRITE,
vpcSubnets: {
availabilityZones: ['availabilityZones'],
onePerAz: false,
subnetFilters: [subnetFilter],
subnetGroupName: 'subnetGroupName',
subnets: [subnet],
subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
},
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_rds as rds
from aws_cdk.interfaces import aws_rds as interfaces_rds
# d_b_proxy_ref: interfaces_rds.IDBProxyRef
# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# vpc: ec2.Vpc
database_proxy_endpoint = rds.DatabaseProxyEndpoint(self, "MyDatabaseProxyEndpoint",
db_proxy=d_b_proxy_ref,
vpc=vpc,
# the properties below are optional
db_proxy_endpoint_name="dbProxyEndpointName",
security_groups=[security_group],
target_role=rds.ProxyEndpointTargetRole.READ_WRITE,
vpc_subnets=ec2.SubnetSelection(
availability_zones=["availabilityZones"],
one_per_az=False,
subnet_filters=[subnet_filter],
subnet_group_name="subnetGroupName",
subnets=[subnet],
subnet_type=ec2.SubnetType.PRIVATE_ISOLATED
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.rds.*;
import software.amazon.awscdk.interfaces.rds.*;
IDBProxyRef dBProxyRef;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
Vpc vpc;
DatabaseProxyEndpoint databaseProxyEndpoint = DatabaseProxyEndpoint.Builder.create(this, "MyDatabaseProxyEndpoint")
.dbProxy(dBProxyRef)
.vpc(vpc)
// the properties below are optional
.dbProxyEndpointName("dbProxyEndpointName")
.securityGroups(List.of(securityGroup))
.targetRole(ProxyEndpointTargetRole.READ_WRITE)
.vpcSubnets(SubnetSelection.builder()
.availabilityZones(List.of("availabilityZones"))
.onePerAz(false)
.subnetFilters(List.of(subnetFilter))
.subnetGroupName("subnetGroupName")
.subnets(List.of(subnet))
.subnetType(SubnetType.PRIVATE_ISOLATED)
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.RDS;
using Amazon.CDK.Interfaces.RDS;
IDBProxyRef dBProxyRef;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
Vpc vpc;
var databaseProxyEndpoint = new DatabaseProxyEndpoint(this, "MyDatabaseProxyEndpoint", new DatabaseProxyEndpointProps {
DbProxy = dBProxyRef,
Vpc = vpc,
// the properties below are optional
DbProxyEndpointName = "dbProxyEndpointName",
SecurityGroups = new [] { securityGroup },
TargetRole = ProxyEndpointTargetRole.READ_WRITE,
VpcSubnets = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
Subnets = new [] { subnet },
SubnetType = SubnetType.PRIVATE_ISOLATED
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var dBProxyRef IDBProxyRef
var securityGroup SecurityGroup
var subnet Subnet
var subnetFilter SubnetFilter
var vpc Vpc
databaseProxyEndpoint := awscdk.Aws_rds.NewDatabaseProxyEndpoint(this, jsii.String("MyDatabaseProxyEndpoint"), &DatabaseProxyEndpointProps{
DbProxy: dBProxyRef,
Vpc: vpc,
// the properties below are optional
DbProxyEndpointName: jsii.String("dbProxyEndpointName"),
SecurityGroups: []ISecurityGroup{
securityGroup,
},
TargetRole: awscdk.*Aws_rds.ProxyEndpointTargetRole_READ_WRITE,
VpcSubnets: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
OnePerAz: jsii.Boolean(false),
SubnetFilters: []SubnetFilter{
subnetFilter,
},
SubnetGroupName: jsii.String("subnetGroupName"),
Subnets: []ISubnet{
subnet,
},
SubnetType: awscdk.Aws_ec2.SubnetType_PRIVATE_ISOLATED,
},
})
Initializer
ts
new DatabaseProxyEndpoint(scope: Construct, id: string, props: DatabaseProxyEndpointProps)
python
DatabaseProxyEndpoint(scope: Construct, id: str, props: DatabaseProxyEndpointProps)
java
new DatabaseProxyEndpoint(Construct scope, String id, DatabaseProxyEndpointProps props)
csharp
new DatabaseProxyEndpoint(Construct scope, string id, DatabaseProxyEndpointProps props)
go
NewDatabaseProxyEndpoint(Scope Construct, Id *string, Props DatabaseProxyEndpointProps)
Construct Props
dbProxyIDBProxyRefdb_proxyIDBProxyRefdbProxyIDBProxyRefDbProxyIDBProxyRefDbProxyIDBProxyRefrequired#The DB proxy associated with the DB proxy endpoint.
dbProxyEndpointNameoptionalstringdb_proxy_endpoint_nameoptionalstrdbProxyEndpointNameoptionalStringDbProxyEndpointNameoptionalstringDbProxyEndpointNameoptional*string#The name of the DB proxy endpoint.
Default: a CDK generated name
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#The VPC security groups to associate with the new proxy endpoint.
Default: Default security group for the VPC
targetRoleoptionalProxyEndpointTargetRoletarget_roleoptionalProxyEndpointTargetRoletargetRoleoptionalProxyEndpointTargetRoleTargetRoleoptionalProxyEndpointTargetRoleTargetRoleoptionalProxyEndpointTargetRole#A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
Default: ProxyEndpointTargetRole.READ_WRITE
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#The subnets of DB proxy endpoint.
Default: the VPC default strategy if not specified.
Properties
dbProxyEndpointArnstringdb_proxy_endpoint_arnstrdbProxyEndpointArnStringDbProxyEndpointArnstringDbProxyEndpointArn*string#DB Proxy Endpoint ARN.
dbProxyEndpointNamestringdb_proxy_endpoint_namestrdbProxyEndpointNameStringDbProxyEndpointNamestringDbProxyEndpointName*string#DB Proxy Endpoint Name.
dbProxyEndpointRefDBProxyEndpointReferencedb_proxy_endpoint_refDBProxyEndpointReferencedbProxyEndpointRefDBProxyEndpointReferenceDbProxyEndpointRefDBProxyEndpointReferenceDbProxyEndpointRefDBProxyEndpointReference#A reference to this database proxy endpoint.
The endpoint that you can use to connect to the DB proxy.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#Uniquely identifies this class.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
fromDatabaseProxyEndpointAttributes(scope: Construct, id: string, attrs: DatabaseProxyEndpointAttributes): IDatabaseProxyEndpoint@staticmethod def from_database_proxy_endpoint_attributes(scope: Construct, id: str, attrs: DatabaseProxyEndpointAttributes) -> IDatabaseProxyEndpointpublic static IDatabaseProxyEndpoint fromDatabaseProxyEndpointAttributes(Construct scope, String id, DatabaseProxyEndpointAttributes attrs)public static IDatabaseProxyEndpoint FromDatabaseProxyEndpointAttributes(Construct scope, string id, DatabaseProxyEndpointAttributes attrs)func FromDatabaseProxyEndpointAttributes(Scope Construct, Id *string, Attrs DatabaseProxyEndpointAttributes) IDatabaseProxyEndpointstatic#Import an existing database proxy endpoint.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.