software.amazon.awscdk.services.rds

Class CfnDBProxyEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.rds.CfnDBProxyEndpoint

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.417Z")
 @Stability(value=Stable)
public class CfnDBProxyEndpoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RDS::DBProxyEndpoint`.

The AWS::RDS::DBProxyEndpoint resource creates or updates a DB proxy endpoint. You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rds.*;
 CfnDBProxyEndpoint cfnDBProxyEndpoint = CfnDBProxyEndpoint.Builder.create(this, "MyCfnDBProxyEndpoint")
         .dbProxyEndpointName("dbProxyEndpointName")
         .dbProxyName("dbProxyName")
         .vpcSubnetIds(List.of("vpcSubnetIds"))
         // the properties below are optional
         .tags(List.of(TagFormatProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetRole("targetRole")
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDBProxyEndpoint.Builder A fluent builder for CfnDBProxyEndpoint.
static interface	CfnDBProxyEndpoint.TagFormatProperty Metadata assigned to a DB proxy endpoint consisting of a key-value pair.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDBProxyEndpoint(software.constructs.Construct scope, String id, CfnDBProxyEndpointProps props) Create a new `AWS::RDS::DBProxyEndpoint`.
protected	CfnDBProxyEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDBProxyEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrDbProxyEndpointArn() The Amazon Resource Name (ARN) representing the DB proxy endpoint.
String	getAttrEndpoint() The custom endpoint for the RDS DB instance or Aurora DB cluster.
IResolvable	getAttrIsDefault() A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.
String	getAttrVpcId() The VPC ID of the DB proxy endpoint.
protected Map<String,Object>	getCfnProperties()
String	getDbProxyEndpointName() The name of the DB proxy endpoint to create.
String	getDbProxyName() The name of the DB proxy associated with the DB proxy endpoint that you create.
List<CfnDBProxyEndpoint.TagFormatProperty>	getTags() An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
String	getTargetRole() A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
List<String>	getVpcSecurityGroupIds() The VPC security group IDs for the DB proxy endpoint that you create.
List<String>	getVpcSubnetIds() The VPC subnet IDs for the DB proxy endpoint that you create.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDbProxyEndpointName(String value) The name of the DB proxy endpoint to create.
void	setDbProxyName(String value) The name of the DB proxy associated with the DB proxy endpoint that you create.
void	setTags(List<CfnDBProxyEndpoint.TagFormatProperty> value) An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
void	setTargetRole(String value) A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
void	setVpcSecurityGroupIds(List<String> value) The VPC security group IDs for the DB proxy endpoint that you create.
void	setVpcSubnetIds(List<String> value) The VPC subnet IDs for the DB proxy endpoint that you create.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDBProxyEndpoint

protected CfnDBProxyEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

CfnDBProxyEndpoint

protected CfnDBProxyEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDBProxyEndpoint

@Stability(value=Stable)
public CfnDBProxyEndpoint(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnDBProxyEndpointProps props)

Create a new `AWS::RDS::DBProxyEndpoint`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDbProxyEndpointArn

@Stability(value=Stable)
 @NotNull
public String getAttrDbProxyEndpointArn()

The Amazon Resource Name (ARN) representing the DB proxy endpoint.

getAttrEndpoint

@Stability(value=Stable)
 @NotNull
public String getAttrEndpoint()

The custom endpoint for the RDS DB instance or Aurora DB cluster.

getAttrIsDefault

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrIsDefault()

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.

Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

getAttrVpcId

@Stability(value=Stable)
 @NotNull
public String getAttrVpcId()

The VPC ID of the DB proxy endpoint.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDbProxyEndpointName

@Stability(value=Stable)
 @NotNull
public String getDbProxyEndpointName()

The name of the DB proxy endpoint to create.

setDbProxyEndpointName

@Stability(value=Stable)
public void setDbProxyEndpointName(@NotNull
                                                            String value)

The name of the DB proxy endpoint to create.

getDbProxyName

@Stability(value=Stable)
 @NotNull
public String getDbProxyName()

The name of the DB proxy associated with the DB proxy endpoint that you create.

setDbProxyName

@Stability(value=Stable)
public void setDbProxyName(@NotNull
                                                    String value)

The name of the DB proxy associated with the DB proxy endpoint that you create.

getVpcSubnetIds

@Stability(value=Stable)
 @NotNull
public List<String> getVpcSubnetIds()

The VPC subnet IDs for the DB proxy endpoint that you create.

You can specify a different set of subnet IDs than for the original DB proxy.

setVpcSubnetIds

@Stability(value=Stable)
public void setVpcSubnetIds(@NotNull
                                                     List<String> value)

The VPC subnet IDs for the DB proxy endpoint that you create.

You can specify a different set of subnet IDs than for the original DB proxy.

getTags

@Stability(value=Stable)
 @Nullable
public List<CfnDBProxyEndpoint.TagFormatProperty> getTags()

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

setTags

@Stability(value=Stable)
public void setTags(@Nullable
                                             List<CfnDBProxyEndpoint.TagFormatProperty> value)

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

getTargetRole

@Stability(value=Stable)
 @Nullable
public String getTargetRole()

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

Valid Values: READ_WRITE | READ_ONLY

setTargetRole

@Stability(value=Stable)
public void setTargetRole(@Nullable
                                                   String value)

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

Valid Values: READ_WRITE | READ_ONLY

getVpcSecurityGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getVpcSecurityGroupIds()

The VPC security group IDs for the DB proxy endpoint that you create.

You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

setVpcSecurityGroupIds

@Stability(value=Stable)
public void setVpcSecurityGroupIds(@Nullable
                                                            List<String> value)

The VPC security group IDs for the DB proxy endpoint that you create.

You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.