Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. rds
  5. Proxy

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.rds.Proxy

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an RDS DB proxy resource. For additional information, see the RDS User Guide.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.rds.Proxy("example", {
    name: "example",
    debugLogging: false,
    engineFamily: "MYSQL",
    idleClientTimeout: 1800,
    requireTls: true,
    roleArn: exampleAwsIamRole.arn,
    vpcSecurityGroupIds: [exampleAwsSecurityGroup.id],
    vpcSubnetIds: [exampleAwsSubnet.id],
    auths: [{
        authScheme: "SECRETS",
        description: "example",
        iamAuth: "DISABLED",
        secretArn: exampleAwsSecretsmanagerSecret.arn,
    }],
    tags: {
        Name: "example",
        Key: "value",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.rds.Proxy("example",
    name="example",
    debug_logging=False,
    engine_family="MYSQL",
    idle_client_timeout=1800,
    require_tls=True,
    role_arn=example_aws_iam_role["arn"],
    vpc_security_group_ids=[example_aws_security_group["id"]],
    vpc_subnet_ids=[example_aws_subnet["id"]],
    auths=[{
        "authScheme": "SECRETS",
        "description": "example",
        "iamAuth": "DISABLED",
        "secretArn": example_aws_secretsmanager_secret["arn"],
    }],
    tags={
        "Name": "example",
        "Key": "value",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.NewProxy(ctx, "example", &rds.ProxyArgs{
			Name:              pulumi.String("example"),
			DebugLogging:      pulumi.Bool(false),
			EngineFamily:      pulumi.String("MYSQL"),
			IdleClientTimeout: pulumi.Int(1800),
			RequireTls:        pulumi.Bool(true),
			RoleArn:           pulumi.Any(exampleAwsIamRole.Arn),
			VpcSecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			VpcSubnetIds: pulumi.StringArray{
				exampleAwsSubnet.Id,
			},
			Auths: rds.ProxyAuthArray{
				&rds.ProxyAuthArgs{
					AuthScheme:  pulumi.String("SECRETS"),
					Description: pulumi.String("example"),
					IamAuth:     pulumi.String("DISABLED"),
					SecretArn:   pulumi.Any(exampleAwsSecretsmanagerSecret.Arn),
				},
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example"),
				"Key":  pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Rds.Proxy("example", new()
    {
        Name = "example",
        DebugLogging = false,
        EngineFamily = "MYSQL",
        IdleClientTimeout = 1800,
        RequireTls = true,
        RoleArn = exampleAwsIamRole.Arn,
        VpcSecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        VpcSubnetIds = new[]
        {
            exampleAwsSubnet.Id,
        },
        Auths = new[]
        {
            new Aws.Rds.Inputs.ProxyAuthArgs
            {
                AuthScheme = "SECRETS",
                Description = "example",
                IamAuth = "DISABLED",
                SecretArn = exampleAwsSecretsmanagerSecret.Arn,
            },
        },
        Tags = 
        {
            { "Name", "example" },
            { "Key", "value" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Proxy;
import com.pulumi.aws.rds.ProxyArgs;
import com.pulumi.aws.rds.inputs.ProxyAuthArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Proxy("example", ProxyArgs.builder()
            .name("example")
            .debugLogging(false)
            .engineFamily("MYSQL")
            .idleClientTimeout(1800)
            .requireTls(true)
            .roleArn(exampleAwsIamRole.arn())
            .vpcSecurityGroupIds(exampleAwsSecurityGroup.id())
            .vpcSubnetIds(exampleAwsSubnet.id())
            .auths(ProxyAuthArgs.builder()
                .authScheme("SECRETS")
                .description("example")
                .iamAuth("DISABLED")
                .secretArn(exampleAwsSecretsmanagerSecret.arn())
                .build())
            .tags(Map.ofEntries(
                Map.entry("Name", "example"),
                Map.entry("Key", "value")
            ))
            .build());

    }
}

    resources:
  example:
    type: aws:rds:Proxy
    properties:
      name: example
      debugLogging: false
      engineFamily: MYSQL
      idleClientTimeout: 1800
      requireTls: true
      roleArn: ${exampleAwsIamRole.arn}
      vpcSecurityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      vpcSubnetIds:
        - ${exampleAwsSubnet.id}
      auths:
        - authScheme: SECRETS
          description: example
          iamAuth: DISABLED
          secretArn: ${exampleAwsSecretsmanagerSecret.arn}
      tags:
        Name: example
        Key: value

    Create Proxy Resource

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

    Constructor syntax

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

@overload
def Proxy(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          auths: Optional[Sequence[ProxyAuthArgs]] = None,
          engine_family: Optional[str] = None,
          role_arn: Optional[str] = None,
          vpc_subnet_ids: Optional[Sequence[str]] = None,
          debug_logging: Optional[bool] = None,
          idle_client_timeout: Optional[int] = None,
          name: Optional[str] = None,
          require_tls: Optional[bool] = None,
          tags: Optional[Mapping[str, str]] = None,
          vpc_security_group_ids: Optional[Sequence[str]] = None)
    func NewProxy(ctx *Context, name string, args ProxyArgs, opts ...ResourceOption) (*Proxy, error)
    public Proxy(string name, ProxyArgs args, CustomResourceOptions? opts = null)
    public Proxy(String name, ProxyArgs args)
public Proxy(String name, ProxyArgs args, CustomResourceOptions options)

    type: aws:rds:Proxy
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 ProxyArgs
    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 ProxyArgs
    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 ProxyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProxyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProxyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var proxyResource = new Aws.Rds.Proxy("proxyResource", new()
{
    Auths = new[]
    {
        new Aws.Rds.Inputs.ProxyAuthArgs
        {
            AuthScheme = "string",
            ClientPasswordAuthType = "string",
            Description = "string",
            IamAuth = "string",
            SecretArn = "string",
            Username = "string",
        },
    },
    EngineFamily = "string",
    RoleArn = "string",
    VpcSubnetIds = new[]
    {
        "string",
    },
    DebugLogging = false,
    IdleClientTimeout = 0,
    Name = "string",
    RequireTls = false,
    Tags = 
    {
        { "string", "string" },
    },
    VpcSecurityGroupIds = new[]
    {
        "string",
    },
});

    example, err := rds.NewProxy(ctx, "proxyResource", &rds.ProxyArgs{
	Auths: rds.ProxyAuthArray{
		&rds.ProxyAuthArgs{
			AuthScheme:             pulumi.String("string"),
			ClientPasswordAuthType: pulumi.String("string"),
			Description:            pulumi.String("string"),
			IamAuth:                pulumi.String("string"),
			SecretArn:              pulumi.String("string"),
			Username:               pulumi.String("string"),
		},
	},
	EngineFamily: pulumi.String("string"),
	RoleArn:      pulumi.String("string"),
	VpcSubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	DebugLogging:      pulumi.Bool(false),
	IdleClientTimeout: pulumi.Int(0),
	Name:              pulumi.String("string"),
	RequireTls:        pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var proxyResource = new Proxy("proxyResource", ProxyArgs.builder()
    .auths(ProxyAuthArgs.builder()
        .authScheme("string")
        .clientPasswordAuthType("string")
        .description("string")
        .iamAuth("string")
        .secretArn("string")
        .username("string")
        .build())
    .engineFamily("string")
    .roleArn("string")
    .vpcSubnetIds("string")
    .debugLogging(false)
    .idleClientTimeout(0)
    .name("string")
    .requireTls(false)
    .tags(Map.of("string", "string"))
    .vpcSecurityGroupIds("string")
    .build());

    proxy_resource = aws.rds.Proxy("proxyResource",
    auths=[{
        "authScheme": "string",
        "clientPasswordAuthType": "string",
        "description": "string",
        "iamAuth": "string",
        "secretArn": "string",
        "username": "string",
    }],
    engine_family="string",
    role_arn="string",
    vpc_subnet_ids=["string"],
    debug_logging=False,
    idle_client_timeout=0,
    name="string",
    require_tls=False,
    tags={
        "string": "string",
    },
    vpc_security_group_ids=["string"])

    const proxyResource = new aws.rds.Proxy("proxyResource", {
    auths: [{
        authScheme: "string",
        clientPasswordAuthType: "string",
        description: "string",
        iamAuth: "string",
        secretArn: "string",
        username: "string",
    }],
    engineFamily: "string",
    roleArn: "string",
    vpcSubnetIds: ["string"],
    debugLogging: false,
    idleClientTimeout: 0,
    name: "string",
    requireTls: false,
    tags: {
        string: "string",
    },
    vpcSecurityGroupIds: ["string"],
});

    type: aws:rds:Proxy
properties:
    auths:
        - authScheme: string
          clientPasswordAuthType: string
          description: string
          iamAuth: string
          secretArn: string
          username: string
    debugLogging: false
    engineFamily: string
    idleClientTimeout: 0
    name: string
    requireTls: false
    roleArn: string
    tags:
        string: string
    vpcSecurityGroupIds:
        - string
    vpcSubnetIds:
        - string

    Proxy 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 Proxy resource accepts the following input properties:

    Auths List<ProxyAuth>
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    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. 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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    VpcSubnetIds List<string>
    One or more VPC subnet IDs to associate with the new proxy.
    DebugLogging bool
    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.
    IdleClientTimeout int
    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.
    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. 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.
    RequireTls bool
    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.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    VpcSecurityGroupIds List<string>
    One or more VPC security group IDs to associate with the new proxy.
    Auths []ProxyAuthArgs
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    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. 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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    VpcSubnetIds []string
    One or more VPC subnet IDs to associate with the new proxy.
    DebugLogging bool
    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.
    IdleClientTimeout int
    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.
    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. 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.
    RequireTls bool
    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.
    Tags map[string]string
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    VpcSecurityGroupIds []string
    One or more VPC security group IDs to associate with the new proxy.
    auths List<ProxyAuth>
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    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. 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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    vpcSubnetIds List<String>
    One or more VPC subnet IDs to associate with the new proxy.
    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.
    idleClientTimeout 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.
    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. 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.
    requireTls 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.
    tags Map<String,String>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcSecurityGroupIds List<String>
    One or more VPC security group IDs to associate with the new proxy.
    auths ProxyAuth[]
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    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. 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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    roleArn string
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    vpcSubnetIds string[]
    One or more VPC subnet IDs to associate with the new proxy.
    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.
    idleClientTimeout number
    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.
    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. 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.
    requireTls 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.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcSecurityGroupIds string[]
    One or more VPC security group IDs to associate with the new proxy.
    auths Sequence[ProxyAuthArgs]
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    engine_family str
    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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    role_arn str
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    vpc_subnet_ids Sequence[str]
    One or more VPC subnet IDs to associate with the new proxy.
    debug_logging bool
    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.
    idle_client_timeout int
    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.
    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. 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.
    require_tls bool
    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.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpc_security_group_ids Sequence[str]
    One or more VPC security group IDs to associate with the new proxy.
    auths List<Property Map>
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    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. 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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    vpcSubnetIds List<String>
    One or more VPC subnet IDs to associate with the new proxy.
    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.
    idleClientTimeout Number
    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.
    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. 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.
    requireTls 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.
    tags Map<String>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcSecurityGroupIds List<String>
    One or more VPC security group IDs to associate with the new proxy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Proxy resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) for the proxy.
    Endpoint string
    The endpoint that you can use to connect to the 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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) for the proxy.
    Endpoint string
    The endpoint that you can use to connect to the 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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) for the proxy.
    endpoint String
    The endpoint that you can use to connect to the 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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) for the proxy.
    endpoint string
    The endpoint that you can use to connect to the 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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) for the proxy.
    endpoint str
    The endpoint that you can use to connect to the 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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) for the proxy.
    endpoint String
    The endpoint that you can use to connect to the 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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Proxy Resource

    Get an existing Proxy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProxyState, opts?: CustomResourceOptions): Proxy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        auths: Optional[Sequence[ProxyAuthArgs]] = None,
        debug_logging: Optional[bool] = None,
        endpoint: Optional[str] = None,
        engine_family: Optional[str] = None,
        idle_client_timeout: Optional[int] = None,
        name: Optional[str] = None,
        require_tls: Optional[bool] = None,
        role_arn: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None,
        vpc_subnet_ids: Optional[Sequence[str]] = None) -> Proxy
    func GetProxy(ctx *Context, name string, id IDInput, state *ProxyState, opts ...ResourceOption) (*Proxy, error)
    public static Proxy Get(string name, Input<string> id, ProxyState? state, CustomResourceOptions? opts = null)
    public static Proxy get(String name, Output<String> id, ProxyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) for the proxy.
    Auths List<ProxyAuth>
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    DebugLogging bool
    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.
    Endpoint string
    The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
    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. 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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    IdleClientTimeout int
    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.
    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. 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.
    RequireTls bool
    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.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcSecurityGroupIds List<string>
    One or more VPC security group IDs to associate with the new proxy.
    VpcSubnetIds List<string>
    One or more VPC subnet IDs to associate with the new proxy.
    Arn string
    The Amazon Resource Name (ARN) for the proxy.
    Auths []ProxyAuthArgs
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    DebugLogging bool
    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.
    Endpoint string
    The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
    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. 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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    IdleClientTimeout int
    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.
    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. 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.
    RequireTls bool
    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.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    Tags map[string]string
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcSecurityGroupIds []string
    One or more VPC security group IDs to associate with the new proxy.
    VpcSubnetIds []string
    One or more VPC subnet IDs to associate with the new proxy.
    arn String
    The Amazon Resource Name (ARN) for the proxy.
    auths List<ProxyAuth>
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    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.
    endpoint String
    The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
    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. 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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    idleClientTimeout 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.
    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. 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.
    requireTls 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.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    tags Map<String,String>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcSecurityGroupIds List<String>
    One or more VPC security group IDs to associate with the new proxy.
    vpcSubnetIds List<String>
    One or more VPC subnet IDs to associate with the new proxy.
    arn string
    The Amazon Resource Name (ARN) for the proxy.
    auths ProxyAuth[]
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    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.
    endpoint string
    The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
    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. 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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    idleClientTimeout number
    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.
    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. 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.
    requireTls 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.
    roleArn string
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcSecurityGroupIds string[]
    One or more VPC security group IDs to associate with the new proxy.
    vpcSubnetIds string[]
    One or more VPC subnet IDs to associate with the new proxy.
    arn str
    The Amazon Resource Name (ARN) for the proxy.
    auths Sequence[ProxyAuthArgs]
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    debug_logging bool
    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.
    endpoint str
    The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
    engine_family str
    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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    idle_client_timeout int
    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.
    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. 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.
    require_tls bool
    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.
    role_arn str
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpc_security_group_ids Sequence[str]
    One or more VPC security group IDs to associate with the new proxy.
    vpc_subnet_ids Sequence[str]
    One or more VPC subnet IDs to associate with the new proxy.
    arn String
    The Amazon Resource Name (ARN) for the proxy.
    auths List<Property Map>
    Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
    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.
    endpoint String
    The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
    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. 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. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
    idleClientTimeout Number
    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.
    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. 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.
    requireTls 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.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    tags Map<String>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcSecurityGroupIds List<String>
    One or more VPC security group IDs to associate with the new proxy.
    vpcSubnetIds List<String>
    One or more VPC subnet IDs to associate with the new proxy.

    Supporting Types

    ProxyAuth, ProxyAuthArgs

    AuthScheme string
    The type of authentication that the proxy uses for connections from the proxy to the underlying database. One of SECRETS.
    ClientPasswordAuthType string
    The type of authentication the proxy uses for connections from clients. Valid values are MYSQL_NATIVE_PASSWORD, POSTGRES_SCRAM_SHA_256, POSTGRES_MD5, and SQL_SERVER_AUTHENTICATION.
    Description string
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    IamAuth string
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. One of DISABLED, REQUIRED.
    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.
    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. One of SECRETS.
    ClientPasswordAuthType string
    The type of authentication the proxy uses for connections from clients. Valid values are MYSQL_NATIVE_PASSWORD, POSTGRES_SCRAM_SHA_256, POSTGRES_MD5, and SQL_SERVER_AUTHENTICATION.
    Description string
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    IamAuth string
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. One of DISABLED, REQUIRED.
    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.
    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. One of SECRETS.
    clientPasswordAuthType String
    The type of authentication the proxy uses for connections from clients. Valid values are MYSQL_NATIVE_PASSWORD, POSTGRES_SCRAM_SHA_256, POSTGRES_MD5, and SQL_SERVER_AUTHENTICATION.
    description String
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    iamAuth String
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. One of DISABLED, REQUIRED.
    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.
    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. One of SECRETS.
    clientPasswordAuthType string
    The type of authentication the proxy uses for connections from clients. Valid values are MYSQL_NATIVE_PASSWORD, POSTGRES_SCRAM_SHA_256, POSTGRES_MD5, and SQL_SERVER_AUTHENTICATION.
    description string
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    iamAuth string
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. One of DISABLED, REQUIRED.
    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.
    username string
    The name of the database user to which the proxy connects.
    auth_scheme str
    The type of authentication that the proxy uses for connections from the proxy to the underlying database. One of SECRETS.
    client_password_auth_type str
    The type of authentication the proxy uses for connections from clients. Valid values are MYSQL_NATIVE_PASSWORD, POSTGRES_SCRAM_SHA_256, POSTGRES_MD5, and SQL_SERVER_AUTHENTICATION.
    description str
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    iam_auth str
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. One of DISABLED, REQUIRED.
    secret_arn str
    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.
    username str
    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. One of SECRETS.
    clientPasswordAuthType String
    The type of authentication the proxy uses for connections from clients. Valid values are MYSQL_NATIVE_PASSWORD, POSTGRES_SCRAM_SHA_256, POSTGRES_MD5, and SQL_SERVER_AUTHENTICATION.
    description String
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    iamAuth String
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. One of DISABLED, REQUIRED.
    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.
    username String
    The name of the database user to which the proxy connects.

    Import

    Using pulumi import, import DB proxies using the name. For example:

    $ pulumi import aws:rds/proxy:Proxy example example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws