create_db_proxy_endpoint
¶
create_db_proxy_endpoint(
*,
config_overrides: Optional[RDSClientConfig] = None,
db_proxy_name: Optional[DBProxyName] = None,
db_proxy_endpoint_name: Optional[DBProxyEndpointName] = None,
vpc_subnet_ids: Optional[StringList] = None,
vpc_security_group_ids: Optional[StringList] = None,
target_role: Optional[DBProxyEndpointTargetRole] = None,
tags: Optional[TagList] = None,
endpoint_network_type: Optional[EndpointNetworkType] = None,
) -> CreateDBProxyEndpointResponse
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.
Parameters:
-
db_proxy_name(Optional[DBProxyName], default:None) –The name of the DB proxy associated with the DB proxy endpoint that you create.
-
db_proxy_endpoint_name(Optional[DBProxyEndpointName], default:None) –The name of the DB proxy endpoint to create.
-
vpc_subnet_ids(Optional[StringList], default:None) –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.
-
vpc_security_group_ids(Optional[StringList], default:None) –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.
-
target_role(Optional[DBProxyEndpointTargetRole], default:None) –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 isREAD_WRITE. -
endpoint_network_type(Optional[EndpointNetworkType], default:None) –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:
IPV4Constraints:
-
If you specify
IPV6orDUAL, the VPC and all subnets must have an IPv6 CIDR block. -
If you specify
IPV6orDUAL, the VPC tenancy cannot bededicated.
-
Raises:
-
DBProxyEndpointAlreadyExistsFault–The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
-
DBProxyEndpointQuotaExceededFault–The DB proxy already has the maximum number of endpoints.
-
DBProxyNotFoundFault–The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
-
InvalidDBProxyStateFault–The requested operation can't be performed while the proxy is in this state.
-
InvalidSubnet–The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_rds/_services/rds.py
3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 | |