AWS API Changes

2025/09/04 - Amazon Relational Database Service - 8 updated api methods

Changes Added new EndpointNetworkType and TargetConnectionNetworkType fields in Proxy APIs to support IPv6

CreateDBProxy (updated)

Link ¶
Changes (request, response)
Request

{'EndpointNetworkType': 'IPV4 | IPV6 | DUAL',
 'TargetConnectionNetworkType': 'IPV4 | IPV6'}

Response

{'DBProxy': {'EndpointNetworkType': 'IPV4 | IPV6 | DUAL',
             'TargetConnectionNetworkType': 'IPV4 | IPV6'}}

Creates a new DB proxy.

See also: AWS API Documentation

Request Syntax

client.create_db_proxy(
    DBProxyName='string',
    EngineFamily='MYSQL'|'POSTGRESQL'|'SQLSERVER',
    Auth=[
        {
            'Description': 'string',
            'UserName': 'string',
            'AuthScheme': 'SECRETS',
            'SecretArn': 'string',
            'IAMAuth': 'DISABLED'|'REQUIRED'|'ENABLED',
            'ClientPasswordAuthType': 'MYSQL_NATIVE_PASSWORD'|'MYSQL_CACHING_SHA2_PASSWORD'|'POSTGRES_SCRAM_SHA_256'|'POSTGRES_MD5'|'SQL_SERVER_AUTHENTICATION'
        },
    ],
    RoleArn='string',
    VpcSubnetIds=[
        'string',
    ],
    VpcSecurityGroupIds=[
        'string',
    ],
    RequireTLS=True|False,
    IdleClientTimeout=123,
    DebugLogging=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    EndpointNetworkType='IPV4'|'IPV6'|'DUAL',
    TargetConnectionNetworkType='IPV4'|'IPV6'
)

type DBProxyName:

string

param DBProxyName:

[REQUIRED]

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

type EngineFamily:

string

param EngineFamily:

[REQUIRED]

The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.

type Auth:

list

param Auth:

[REQUIRED]

The authorization mechanism that the proxy uses.

(dict) --

Specifies the details of authentication used by a proxy to log in as a specific database user.
- Description (string) --
  
  A user-specified description about the authentication used by a proxy to log in as a specific database user.
- UserName (string) --
  
  The name of the database user to which the proxy connects.
- AuthScheme (string) --
  
  The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- SecretArn (string) --
  
  The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
- IAMAuth (string) --
  
  A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
- ClientPasswordAuthType (string) --
  
  The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines:
  - RDS for MySQL: MYSQL_CACHING_SHA2_PASSWORD
  - RDS for SQL Server: SQL_SERVER_AUTHENTICATION
  - RDS for PostgreSQL: POSTGRES_SCRAM_SHA2_256

type RoleArn:

string

param RoleArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

type VpcSubnetIds:

list

param VpcSubnetIds:

[REQUIRED]

One or more VPC subnet IDs to associate with the new proxy.

(string) --

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

One or more VPC security group IDs to associate with the new proxy.

(string) --

type RequireTLS:

boolean

param RequireTLS:

Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.

type IdleClientTimeout:

integer

param IdleClientTimeout:

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

type DebugLogging:

boolean

param DebugLogging:

Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.

type Tags:

list

param Tags:

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

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- Key (string) --
  
  A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
- Value (string) --
  
  A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

type EndpointNetworkType:

string

param EndpointNetworkType:

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

Valid values:

IPV4 - The proxy endpoint supports IPv4 only.
IPV6 - The proxy endpoint supports IPv6 only.
DUAL - The proxy endpoint supports both IPv4 and IPv6.

Default: IPV4

Constraints:

If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.
If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

type TargetConnectionNetworkType:

string

param TargetConnectionNetworkType:

The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.

Valid values:

IPV4 - The proxy connects to the database using IPv4 only.
IPV6 - The proxy connects to the database using IPv6 only.

Default: IPV4

Constraints:

If you specify IPV6, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.
All targets registered with the proxy must be compatible with the specified network type.

rtype:

dict

returns:

Response Syntax

