AWS Native is in preview. AWS Classic is fully supported.
aws-native.rds.DBProxyEndpoint
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource schema for AWS::RDS::DBProxyEndpoint.
Create DBProxyEndpoint Resource
new DBProxyEndpoint(name: string, args: DBProxyEndpointArgs, opts?: CustomResourceOptions);
@overload
def DBProxyEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
d_b_proxy_endpoint_name: Optional[str] = None,
d_b_proxy_name: Optional[str] = None,
tags: Optional[Sequence[DBProxyEndpointTagFormatArgs]] = None,
target_role: Optional[DBProxyEndpointTargetRole] = None,
vpc_security_group_ids: Optional[Sequence[str]] = None,
vpc_subnet_ids: Optional[Sequence[str]] = None)
@overload
def DBProxyEndpoint(resource_name: str,
args: DBProxyEndpointArgs,
opts: Optional[ResourceOptions] = None)
func NewDBProxyEndpoint(ctx *Context, name string, args DBProxyEndpointArgs, opts ...ResourceOption) (*DBProxyEndpoint, error)
public DBProxyEndpoint(string name, DBProxyEndpointArgs args, CustomResourceOptions? opts = null)
public DBProxyEndpoint(String name, DBProxyEndpointArgs args)
public DBProxyEndpoint(String name, DBProxyEndpointArgs args, CustomResourceOptions options)
type: aws-native:rds:DBProxyEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DBProxyEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DBProxyEndpointArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DBProxyEndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DBProxyEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DBProxyEndpointArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DBProxyEndpoint Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The DBProxyEndpoint resource accepts the following input properties:
- DBProxy
Name string The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
- Vpc
Subnet List<string>Ids VPC subnet IDs to associate with the new DB proxy endpoint.
- DBProxy
Endpoint stringName The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
- List<Pulumi.
Aws Native. RDS. Inputs. DBProxy Endpoint Tag Format Args> An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- Target
Role Pulumi.Aws Native. RDS. DBProxy Endpoint Target Role A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- Vpc
Security List<string>Group Ids VPC security group IDs to associate with the new DB proxy endpoint.
- DBProxy
Name string The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
- Vpc
Subnet []stringIds VPC subnet IDs to associate with the new DB proxy endpoint.
- DBProxy
Endpoint stringName The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
- []DBProxy
Endpoint Tag Format Args An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- Target
Role DBProxyEndpoint Target Role A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- Vpc
Security []stringGroup Ids VPC security group IDs to associate with the new DB proxy endpoint.
- d
BProxy StringName The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
- vpc
Subnet List<String>Ids VPC subnet IDs to associate with the new DB proxy endpoint.
- d
BProxy StringEndpoint Name The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
- List<DBProxy
Endpoint Tag Format Args> An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- target
Role DBProxyEndpoint Target Role A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- vpc
Security List<String>Group Ids VPC security group IDs to associate with the new DB proxy endpoint.
- d
BProxy stringName The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
- vpc
Subnet string[]Ids VPC subnet IDs to associate with the new DB proxy endpoint.
- d
BProxy stringEndpoint Name The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
- DBProxy
Endpoint Tag Format Args[] An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- target
Role DBProxyEndpoint Target Role A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- vpc
Security string[]Group Ids VPC security group IDs to associate with the new DB proxy endpoint.
- d_
b_ strproxy_ name The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
- vpc_
subnet_ Sequence[str]ids VPC subnet IDs to associate with the new DB proxy endpoint.
- d_
b_ strproxy_ endpoint_ name The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
- Sequence[DBProxy
Endpoint Tag Format Args] An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- target_
role DBProxyEndpoint Target Role A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- vpc_
security_ Sequence[str]group_ ids VPC security group IDs to associate with the new DB proxy endpoint.
- d
BProxy StringName The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
- vpc
Subnet List<String>Ids VPC subnet IDs to associate with the new DB proxy endpoint.
- d
BProxy StringEndpoint Name The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
- List<Property Map>
An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- target
Role "READ_WRITE" | "READ_ONLY" A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- vpc
Security List<String>Group Ids VPC security group IDs to associate with the new DB proxy endpoint.
Outputs
All input properties are implicitly available as output properties. Additionally, the DBProxyEndpoint resource produces the following output properties:
- DBProxy
Endpoint stringArn The Amazon Resource Name (ARN) for the DB proxy endpoint.
- 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.
- Id string
The provider-assigned unique ID for this managed resource.
- Is
Default bool 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.
- Vpc
Id string VPC ID to associate with the new DB proxy endpoint.
- DBProxy
Endpoint stringArn The Amazon Resource Name (ARN) for the DB proxy endpoint.
- 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.
- Id string
The provider-assigned unique ID for this managed resource.
- Is
Default bool 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.
- Vpc
Id string VPC ID to associate with the new DB proxy endpoint.
- d
BProxy StringEndpoint Arn The Amazon Resource Name (ARN) for the DB proxy endpoint.
- 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.
- id String
The provider-assigned unique ID for this managed resource.
- is
Default 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.
- vpc
Id String VPC ID to associate with the new DB proxy endpoint.
- d
BProxy stringEndpoint Arn The Amazon Resource Name (ARN) for the DB proxy endpoint.
- 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.
- id string
The provider-assigned unique ID for this managed resource.
- is
Default 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.
- vpc
Id string VPC ID to associate with the new DB proxy endpoint.
- d_
b_ strproxy_ endpoint_ arn The Amazon Resource Name (ARN) for the DB proxy endpoint.
- endpoint str
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.
- id str
The provider-assigned unique ID for this managed resource.
- is_
default bool 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.
- vpc_
id str VPC ID to associate with the new DB proxy endpoint.
- d
BProxy StringEndpoint Arn The Amazon Resource Name (ARN) for the DB proxy endpoint.
- 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.
- id String
The provider-assigned unique ID for this managed resource.
- is
Default 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.
- vpc
Id String VPC ID to associate with the new DB proxy endpoint.
Supporting Types
DBProxyEndpointTagFormat
DBProxyEndpointTargetRole
- Read
Write - READ_WRITE
- Read
Only - READ_ONLY
- DBProxy
Endpoint Target Role Read Write - READ_WRITE
- DBProxy
Endpoint Target Role Read Only - READ_ONLY
- Read
Write - READ_WRITE
- Read
Only - READ_ONLY
- Read
Write - READ_WRITE
- Read
Only - READ_ONLY
- READ_WRITE
- READ_WRITE
- READ_ONLY
- READ_ONLY
- "READ_WRITE"
- READ_WRITE
- "READ_ONLY"
- READ_ONLY
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.