@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
59 lines (58 loc) • 4.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* The ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.
* This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.
* For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
* For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
* Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
*/
export declare function getDbParameterGroup(args: GetDbParameterGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetDbParameterGroupResult>;
export interface GetDbParameterGroupArgs {
/**
* The name of the DB parameter group.
* Constraints:
* + Must be 1 to 255 letters, numbers, or hyphens.
* + First character must be a letter
* + Can't end with a hyphen or contain two consecutive hyphens
*
* If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.
* This value is stored as a lowercase string.
*/
dbParameterGroupName: string;
}
export interface GetDbParameterGroupResult {
/**
* A mapping of parameter names and values for the parameter update. You must specify at least one parameter name and value.
* For more information about parameter groups, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*, or [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
* AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::RDS::DBParameterGroup` for more information about the expected schema for this property.
*/
readonly parameters?: any;
/**
* Tags to assign to the DB parameter group.
*/
readonly tags?: outputs.Tag[];
}
/**
* The ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.
* This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.
* For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
* For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
* Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
*/
export declare function getDbParameterGroupOutput(args: GetDbParameterGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDbParameterGroupResult>;
export interface GetDbParameterGroupOutputArgs {
/**
* The name of the DB parameter group.
* Constraints:
* + Must be 1 to 255 letters, numbers, or hyphens.
* + First character must be a letter
* + Can't end with a hyphen or contain two consecutive hyphens
*
* If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.
* This value is stored as a lowercase string.
*/
dbParameterGroupName: pulumi.Input<string>;
}