{
    'DBProxy': {
        'DBProxyName': 'string',
        'DBProxyArn': 'string',
        'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating',
        'EngineFamily': 'string',
        'VpcId': 'string',
        'VpcSecurityGroupIds': [
            'string',
        ],
        'VpcSubnetIds': [
            'string',
        ],
        'Auth': [
            {
                'Description': 'string',
                'UserName': 'string',
                'AuthScheme': 'SECRETS',
                'SecretArn': 'string',
                'IAMAuth': 'DISABLED'|'REQUIRED'|'ENABLED',
                'ClientPasswordAuthType': 'MYSQL_NATIVE_PASSWORD'|'MYSQL_CACHING_SHA2_PASSWORD'|'POSTGRES_SCRAM_SHA_256'|'POSTGRES_MD5'|'SQL_SERVER_AUTHENTICATION'
            },
        ],
        'RoleArn': 'string',
        'Endpoint': 'string',
        'RequireTLS': True|False,
        'IdleClientTimeout': 123,
        'DebugLogging': True|False,
        'CreatedDate': datetime(2015, 1, 1),
        'UpdatedDate': datetime(2015, 1, 1),
        'EndpointNetworkType': 'IPV4'|'IPV6'|'DUAL',
        'TargetConnectionNetworkType': 'IPV4'|'IPV6'
    }
}

Response Structure

(dict) --
- DBProxy (dict) --
  
  The DBProxy structure corresponding to the new proxy.
  - DBProxyName (string) --
    
    The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
  - DBProxyArn (string) --
    
    The Amazon Resource Name (ARN) for the proxy.
  - Status (string) --
    
    The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
  - EngineFamily (string) --
    
    The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.
  - VpcId (string) --
    
    Provides the VPC ID of the DB proxy.
  - VpcSecurityGroupIds (list) --
    
    Provides a list of VPC security groups that the proxy belongs to.
    - (string) --
  - VpcSubnetIds (list) --
    
    The EC2 subnet IDs for the proxy.
    - (string) --
  - Auth (list) --
    
    One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
    - (dict) --
      
      Returns the details of authentication used by a proxy to log in as a specific database user.
      - Description (string) --
        
        A user-specified description about the authentication used by a proxy to log in as a specific database user.
      - UserName (string) --
        
        The name of the database user to which the proxy connects.
      - AuthScheme (string) --
        
        The type of authentication that the proxy uses for connections from the proxy to the underlying database.
      - SecretArn (string) --
        
        The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
      - IAMAuth (string) --
        
        Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
      - ClientPasswordAuthType (string) --
        
        The type of authentication the proxy uses for connections from clients.
  - RoleArn (string) --
    
    The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
  - Endpoint (string) --
    
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
  - RequireTLS (boolean) --
    
    Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
  - IdleClientTimeout (integer) --
    
    The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
    
    Default: 1800 (30 minutes)
    
    Constraints: 1 to 28,800
  - DebugLogging (boolean) --
    
    Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.
  - CreatedDate (datetime) --
    
    The date and time when the proxy was first created.
  - UpdatedDate (datetime) --
    
    The date and time when the proxy was last updated.
  - EndpointNetworkType (string) --
    
    The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
    
    Valid values:
    - IPV4 - The proxy endpoint supports IPv4 only.
    - IPV6 - The proxy endpoint supports IPv6 only.
    - DUAL - The proxy endpoint supports both IPv4 and IPv6.
  - TargetConnectionNetworkType (string) --
    
    The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
    
    Valid values:
    - IPV4 - The proxy connects to the database using IPv4 only.
    - IPV6 - The proxy connects to the database using IPv6 only.

CreateDBProxyEndpoint (updated)

Link ¶
Changes (request, response)
Request

{'EndpointNetworkType': 'IPV4 | IPV6 | DUAL'}

Response

{'DBProxyEndpoint': {'EndpointNetworkType': 'IPV4 | IPV6 | DUAL'}}

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

See also: AWS API Documentation

Request Syntax

client.create_db_proxy_endpoint(
    DBProxyName='string',
    DBProxyEndpointName='string',
    VpcSubnetIds=[
        'string',
    ],
    VpcSecurityGroupIds=[
        'string',
    ],
    TargetRole='READ_WRITE'|'READ_ONLY',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    EndpointNetworkType='IPV4'|'IPV6'|'DUAL'
)

type DBProxyName:

string

param DBProxyName:

[REQUIRED]

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

type DBProxyEndpointName:

string

