Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. DbProxyEndpoint

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.DbProxyEndpoint

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::RDS::DBProxyEndpoint.

    Create DbProxyEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DbProxyEndpoint(name: string, args: DbProxyEndpointArgs, opts?: CustomResourceOptions);
    @overload
def DbProxyEndpoint(resource_name: str,
                    args: DbProxyEndpointArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def DbProxyEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    db_proxy_name: Optional[str] = None,
                    vpc_subnet_ids: Optional[Sequence[str]] = None,
                    db_proxy_endpoint_name: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                    target_role: Optional[DbProxyEndpointTargetRole] = None,
                    vpc_security_group_ids: Optional[Sequence[str]] = 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.

    Parameters

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DbProxyEndpoint resource accepts the following input properties:

    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.
    VpcSubnetIds List<string>
    VPC subnet IDs to associate with the new DB proxy endpoint.
    DbProxyEndpointName string
    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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    TargetRole Pulumi.AwsNative.Rds.DbProxyEndpointTargetRole
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    VpcSecurityGroupIds List<string>
    VPC security group IDs to associate with the new DB proxy endpoint.
    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.
    VpcSubnetIds []string
    VPC subnet IDs to associate with the new DB proxy endpoint.
    DbProxyEndpointName string
    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.
    Tags TagArgs
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    TargetRole DbProxyEndpointTargetRole
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    VpcSecurityGroupIds []string
    VPC security group IDs to associate with the new DB proxy endpoint.
    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.
    vpcSubnetIds List<String>
    VPC subnet IDs to associate with the new DB proxy endpoint.
    dbProxyEndpointName String
    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.
    tags List<Tag>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    targetRole DbProxyEndpointTargetRole
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    vpcSecurityGroupIds List<String>
    VPC security group IDs to associate with the new DB proxy endpoint.
    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.
    vpcSubnetIds string[]
    VPC subnet IDs to associate with the new DB proxy endpoint.
    dbProxyEndpointName string
    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.
    tags Tag[]
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    targetRole DbProxyEndpointTargetRole
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    vpcSecurityGroupIds string[]
    VPC security group IDs to associate with the new DB proxy endpoint.
    db_proxy_name str
    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_ids Sequence[str]
    VPC subnet IDs to associate with the new DB proxy endpoint.
    db_proxy_endpoint_name str
    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.
    tags Sequence[TagArgs]
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    target_role DbProxyEndpointTargetRole
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    vpc_security_group_ids Sequence[str]
    VPC security group IDs to associate with the new DB proxy endpoint.
    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.
    vpcSubnetIds List<String>
    VPC subnet IDs to associate with the new DB proxy endpoint.
    dbProxyEndpointName String
    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.
    tags List<Property Map>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    targetRole "READ_WRITE" | "READ_ONLY"
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    vpcSecurityGroupIds List<String>
    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:

    DbProxyEndpointArn string
    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.
    IsDefault 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.
    VpcId string
    VPC ID to associate with the new DB proxy endpoint.
    DbProxyEndpointArn string
    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.
    IsDefault 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.
    VpcId string
    VPC ID to associate with the new DB proxy endpoint.
    dbProxyEndpointArn String
    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.
    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.
    vpcId String
    VPC ID to associate with the new DB proxy endpoint.
    dbProxyEndpointArn string
    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.
    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.
    vpcId string
    VPC ID to associate with the new DB proxy endpoint.
    db_proxy_endpoint_arn str
    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.
    dbProxyEndpointArn String
    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.
    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.
    vpcId String
    VPC ID to associate with the new DB proxy endpoint.

    Supporting Types

    DbProxyEndpointTargetRole, DbProxyEndpointTargetRoleArgs

    ReadWrite
    READ_WRITE
    ReadOnly
    READ_ONLY
    DbProxyEndpointTargetRoleReadWrite
    READ_WRITE
    DbProxyEndpointTargetRoleReadOnly
    READ_ONLY
    ReadWrite
    READ_WRITE
    ReadOnly
    READ_ONLY
    ReadWrite
    READ_WRITE
    ReadOnly
    READ_ONLY
    READ_WRITE
    READ_WRITE
    READ_ONLY
    READ_ONLY
    "READ_WRITE"
    READ_WRITE
    "READ_ONLY"
    READ_ONLY

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native