2021/03/09 - Amazon Relational Database Service - 4 new 6 updated api methods
Changes This release adds support for Amazon RDS Proxy endpoints.
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',
]
)
string
[REQUIRED]
The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.
string
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.
list
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) --
dict
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
}
}
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) --
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.
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'
)
string
[REQUIRED]
The name of the DB proxy endpoint to delete.
dict
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
}
}
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) --
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.
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'
},
]
)
string
[REQUIRED]
The name of the DB proxy associated with the DB proxy endpoint that you create.
string
[REQUIRED]
The name of the DB proxy endpoint to create.
list
[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) --
list
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) --
string
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE .
list
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
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}_.:/=+\-@]*)$").
dict
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
}
}
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) --
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.
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
)
string
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.
string
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.
list
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
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) --
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 .
integer
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.
dict
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
},
],
'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) --
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.
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 .
{'DBProxy': {'VpcId': 'string'}}
Creates a new DB proxy.
See also: AWS API Documentation
Request Syntax
client.create_db_proxy(
DBProxyName='string',
EngineFamily='MYSQL'|'POSTGRESQL',
Auth=[
{
'Description': 'string',
'UserName': 'string',
'AuthScheme': 'SECRETS',
'SecretArn': 'string',
'IAMAuth': 'DISABLED'|'REQUIRED'
},
],
RoleArn='string',
VpcSubnetIds=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
RequireTLS=True|False,
IdleClientTimeout=123,
DebugLogging=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS 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.
string
[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. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
list
[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) --
Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
list
[REQUIRED]
One or more VPC subnet IDs to associate with the new proxy.
(string) --
list
One or more VPC security group IDs to associate with the new proxy.
(string) --
boolean
A Boolean parameter that 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.
integer
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.
boolean
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
list
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.
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}_.:/=+\-@]*)$").
dict
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'
},
],
'RoleArn': 'string',
'Endpoint': 'string',
'RequireTLS': True|False,
'IdleClientTimeout': 123,
'DebugLogging': True|False,
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
}
}
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 AWS account in the specified AWS 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 engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
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 AWS Identity and Access Management (IAM) authentication for connections to the proxy.
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) --
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
CreatedDate (datetime) --
The date and time when the proxy was first created.
UpdatedDate (datetime) --
The date and time when the proxy was last updated.
{'DBProxy': {'VpcId': 'string'}}
Deletes an existing DB proxy.
See also: AWS API Documentation
Request Syntax
client.delete_db_proxy(
DBProxyName='string'
)
string
[REQUIRED]
The name of the DB proxy to delete.
dict
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'
},
],
'RoleArn': 'string',
'Endpoint': 'string',
'RequireTLS': True|False,
'IdleClientTimeout': 123,
'DebugLogging': True|False,
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
}
}
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 AWS account in the specified AWS 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 engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
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 AWS Identity and Access Management (IAM) authentication for connections to the proxy.
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) --
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
CreatedDate (datetime) --
The date and time when the proxy was first created.
UpdatedDate (datetime) --
The date and time when the proxy was last updated.
{'DBProxies': {'VpcId': 'string'}}
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
)
string
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your AWS account ID.
list
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
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) --
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 .
integer
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.
dict
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'
},
],
'RoleArn': 'string',
'Endpoint': 'string',
'RequireTLS': True|False,
'IdleClientTimeout': 123,
'DebugLogging': True|False,
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
},
],
'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 AWS account in the specified AWS 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 engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
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 AWS Identity and Access Management (IAM) authentication for connections to the proxy.
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) --
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
CreatedDate (datetime) --
The date and time when the proxy was first created.
UpdatedDate (datetime) --
The date and time when the proxy was last updated.
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 .
{'Targets': {'Role': 'READ_WRITE | READ_ONLY | UNKNOWN',
'TargetHealth': {'Reason': {'INVALID_REPLICATION_STATE'}}}}
Returns information about DBProxyTarget objects. This API supports pagination.
See also: AWS API Documentation
Request Syntax
client.describe_db_proxy_targets(
DBProxyName='string',
TargetGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
string
[REQUIRED]
The identifier of the DBProxyTarget to describe.
string
The identifier of the DBProxyTargetGroup to describe.
list
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
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) --
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 .
integer
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.
dict
Response Syntax
{
'Targets': [
{
'TargetArn': 'string',
'Endpoint': 'string',
'TrackedClusterId': 'string',
'RdsResourceId': 'string',
'Port': 123,
'Type': 'RDS_INSTANCE'|'RDS_SERVERLESS_ENDPOINT'|'TRACKED_CLUSTER',
'Role': 'READ_WRITE'|'READ_ONLY'|'UNKNOWN',
'TargetHealth': {
'State': 'REGISTERING'|'AVAILABLE'|'UNAVAILABLE',
'Reason': 'UNREACHABLE'|'CONNECTION_FAILED'|'AUTH_FAILURE'|'PENDING_PROXY_CAPACITY'|'INVALID_REPLICATION_STATE',
'Description': 'string'
}
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Targets (list) --
An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
(dict) --
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets action.
TargetArn (string) --
The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
Endpoint (string) --
The writer endpoint for the RDS DB instance or Aurora DB cluster.
TrackedClusterId (string) --
The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
RdsResourceId (string) --
The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
Port (integer) --
The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
Type (string) --
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
Role (string) --
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
TargetHealth (dict) --
Information about the connection health of the RDS Proxy target.
State (string) --
The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering > unavailable > available > unavailable > available
Reason (string) --
The reason for the current health State of the RDS Proxy target.
Description (string) --
A description of the health of the RDS Proxy target. If the State is AVAILABLE , a description is not included.
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 .
{'DBProxy': {'VpcId': 'string'}}
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'
},
],
RequireTLS=True|False,
IdleClientTimeout=123,
DebugLogging=True|False,
RoleArn='string',
SecurityGroups=[
'string',
]
)
string
[REQUIRED]
The identifier for the DBProxy to modify.
string
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.
list
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) --
Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
boolean
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.
integer
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.
boolean
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
string
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
list
The new list of security groups for the DBProxy .
(string) --
dict
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'
},
],
'RoleArn': 'string',
'Endpoint': 'string',
'RequireTLS': True|False,
'IdleClientTimeout': 123,
'DebugLogging': True|False,
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
}
}
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 AWS account in the specified AWS 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 engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
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 AWS Identity and Access Management (IAM) authentication for connections to the proxy.
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) --
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
CreatedDate (datetime) --
The date and time when the proxy was first created.
UpdatedDate (datetime) --
The date and time when the proxy was last updated.
{'DBProxyTargets': {'Role': 'READ_WRITE | READ_ONLY | UNKNOWN',
'TargetHealth': {'Reason': {'INVALID_REPLICATION_STATE'}}}}
Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup .
See also: AWS API Documentation
Request Syntax
client.register_db_proxy_targets(
DBProxyName='string',
TargetGroupName='string',
DBInstanceIdentifiers=[
'string',
],
DBClusterIdentifiers=[
'string',
]
)
string
[REQUIRED]
The identifier of the DBProxy that is associated with the DBProxyTargetGroup .
string
The identifier of the DBProxyTargetGroup .
list
One or more DB instance identifiers.
(string) --
list
One or more DB cluster identifiers.
(string) --
dict
Response Syntax
{
'DBProxyTargets': [
{
'TargetArn': 'string',
'Endpoint': 'string',
'TrackedClusterId': 'string',
'RdsResourceId': 'string',
'Port': 123,
'Type': 'RDS_INSTANCE'|'RDS_SERVERLESS_ENDPOINT'|'TRACKED_CLUSTER',
'Role': 'READ_WRITE'|'READ_ONLY'|'UNKNOWN',
'TargetHealth': {
'State': 'REGISTERING'|'AVAILABLE'|'UNAVAILABLE',
'Reason': 'UNREACHABLE'|'CONNECTION_FAILED'|'AUTH_FAILURE'|'PENDING_PROXY_CAPACITY'|'INVALID_REPLICATION_STATE',
'Description': 'string'
}
},
]
}
Response Structure
(dict) --
DBProxyTargets (list) --
One or more DBProxyTarget objects that are created when you register targets with a target group.
(dict) --
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets action.
TargetArn (string) --
The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
Endpoint (string) --
The writer endpoint for the RDS DB instance or Aurora DB cluster.
TrackedClusterId (string) --
The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
RdsResourceId (string) --
The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
Port (integer) --
The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
Type (string) --
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
Role (string) --
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
TargetHealth (dict) --
Information about the connection health of the RDS Proxy target.
State (string) --
The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering > unavailable > available > unavailable > available
Reason (string) --
The reason for the current health State of the RDS Proxy target.
Description (string) --
A description of the health of the RDS Proxy target. If the State is AVAILABLE , a description is not included.