param DBProxyEndpointName:

[REQUIRED]

The name of the DB proxy endpoint to create.

type VpcSubnetIds:

list

param VpcSubnetIds:

[REQUIRED]

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.

(string) --

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

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.

(string) --

type TargetRole:

string

param TargetRole:

The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

type Tags:

list

param Tags:

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- Key (string) --
  
  A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
- Value (string) --
  
  A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

type EndpointNetworkType:

string

param EndpointNetworkType:

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

Valid values:

IPV4 - The proxy endpoint supports IPv4 only.
IPV6 - The proxy endpoint supports IPv6 only.
DUAL - The proxy endpoint supports both IPv4 and IPv6.

Default: IPV4

Constraints:

If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.
If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

rtype:

dict

returns:

Response Syntax

{
    'DBProxyEndpoint': {
        'DBProxyEndpointName': 'string',
        'DBProxyEndpointArn': 'string',
        'DBProxyName': 'string',
        'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
        'VpcId': 'string',
        'VpcSecurityGroupIds': [
            'string',
        ],
        'VpcSubnetIds': [
            'string',
        ],
        'Endpoint': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'TargetRole': 'READ_WRITE'|'READ_ONLY',
        'IsDefault': True|False,
        'EndpointNetworkType': 'IPV4'|'IPV6'|'DUAL'
    }
}

Response Structure

(dict) --
- DBProxyEndpoint (dict) --
  
  The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.
  - DBProxyEndpointName (string) --
    
    The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
  - DBProxyEndpointArn (string) --
    
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
  - DBProxyName (string) --
    
    The identifier for the DB proxy that is associated with this DB proxy endpoint.
  - Status (string) --
    
    The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
  - VpcId (string) --
    
    Provides the VPC ID of the DB proxy endpoint.
  - VpcSecurityGroupIds (list) --
    
    Provides a list of VPC security groups that the DB proxy endpoint belongs to.
    - (string) --
  - VpcSubnetIds (list) --
    
    The EC2 subnet IDs for the DB proxy endpoint.
    - (string) --
  - Endpoint (string) --
    
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
  - CreatedDate (datetime) --
    
    The date and time when the DB proxy endpoint was first created.
  - TargetRole (string) --
    
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
  - IsDefault (boolean) --
    
    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.
  - EndpointNetworkType (string) --
    
    The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
    
    Valid values:
    - IPV4 - The proxy endpoint supports IPv4 only.
    - IPV6 - The proxy endpoint supports IPv6 only.
    - DUAL - The proxy endpoint supports both IPv4 and IPv6.

DeleteDBProxy (updated)

Link ¶
Changes (response)

{'DBProxy': {'EndpointNetworkType': 'IPV4 | IPV6 | DUAL',
             'TargetConnectionNetworkType': 'IPV4 | IPV6'}}

Deletes an existing DB proxy.

See also: AWS API Documentation

Request Syntax

client.delete_db_proxy(
    DBProxyName='string'
)

type DBProxyName:

string

param DBProxyName:

[REQUIRED]

The name of the DB proxy to delete.

rtype:

dict

returns:

Response Syntax

{
    'DBProxy': {
        'DBProxyName': 'string',
        'DBProxyArn': 'string',
        'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating',
        'EngineFamily': 'string',
        'VpcId': 'string',
        'VpcSecurityGroupIds': [
            'string',
        ],
        'VpcSubnetIds': [
            'string',
        ],
        'Auth': [
            {
                'Description': 'string',
                'UserName': 'string',
                'AuthScheme': 'SECRETS',
                'SecretArn': 'string',
                'IAMAuth': 'DISABLED'|'REQUIRED'|'ENABLED',
                'ClientPasswordAuthType': 'MYSQL_NATIVE_PASSWORD'|'MYSQL_CACHING_SHA2_PASSWORD'|'POSTGRES_SCRAM_SHA_256'|'POSTGRES_MD5'|'SQL_SERVER_AUTHENTICATION'
            },
        ],
        'RoleArn': 'string',
        'Endpoint': 'string',
        'RequireTLS': True|False,
        'IdleClientTimeout': 123,
        'DebugLogging': True|False,
        'CreatedDate': datetime(2015, 1, 1),
        'UpdatedDate': datetime(2015, 1, 1),
        'EndpointNetworkType': 'IPV4'|'IPV6'|'DUAL',
        'TargetConnectionNetworkType': 'IPV4'|'IPV6'
    }
}

