@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
180 lines (179 loc) • 6.93 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a Redshift Cluster parameter group resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const bar = new aws.redshift.ParameterGroup("bar", {
* name: "parameter-group-test",
* family: "redshift-1.0",
* parameters: [
* {
* name: "require_ssl",
* value: "true",
* },
* {
* name: "query_group",
* value: "example",
* },
* {
* name: "enable_user_activity_logging",
* value: "true",
* },
* ],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Redshift Parameter Groups using the `name`. For example:
*
* ```sh
* $ pulumi import aws:redshift/parameterGroup:ParameterGroup paramgroup1 parameter-group-test-pulumi
* ```
*/
export declare class ParameterGroup extends pulumi.CustomResource {
/**
* Get an existing ParameterGroup 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: string, id: pulumi.Input<pulumi.ID>, state?: ParameterGroupState, opts?: pulumi.CustomResourceOptions): ParameterGroup;
/**
* Returns true if the given object is an instance of ParameterGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ParameterGroup;
/**
* Amazon Resource Name (ARN) of parameter group
*/
readonly arn: pulumi.Output<string>;
/**
* The description of the Redshift parameter group. Defaults to "Managed by Pulumi".
*/
readonly description: pulumi.Output<string>;
/**
* The family of the Redshift parameter group.
*/
readonly family: pulumi.Output<string>;
/**
* The name of the Redshift parameter.
*/
readonly name: pulumi.Output<string>;
/**
* A list of Redshift parameters to apply.
*/
readonly parameters: pulumi.Output<outputs.redshift.ParameterGroupParameter[] | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* You can read more about the parameters that Redshift supports in the [documentation](http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a ParameterGroup resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ParameterGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ParameterGroup resources.
*/
export interface ParameterGroupState {
/**
* Amazon Resource Name (ARN) of parameter group
*/
arn?: pulumi.Input<string>;
/**
* The description of the Redshift parameter group. Defaults to "Managed by Pulumi".
*/
description?: pulumi.Input<string>;
/**
* The family of the Redshift parameter group.
*/
family?: pulumi.Input<string>;
/**
* The name of the Redshift parameter.
*/
name?: pulumi.Input<string>;
/**
* A list of Redshift parameters to apply.
*/
parameters?: pulumi.Input<pulumi.Input<inputs.redshift.ParameterGroupParameter>[]>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* You can read more about the parameters that Redshift supports in the [documentation](http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a ParameterGroup resource.
*/
export interface ParameterGroupArgs {
/**
* The description of the Redshift parameter group. Defaults to "Managed by Pulumi".
*/
description?: pulumi.Input<string>;
/**
* The family of the Redshift parameter group.
*/
family: pulumi.Input<string>;
/**
* The name of the Redshift parameter.
*/
name?: pulumi.Input<string>;
/**
* A list of Redshift parameters to apply.
*/
parameters?: pulumi.Input<pulumi.Input<inputs.redshift.ParameterGroupParameter>[]>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* You can read more about the parameters that Redshift supports in the [documentation](http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}