Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group aws_db_parameter_group}.
import { dbParameterGroup } from '@cdktf/aws-cdk'
new dbParameterGroup.DbParameterGroup(scope: Construct, id: string, config: DbParameterGroupConfig)| Name | Type | Description |
|---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
DbParameterGroupConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: DbParameterGroupConfig
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
addOverride |
No description. |
overrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
resetOverrideLogicalId |
Resets a previously passed logical Id to use the auto-generated logical id again. |
toHclTerraform |
No description. |
toMetadata |
No description. |
toTerraform |
Adds this resource to the terraform JSON output. |
addMoveTarget |
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
hasResourceMove |
No description. |
importFrom |
No description. |
interpolationForAttribute |
No description. |
moveFromId |
Move the resource corresponding to "id" to this resource. |
moveTo |
Moves this resource to the target resource given by moveTarget. |
moveToId |
Moves this resource to the resource corresponding to "id". |
putParameter |
No description. |
resetDescription |
No description. |
resetId |
No description. |
resetName |
No description. |
resetNamePrefix |
No description. |
resetParameter |
No description. |
resetTags |
No description. |
resetTagsAll |
No description. |
public toString(): stringReturns a string representation of this construct.
public addOverride(path: string, value: any): void- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): voidOverrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): voidResets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): anypublic toMetadata(): anypublic toTerraform(): anyAdds this resource to the terraform JSON output.
public addMoveTarget(moveTarget: string): voidAdds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}- Type: string
public getListAttribute(terraformAttribute: string): string[]- Type: string
public getNumberAttribute(terraformAttribute: string): number- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}- Type: string
public getStringAttribute(terraformAttribute: string): string- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveByIdpublic importFrom(id: string, provider?: TerraformProvider): void- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable- Type: string
public moveFromId(id: string): voidMove the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): voidMoves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): voidMoves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public putParameter(value: IResolvable | DbParameterGroupParameter[]): void- Type: cdktf.IResolvable | DbParameterGroupParameter[]
public resetDescription(): voidpublic resetId(): voidpublic resetName(): voidpublic resetNamePrefix(): voidpublic resetParameter(): voidpublic resetTags(): voidpublic resetTagsAll(): void| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a DbParameterGroup resource upon running "cdktf plan ". |
import { dbParameterGroup } from '@cdktf/aws-cdk'
dbParameterGroup.DbParameterGroup.isConstruct(x: any)Checks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
- Type: any
Any object.
import { dbParameterGroup } from '@cdktf/aws-cdk'
dbParameterGroup.DbParameterGroup.isTerraformElement(x: any)- Type: any
import { dbParameterGroup } from '@cdktf/aws-cdk'
dbParameterGroup.DbParameterGroup.isTerraformResource(x: any)- Type: any
import { dbParameterGroup } from '@cdktf/aws-cdk'
dbParameterGroup.DbParameterGroup.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)Generates CDKTF code for importing a DbParameterGroup resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the DbParameterGroup to import.
- Type: string
The id of the existing DbParameterGroup that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the DbParameterGroup to import is found.
| Name | Type | Description |
|---|---|---|
node |
constructs.Node |
The tree node. |
cdktfStack |
cdktf.TerraformStack |
No description. |
fqn |
string |
No description. |
friendlyUniqueId |
string |
No description. |
terraformMetaArguments |
{[ key: string ]: any} |
No description. |
terraformResourceType |
string |
No description. |
terraformGeneratorMetadata |
cdktf.TerraformProviderGeneratorMetadata |
No description. |
connection |
cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection |
No description. |
count |
number | cdktf.TerraformCount |
No description. |
dependsOn |
string[] |
No description. |
forEach |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] |
No description. |
arn |
string |
No description. |
parameter |
DbParameterGroupParameterList |
No description. |
descriptionInput |
string |
No description. |
familyInput |
string |
No description. |
idInput |
string |
No description. |
nameInput |
string |
No description. |
namePrefixInput |
string |
No description. |
parameterInput |
cdktf.IResolvable | DbParameterGroupParameter[] |
No description. |
tagsAllInput |
{[ key: string ]: string} |
No description. |
tagsInput |
{[ key: string ]: string} |
No description. |
description |
string |
No description. |
family |
string |
No description. |
id |
string |
No description. |
name |
string |
No description. |
namePrefix |
string |
No description. |
tags |
{[ key: string ]: string} |
No description. |
tagsAll |
{[ key: string ]: string} |
No description. |
public readonly node: Node;- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;- Type: cdktf.TerraformStack
public readonly fqn: string;- Type: string
public readonly friendlyUniqueId: string;- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];- Type: string[]
public readonly forEach: ITerraformIterator;- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly arn: string;- Type: string
public readonly parameter: DbParameterGroupParameterList;public readonly descriptionInput: string;- Type: string
public readonly familyInput: string;- Type: string
public readonly idInput: string;- Type: string
public readonly nameInput: string;- Type: string
public readonly namePrefixInput: string;- Type: string
public readonly parameterInput: IResolvable | DbParameterGroupParameter[];- Type: cdktf.IResolvable | DbParameterGroupParameter[]
public readonly tagsAllInput: {[ key: string ]: string};- Type: {[ key: string ]: string}
public readonly tagsInput: {[ key: string ]: string};- Type: {[ key: string ]: string}
public readonly description: string;- Type: string
public readonly family: string;- Type: string
public readonly id: string;- Type: string
public readonly name: string;- Type: string
public readonly namePrefix: string;- Type: string
public readonly tags: {[ key: string ]: string};- Type: {[ key: string ]: string}
public readonly tagsAll: {[ key: string ]: string};- Type: {[ key: string ]: string}
| Name | Type | Description |
|---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;- Type: string
import { dbParameterGroup } from '@cdktf/aws-cdk'
const dbParameterGroupConfig: dbParameterGroup.DbParameterGroupConfig = { ... }| Name | Type | Description |
|---|---|---|
connection |
cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection |
No description. |
count |
number | cdktf.TerraformCount |
No description. |
dependsOn |
cdktf.ITerraformDependable[] |
No description. |
forEach |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] |
No description. |
family |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#family DbParameterGroup#family}. |
description |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#description DbParameterGroup#description}. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#id DbParameterGroup#id}. |
name |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#name DbParameterGroup#name}. |
namePrefix |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#name_prefix DbParameterGroup#name_prefix}. |
parameter |
cdktf.IResolvable | DbParameterGroupParameter[] |
parameter block. |
tags |
{[ key: string ]: string} |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#tags DbParameterGroup#tags}. |
tagsAll |
{[ key: string ]: string} |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#tags_all DbParameterGroup#tags_all}. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly family: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#family DbParameterGroup#family}.
public readonly description: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#description DbParameterGroup#description}.
public readonly id: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#id DbParameterGroup#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
public readonly name: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#name DbParameterGroup#name}.
public readonly namePrefix: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#name_prefix DbParameterGroup#name_prefix}.
public readonly parameter: IResolvable | DbParameterGroupParameter[];- Type: cdktf.IResolvable | DbParameterGroupParameter[]
parameter block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#parameter DbParameterGroup#parameter}
public readonly tags: {[ key: string ]: string};- Type: {[ key: string ]: string}
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#tags DbParameterGroup#tags}.
public readonly tagsAll: {[ key: string ]: string};- Type: {[ key: string ]: string}
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#tags_all DbParameterGroup#tags_all}.
import { dbParameterGroup } from '@cdktf/aws-cdk'
const dbParameterGroupParameter: dbParameterGroup.DbParameterGroupParameter = { ... }| Name | Type | Description |
|---|---|---|
name |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#name DbParameterGroup#name}. |
value |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#value DbParameterGroup#value}. |
applyMethod |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#apply_method DbParameterGroup#apply_method}. |
public readonly name: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#name DbParameterGroup#name}.
public readonly value: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#value DbParameterGroup#value}.
public readonly applyMethod: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/db_parameter_group#apply_method DbParameterGroup#apply_method}.
import { dbParameterGroup } from '@cdktf/aws-cdk'
new dbParameterGroup.DbParameterGroupParameterList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)| Name | Type | Description |
|---|---|---|
terraformResource |
cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
wrapsSet |
boolean |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
| Name | Description |
|---|---|
allWithMapKey |
Creating an iterator for this complex list. |
computeFqn |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
get |
No description. |
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIteratorCreating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: string
public computeFqn(): stringpublic resolve(_context: IResolveContext): anyProduce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): stringReturn a string representation of this resolvable object.
Returns a reversible string representation.
public get(index: number): DbParameterGroupParameterOutputReference- Type: number
the index of the item to return.
| Name | Type | Description |
|---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
internalValue |
cdktf.IResolvable | DbParameterGroupParameter[] |
No description. |
public readonly creationStack: string[];- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
public readonly fqn: string;- Type: string
public readonly internalValue: IResolvable | DbParameterGroupParameter[];- Type: cdktf.IResolvable | DbParameterGroupParameter[]
import { dbParameterGroup } from '@cdktf/aws-cdk'
new dbParameterGroup.DbParameterGroupParameterOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)| Name | Type | Description |
|---|---|---|
terraformResource |
cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
complexObjectIndex |
number |
the index of this item in the list. |
complexObjectIsFromSet |
boolean |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: number
the index of this item in the list.
- Type: boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
| Name | Description |
|---|---|
computeFqn |
No description. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
interpolationForAttribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
resetApplyMethod |
No description. |
public computeFqn(): stringpublic getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}- Type: string
public getListAttribute(terraformAttribute: string): string[]- Type: string
public getNumberAttribute(terraformAttribute: string): number- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}- Type: string
public getStringAttribute(terraformAttribute: string): string- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}- Type: string
public interpolationForAttribute(property: string): IResolvable- Type: string
public resolve(_context: IResolveContext): anyProduce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): stringReturn a string representation of this resolvable object.
Returns a reversible string representation.
public resetApplyMethod(): void| Name | Type | Description |
|---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
applyMethodInput |
string |
No description. |
nameInput |
string |
No description. |
valueInput |
string |
No description. |
applyMethod |
string |
No description. |
name |
string |
No description. |
value |
string |
No description. |
internalValue |
cdktf.IResolvable | DbParameterGroupParameter |
No description. |
public readonly creationStack: string[];- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
public readonly fqn: string;- Type: string
public readonly applyMethodInput: string;- Type: string
public readonly nameInput: string;- Type: string
public readonly valueInput: string;- Type: string
public readonly applyMethod: string;- Type: string
public readonly name: string;- Type: string
public readonly value: string;- Type: string
public readonly internalValue: IResolvable | DbParameterGroupParameter;- Type: cdktf.IResolvable | DbParameterGroupParameter