Response Structure

(dict) --
- DBProxy (dict) --
  
  The data structure representing the details of the DB proxy that you delete.
  - DBProxyName (string) --
    
    The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
  - DBProxyArn (string) --
    
    The Amazon Resource Name (ARN) for the proxy.
  - Status (string) --
    
    The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
  - EngineFamily (string) --
    
    The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.
  - VpcId (string) --
    
    Provides the VPC ID of the DB proxy.
  - VpcSecurityGroupIds (list) --
    
    Provides a list of VPC security groups that the proxy belongs to.
    - (string) --
  - VpcSubnetIds (list) --
    
    The EC2 subnet IDs for the proxy.
    - (string) --
  - Auth (list) --
    
    One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
    - (dict) --
      
      Returns the details of authentication used by a proxy to log in as a specific database user.
      - Description (string) --
        
        A user-specified description about the authentication used by a proxy to log in as a specific database user.
      - UserName (string) --
        
        The name of the database user to which the proxy connects.
      - AuthScheme (string) --
        
        The type of authentication that the proxy uses for connections from the proxy to the underlying database.
      - SecretArn (string) --
        
        The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
      - IAMAuth (string) --
        
        Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
      - ClientPasswordAuthType (string) --
        
        The type of authentication the proxy uses for connections from clients.
  - RoleArn (string) --
    
    The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
  - Endpoint (string) --
    
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
  - RequireTLS (boolean) --
    
    Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
  - IdleClientTimeout (integer) --
    
    The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
    
    Default: 1800 (30 minutes)
    
    Constraints: 1 to 28,800
  - DebugLogging (boolean) --
    
    Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.
  - CreatedDate (datetime) --
    
    The date and time when the proxy was first created.
  - UpdatedDate (datetime) --
    
    The date and time when the proxy was last updated.
  - EndpointNetworkType (string) --
    
    The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
    
    Valid values:
    - IPV4 - The proxy endpoint supports IPv4 only.
    - IPV6 - The proxy endpoint supports IPv6 only.
    - DUAL - The proxy endpoint supports both IPv4 and IPv6.
  - TargetConnectionNetworkType (string) --
    
    The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
    
    Valid values:
    - IPV4 - The proxy connects to the database using IPv4 only.
    - IPV6 - The proxy connects to the database using IPv6 only.

DeleteDBProxyEndpoint (updated)

Link ¶
Changes (response)

{'DBProxyEndpoint': {'EndpointNetworkType': 'IPV4 | IPV6 | DUAL'}}

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.

See also: AWS API Documentation

Request Syntax

client.delete_db_proxy_endpoint(
    DBProxyEndpointName='string'
)

type DBProxyEndpointName:

string

param DBProxyEndpointName:

[REQUIRED]

The name of the DB proxy endpoint to delete.

rtype:

dict

returns:

Response Syntax

{
    'DBProxyEndpoint': {
        'DBProxyEndpointName': 'string',
        'DBProxyEndpointArn': 'string',
        'DBProxyName': 'string',
        'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
        'VpcId': 'string',
        'VpcSecurityGroupIds': [
            'string',
        ],
        'VpcSubnetIds': [
            'string',
        ],
        'Endpoint': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'TargetRole': 'READ_WRITE'|'READ_ONLY',
        'IsDefault': True|False,
        'EndpointNetworkType': 'IPV4'|'IPV6'|'DUAL'
    }
}

Response Structure

(dict) --
- DBProxyEndpoint (dict) --
  
  The data structure representing the details of the DB proxy endpoint that you delete.
  - DBProxyEndpointName (string) --
    
    The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
  - DBProxyEndpointArn (string) --
    
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
  - DBProxyName (string) --
    
    The identifier for the DB proxy that is associated with this DB proxy endpoint.
  - Status (string) --
    
    The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
  - VpcId (string) --
    
    Provides the VPC ID of the DB proxy endpoint.
  - VpcSecurityGroupIds (list) --
    
    Provides a list of VPC security groups that the DB proxy endpoint belongs to.
    - (string) --
  - VpcSubnetIds (list) --
    
    The EC2 subnet IDs for the DB proxy endpoint.
    - (string) --
  - Endpoint (string) --
    
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
  - CreatedDate (datetime) --
    
    The date and time when the DB proxy endpoint was first created.
  - TargetRole (string) --
    
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
  - IsDefault (boolean) --
    
    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.
  - EndpointNetworkType (string) --
    
    The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
    
    Valid values:
    - IPV4 - The proxy endpoint supports IPv4 only.
    - IPV6 - The proxy endpoint supports IPv6 only.
    - DUAL - The proxy endpoint supports both IPv4 and IPv6.

