@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
111 lines • 4.6 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.ProxyDefaultTargetGroup = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides a resource to manage an RDS DB proxy default target group resource.
*
* The `aws.rds.ProxyDefaultTargetGroup` behaves differently from normal resources, in that the provider does not _create_ or _destroy_ this resource, since it implicitly exists as part of an RDS DB Proxy. On the provider resource creation it is automatically imported and on resource destruction, the provider performs no actions in RDS.
*
* ## Example Usage
*
* ```typescript
* 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",
* },
* });
* const exampleProxyDefaultTargetGroup = new aws.rds.ProxyDefaultTargetGroup("example", {
* dbProxyName: example.name,
* connectionPoolConfig: {
* connectionBorrowTimeout: 120,
* initQuery: "SET x=1, y=2",
* maxConnectionsPercent: 100,
* maxIdleConnectionsPercent: 50,
* sessionPinningFilters: ["EXCLUDE_VARIABLE_SETS"],
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import DB proxy default target groups using the `db_proxy_name`. For example:
*
* ```sh
* $ pulumi import aws:rds/proxyDefaultTargetGroup:ProxyDefaultTargetGroup example example
* ```
*/
class ProxyDefaultTargetGroup extends pulumi.CustomResource {
/**
* Get an existing ProxyDefaultTargetGroup resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new ProxyDefaultTargetGroup(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of ProxyDefaultTargetGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === ProxyDefaultTargetGroup.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["arn"] = state?.arn;
resourceInputs["connectionPoolConfig"] = state?.connectionPoolConfig;
resourceInputs["dbProxyName"] = state?.dbProxyName;
resourceInputs["name"] = state?.name;
resourceInputs["region"] = state?.region;
}
else {
const args = argsOrState;
if (args?.dbProxyName === undefined && !opts.urn) {
throw new Error("Missing required property 'dbProxyName'");
}
resourceInputs["connectionPoolConfig"] = args?.connectionPoolConfig;
resourceInputs["dbProxyName"] = args?.dbProxyName;
resourceInputs["region"] = args?.region;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(ProxyDefaultTargetGroup.__pulumiType, name, resourceInputs, opts);
}
}
exports.ProxyDefaultTargetGroup = ProxyDefaultTargetGroup;
/** @internal */
ProxyDefaultTargetGroup.__pulumiType = 'aws:rds/proxyDefaultTargetGroup:ProxyDefaultTargetGroup';
//# sourceMappingURL=proxyDefaultTargetGroup.js.map