DescribeDBProxies (updated)

Link ¶
Changes (response)

{'DBProxies': {'EndpointNetworkType': 'IPV4 | IPV6 | DUAL',
               'TargetConnectionNetworkType': 'IPV4 | IPV6'}}

Returns information about DB proxies.

See also: AWS API Documentation

Request Syntax

client.describe_db_proxies(
    DBProxyName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123
)

type DBProxyName:

string

param DBProxyName:

The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.

type Filters:

list

param Filters:

This parameter is not currently supported.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:
- DescribeDBClusterBacktracks
- DescribeDBClusterEndpoints
- DescribeDBClusters
- DescribeDBInstances
- DescribeDBRecommendations
- DescribeDBShardGroups
- DescribePendingMaintenanceActions
- Name (string) -- [REQUIRED]
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) -- [REQUIRED]
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type Marker:

string

param Marker:

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

type MaxRecords:

integer

param MaxRecords:

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

rtype:

dict

returns:

Response Syntax

{
    'DBProxies': [
        {
            'DBProxyName': 'string',
            'DBProxyArn': 'string',
            'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating',
            'EngineFamily': 'string',
            'VpcId': 'string',
            'VpcSecurityGroupIds': [
                'string',
            ],
            'VpcSubnetIds': [
                'string',
            ],
            'Auth': [
                {
                    'Description': 'string',
                    'UserName': 'string',
                    'AuthScheme': 'SECRETS',
                    'SecretArn': 'string',
                    'IAMAuth': 'DISABLED'|'REQUIRED'|'ENABLED',
                    'ClientPasswordAuthType': 'MYSQL_NATIVE_PASSWORD'|'MYSQL_CACHING_SHA2_PASSWORD'|'POSTGRES_SCRAM_SHA_256'|'POSTGRES_MD5'|'SQL_SERVER_AUTHENTICATION'
                },
            ],
            'RoleArn': 'string',
            'Endpoint': 'string',
            'RequireTLS': True|False,
            'IdleClientTimeout': 123,
            'DebugLogging': True|False,
            'CreatedDate': datetime(2015, 1, 1),
            'UpdatedDate': datetime(2015, 1, 1),
            'EndpointNetworkType': 'IPV4'|'IPV6'|'DUAL',
            'TargetConnectionNetworkType': 'IPV4'|'IPV6'
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- DBProxies (list) --
  
  A return value representing an arbitrary number of DBProxy data structures.
  - (dict) --
    
    The data structure representing a proxy managed by the RDS Proxy.
    
    This data type is used as a response element in the DescribeDBProxies action.
    - DBProxyName (string) --
      
      The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
    - DBProxyArn (string) --
      
      The Amazon Resource Name (ARN) for the proxy.
    - Status (string) --
      
      The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
    - EngineFamily (string) --
      
      The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.
    - VpcId (string) --
      
      Provides the VPC ID of the DB proxy.
    - VpcSecurityGroupIds (list) --
      
      Provides a list of VPC security groups that the proxy belongs to.
      - (string) --
    - VpcSubnetIds (list) --
      
      The EC2 subnet IDs for the proxy.
      - (string) --
    - Auth (list) --
      
      One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
      - (dict) --
        
        Returns the details of authentication used by a proxy to log in as a specific database user.
        
        Description (string) --
        
        A user-specified description about the authentication used by a proxy to log in as a specific database user.
        
        UserName (string) --
        
        The name of the database user to which the proxy connects.
        
        AuthScheme (string) --
        
        The type of authentication that the proxy uses for connections from the proxy to the underlying database.
        
        SecretArn (string) --
        
        The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
        
        IAMAuth (string) --
        
        Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
        
        ClientPasswordAuthType (string) --
        
        The type of authentication the proxy uses for connections from clients.
    - RoleArn (string) --
      
      The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
    - Endpoint (string) --
      
      The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
    - RequireTLS (boolean) --
      
      Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
    - IdleClientTimeout (integer) --
      
      The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
      
      Default: 1800 (30 minutes)
      
      Constraints: 1 to 28,800
    - DebugLogging (boolean) --
      
      Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.
    - CreatedDate (datetime) --
      
      The date and time when the proxy was first created.
    - UpdatedDate (datetime) --
      
      The date and time when the proxy was last updated.
    - EndpointNetworkType (string) --
      
      The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
      
      Valid values:
      - IPV4 - The proxy endpoint supports IPv4 only.
      - IPV6 - The proxy endpoint supports IPv6 only.
      - DUAL - The proxy endpoint supports both IPv4 and IPv6.
    - TargetConnectionNetworkType (string) --
      
      The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
      
      Valid values:
      - IPV4 - The proxy connects to the database using IPv4 only.
      - IPV6 - The proxy connects to the database using IPv6 only.
- Marker (string) --
  
  An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

DescribeDBProxyEndpoints (updated)

Link ¶
Changes (response)

{'DBProxyEndpoints': {'EndpointNetworkType': 'IPV4 | IPV6 | DUAL'}}

Returns information about DB proxy endpoints.

See also: AWS API Documentation

Request Syntax

client.describe_db_proxy_endpoints(
    DBProxyName='string',
    DBProxyEndpointName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123
)

type DBProxyName:

string

param DBProxyName:

The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.

type DBProxyEndpointName:

string

param DBProxyEndpointName:

The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.

type Filters:

list

param Filters:

This parameter is not currently supported.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:
- DescribeDBClusterBacktracks
- DescribeDBClusterEndpoints
- DescribeDBClusters
- DescribeDBInstances
- DescribeDBRecommendations
- DescribeDBShardGroups
- DescribePendingMaintenanceActions
- Name (string) -- [REQUIRED]
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) -- [REQUIRED]
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type Marker:

string

param Marker:

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

type MaxRecords:

integer

param MaxRecords:

Default: 100

Constraints: Minimum 20, maximum 100.

rtype:

dict

returns:

Response Syntax

{
    'DBProxyEndpoints': [
        {
            'DBProxyEndpointName': 'string',
            'DBProxyEndpointArn': 'string',
            'DBProxyName': 'string',
            'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
            'VpcId': 'string',
            'VpcSecurityGroupIds': [
                'string',
            ],
            'VpcSubnetIds': [
                'string',
            ],
            'Endpoint': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'TargetRole': 'READ_WRITE'|'READ_ONLY',
            'IsDefault': True|False,
            'EndpointNetworkType': 'IPV4'|'IPV6'|'DUAL'
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- DBProxyEndpoints (list) --
  
  The list of ProxyEndpoint objects returned by the API operation.
  - (dict) --
    
    The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.
    
    This data type is used as a response element in the DescribeDBProxyEndpoints operation.
    - DBProxyEndpointName (string) --
      
      The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
    - DBProxyEndpointArn (string) --
      
      The Amazon Resource Name (ARN) for the DB proxy endpoint.
    - DBProxyName (string) --
      
      The identifier for the DB proxy that is associated with this DB proxy endpoint.
    - Status (string) --
      
      The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
    - VpcId (string) --
      
      Provides the VPC ID of the DB proxy endpoint.
    - VpcSecurityGroupIds (list) --
      
      Provides a list of VPC security groups that the DB proxy endpoint belongs to.
      - (string) --
    - VpcSubnetIds (list) --
      
      The EC2 subnet IDs for the DB proxy endpoint.
      - (string) --
    - Endpoint (string) --
      
      The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
    - CreatedDate (datetime) --
      
      The date and time when the DB proxy endpoint was first created.
    - TargetRole (string) --
      
      A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    - IsDefault (boolean) --
      
      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.
    - EndpointNetworkType (string) --
      
      The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
      
      Valid values:
      - IPV4 - The proxy endpoint supports IPv4 only.
      - IPV6 - The proxy endpoint supports IPv6 only.
      - DUAL - The proxy endpoint supports both IPv4 and IPv6.
- Marker (string) --
  
  An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

ModifyDBProxy (updated)

Link ¶
Changes (response)

{'DBProxy': {'EndpointNetworkType': 'IPV4 | IPV6 | DUAL',
             'TargetConnectionNetworkType': 'IPV4 | IPV6'}}

Changes the settings for an existing DB proxy.

See also: AWS API Documentation

Request Syntax

client.modify_db_proxy(
    DBProxyName='string',
    NewDBProxyName='string',
    Auth=[
        {
            'Description': 'string',
            'UserName': 'string',
            'AuthScheme': 'SECRETS',
            'SecretArn': 'string',
            'IAMAuth': 'DISABLED'|'REQUIRED'|'ENABLED',
            'ClientPasswordAuthType': 'MYSQL_NATIVE_PASSWORD'|'MYSQL_CACHING_SHA2_PASSWORD'|'POSTGRES_SCRAM_SHA_256'|'POSTGRES_MD5'|'SQL_SERVER_AUTHENTICATION'
        },
    ],
    RequireTLS=True|False,
    IdleClientTimeout=123,
    DebugLogging=True|False,
    RoleArn='string',
    SecurityGroups=[
        'string',
    ]
)

type DBProxyName:

string

param DBProxyName:

[REQUIRED]

The identifier for the DBProxy to modify.

type NewDBProxyName:

string

param NewDBProxyName:

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

type Auth:

list

param Auth:

The new authentication settings for the DBProxy.

(dict) --

Specifies the details of authentication used by a proxy to log in as a specific database user.
- Description (string) --
  
  A user-specified description about the authentication used by a proxy to log in as a specific database user.
- UserName (string) --
  
  The name of the database user to which the proxy connects.
- AuthScheme (string) --
  
  The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- SecretArn (string) --
  
  The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
- IAMAuth (string) --
  
  A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
- ClientPasswordAuthType (string) --
  
  The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines:
  - RDS for MySQL: MYSQL_CACHING_SHA2_PASSWORD
  - RDS for SQL Server: SQL_SERVER_AUTHENTICATION
  - RDS for PostgreSQL: POSTGRES_SCRAM_SHA2_256

type RequireTLS:

boolean

param RequireTLS:

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.

type IdleClientTimeout:

integer

param IdleClientTimeout:

type DebugLogging:

boolean

param DebugLogging:

type RoleArn:

string

param RoleArn:

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

type SecurityGroups:

list

param SecurityGroups:

The new list of security groups for the DBProxy.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'DBProxy': {
        'DBProxyName': 'string',
        'DBProxyArn': 'string',
        'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating',
        'EngineFamily': 'string',
        'VpcId': 'string',
        'VpcSecurityGroupIds': [
            'string',
        ],
        'VpcSubnetIds': [
            'string',
        ],
        'Auth': [
            {
                'Description': 'string',
                'UserName': 'string',
                'AuthScheme': 'SECRETS',
                'SecretArn': 'string',
                'IAMAuth': 'DISABLED'|'REQUIRED'|'ENABLED',
                'ClientPasswordAuthType': 'MYSQL_NATIVE_PASSWORD'|'MYSQL_CACHING_SHA2_PASSWORD'|'POSTGRES_SCRAM_SHA_256'|'POSTGRES_MD5'|'SQL_SERVER_AUTHENTICATION'
            },
        ],
        'RoleArn': 'string',
        'Endpoint': 'string',
        'RequireTLS': True|False,
        'IdleClientTimeout': 123,
        'DebugLogging': True|False,
        'CreatedDate': datetime(2015, 1, 1),
        'UpdatedDate': datetime(2015, 1, 1),
        'EndpointNetworkType': 'IPV4'|'IPV6'|'DUAL',
        'TargetConnectionNetworkType': 'IPV4'|'IPV6'
    }
}

Response Structure

(dict) --
- DBProxy (dict) --
  
  The DBProxy object representing the new settings for the proxy.
  - DBProxyName (string) --
    
    The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
  - DBProxyArn (string) --
    
    The Amazon Resource Name (ARN) for the proxy.
  - Status (string) --
    
    The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
  - EngineFamily (string) --
    
    The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.
  - VpcId (string) --
    
    Provides the VPC ID of the DB proxy.
  - VpcSecurityGroupIds (list) --
    
    Provides a list of VPC security groups that the proxy belongs to.
    - (string) --
  - VpcSubnetIds (list) --
    
    The EC2 subnet IDs for the proxy.
    - (string) --
  - Auth (list) --
    
    One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
    - (dict) --
      
      Returns the details of authentication used by a proxy to log in as a specific database user.
      - Description (string) --
        
        A user-specified description about the authentication used by a proxy to log in as a specific database user.
      - UserName (string) --
        
        The name of the database user to which the proxy connects.
      - AuthScheme (string) --
        
        The type of authentication that the proxy uses for connections from the proxy to the underlying database.
      - SecretArn (string) --
        
        The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
      - IAMAuth (string) --
        
        Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
      - ClientPasswordAuthType (string) --
        
        The type of authentication the proxy uses for connections from clients.
  - RoleArn (string) --
    
    The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
  - Endpoint (string) --
    
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
  - RequireTLS (boolean) --
    
    Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
  - IdleClientTimeout (integer) --
    
    The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
    
    Default: 1800 (30 minutes)
    
    Constraints: 1 to 28,800
  - DebugLogging (boolean) --
    
    Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.
  - CreatedDate (datetime) --
    
    The date and time when the proxy was first created.
  - UpdatedDate (datetime) --
    
    The date and time when the proxy was last updated.
  - EndpointNetworkType (string) --
    
    The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
    
    Valid values:
    - IPV4 - The proxy endpoint supports IPv4 only.
    - IPV6 - The proxy endpoint supports IPv6 only.
    - DUAL - The proxy endpoint supports both IPv4 and IPv6.
  - TargetConnectionNetworkType (string) --
    
    The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
    
    Valid values:
    - IPV4 - The proxy connects to the database using IPv4 only.
    - IPV6 - The proxy connects to the database using IPv6 only.

ModifyDBProxyEndpoint (updated)

Link ¶
Changes (response)

{'DBProxyEndpoint': {'EndpointNetworkType': 'IPV4 | IPV6 | DUAL'}}

Changes the settings for an existing DB proxy endpoint.

See also: AWS API Documentation

Request Syntax

client.modify_db_proxy_endpoint(
    DBProxyEndpointName='string',
    NewDBProxyEndpointName='string',
    VpcSecurityGroupIds=[
        'string',
    ]
)

type DBProxyEndpointName:

string

param DBProxyEndpointName:

[REQUIRED]

The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.

type NewDBProxyEndpointName:

string

param NewDBProxyEndpointName:

The new identifier for the DBProxyEndpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'DBProxyEndpoint': {
        'DBProxyEndpointName': 'string',
        'DBProxyEndpointArn': 'string',
        'DBProxyName': 'string',
        'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
        'VpcId': 'string',
        'VpcSecurityGroupIds': [
            'string',
        ],
        'VpcSubnetIds': [
            'string',
        ],
        'Endpoint': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'TargetRole': 'READ_WRITE'|'READ_ONLY',
        'IsDefault': True|False,
        'EndpointNetworkType': 'IPV4'|'IPV6'|'DUAL'
    }
}

Response Structure

(dict) --
- DBProxyEndpoint (dict) --
  
  The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.
  - DBProxyEndpointName (string) --
    
    The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
  - DBProxyEndpointArn (string) --
    
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
  - DBProxyName (string) --
    
    The identifier for the DB proxy that is associated with this DB proxy endpoint.
  - Status (string) --
    
    The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
  - VpcId (string) --
    
    Provides the VPC ID of the DB proxy endpoint.
  - VpcSecurityGroupIds (list) --
    
    Provides a list of VPC security groups that the DB proxy endpoint belongs to.
    - (string) --
  - VpcSubnetIds (list) --
    
    The EC2 subnet IDs for the DB proxy endpoint.
    - (string) --
  - Endpoint (string) --
    
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
  - CreatedDate (datetime) --
    
    The date and time when the DB proxy endpoint was first created.
  - TargetRole (string) --
    
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
  - IsDefault (boolean) --
    
    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.
  - EndpointNetworkType (string) --
    
    The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
    
    Valid values:
    - IPV4 - The proxy endpoint supports IPv4 only.
    - IPV6 - The proxy endpoint supports IPv6 only.
    - DUAL - The proxy endpoint supports both IPv4 and IPv6.