Skip to content

Latest commit

 

History

History
2767 lines (1712 loc) · 115 KB

dbOptionGroup.csharp.md

File metadata and controls

2767 lines (1712 loc) · 115 KB

dbOptionGroup Submodule

Constructs

DbOptionGroup

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group aws_db_option_group}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DbOptionGroup(Construct Scope, string Id, DbOptionGroupConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DbOptionGroupConfig No description.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigRequired

Methods

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".
PutOption No description.
PutTimeouts No description.
ResetId No description.
ResetName No description.
ResetNamePrefix No description.
ResetOption No description.
ResetOptionGroupDescription No description.
ResetTags No description.
ResetTagsAll No description.
ResetTimeouts No description.

ToString
private string ToString()

Returns a string representation of this construct.

AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

MoveFromId
private void MoveFromId(string Id)

Move 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.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


MoveTo
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


IndexOptional
  • Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


MoveToId
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


PutOption
private void PutOption(object Value)
ValueRequired
  • Type: object

PutTimeouts
private void PutTimeouts(DbOptionGroupTimeouts Value)
ValueRequired

ResetId
private void ResetId()
ResetName
private void ResetName()
ResetNamePrefix
private void ResetNamePrefix()
ResetOption
private void ResetOption()
ResetOptionGroupDescription
private void ResetOptionGroupDescription()
ResetTags
private void ResetTags()
ResetTagsAll
private void ResetTagsAll()
ResetTimeouts
private void ResetTimeouts()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a DbOptionGroup resource upon running "cdktf plan ".

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

DbOptionGroup.IsConstruct(object X);

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.

XRequired
  • Type: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Aws;

DbOptionGroup.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using HashiCorp.Cdktf.Providers.Aws;

DbOptionGroup.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

DbOptionGroup.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a DbOptionGroup resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


ImportToIdRequired
  • Type: string

The construct id used in the generated config for the DbOptionGroup to import.


ImportFromIdRequired
  • Type: string

The id of the existing DbOptionGroup that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#import import section} in the documentation of this resource for the id to use


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the DbOptionGroup to import is found.


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Arn string No description.
Option DbOptionGroupOptionList No description.
Timeouts DbOptionGroupTimeoutsOutputReference No description.
EngineNameInput string No description.
IdInput string No description.
MajorEngineVersionInput string No description.
NameInput string No description.
NamePrefixInput string No description.
OptionGroupDescriptionInput string No description.
OptionInput object No description.
TagsAllInput System.Collections.Generic.IDictionary<string, string> No description.
TagsInput System.Collections.Generic.IDictionary<string, string> No description.
TimeoutsInput object No description.
EngineName string No description.
Id string No description.
MajorEngineVersion string No description.
Name string No description.
NamePrefix string No description.
OptionGroupDescription string No description.
Tags System.Collections.Generic.IDictionary<string, string> No description.
TagsAll System.Collections.Generic.IDictionary<string, string> No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

TerraformMetaArgumentsRequired
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
public object Connection { get; }
  • Type: object

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; }
  • Type: object[]

ArnRequired
public string Arn { get; }
  • Type: string

OptionRequired
public DbOptionGroupOptionList Option { get; }

TimeoutsRequired
public DbOptionGroupTimeoutsOutputReference Timeouts { get; }

EngineNameInputOptional
public string EngineNameInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

MajorEngineVersionInputOptional
public string MajorEngineVersionInput { get; }
  • Type: string

NameInputOptional
public string NameInput { get; }
  • Type: string

NamePrefixInputOptional
public string NamePrefixInput { get; }
  • Type: string

OptionGroupDescriptionInputOptional
public string OptionGroupDescriptionInput { get; }
  • Type: string

OptionInputOptional
public object OptionInput { get; }
  • Type: object

TagsAllInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TagsInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TimeoutsInputOptional
public object TimeoutsInput { get; }
  • Type: object

EngineNameRequired
public string EngineName { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

MajorEngineVersionRequired
public string MajorEngineVersion { get; }
  • Type: string

NameRequired
public string Name { get; }
  • Type: string

NamePrefixRequired
public string NamePrefix { get; }
  • Type: string

OptionGroupDescriptionRequired
public string OptionGroupDescription { get; }
  • Type: string

TagsRequired
public System.Collections.Generic.IDictionary<string, string> Tags { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TagsAllRequired
public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

DbOptionGroupConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DbOptionGroupConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string EngineName,
    string MajorEngineVersion,
    string Id = null,
    string Name = null,
    string NamePrefix = null,
    object Option = null,
    string OptionGroupDescription = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = null,
    DbOptionGroupTimeouts Timeouts = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
EngineName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#engine_name DbOptionGroup#engine_name}.
MajorEngineVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#major_engine_version DbOptionGroup#major_engine_version}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#id DbOptionGroup#id}.
Name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#name DbOptionGroup#name}.
NamePrefix string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#name_prefix DbOptionGroup#name_prefix}.
Option object option block.
OptionGroupDescription string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#option_group_description DbOptionGroup#option_group_description}.
Tags System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#tags DbOptionGroup#tags}.
TagsAll System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#tags_all DbOptionGroup#tags_all}.
Timeouts DbOptionGroupTimeouts timeouts block.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

EngineNameRequired
public string EngineName { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#engine_name DbOptionGroup#engine_name}.


MajorEngineVersionRequired
public string MajorEngineVersion { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#major_engine_version DbOptionGroup#major_engine_version}.


IdOptional
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#id DbOptionGroup#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.


NameOptional
public string Name { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#name DbOptionGroup#name}.


NamePrefixOptional
public string NamePrefix { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#name_prefix DbOptionGroup#name_prefix}.


OptionOptional
public object Option { get; set; }
  • Type: object

option block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#option DbOptionGroup#option}


OptionGroupDescriptionOptional
public string OptionGroupDescription { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#option_group_description DbOptionGroup#option_group_description}.


TagsOptional
public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#tags DbOptionGroup#tags}.


TagsAllOptional
public System.Collections.Generic.IDictionary<string, string> TagsAll { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#tags_all DbOptionGroup#tags_all}.


TimeoutsOptional
public DbOptionGroupTimeouts Timeouts { get; set; }

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#timeouts DbOptionGroup#timeouts}


DbOptionGroupOption

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DbOptionGroupOption {
    string OptionName,
    string[] DbSecurityGroupMemberships = null,
    object OptionSettings = null,
    double Port = null,
    string Version = null,
    string[] VpcSecurityGroupMemberships = null
};

Properties

Name Type Description
OptionName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#option_name DbOptionGroup#option_name}.
DbSecurityGroupMemberships string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#db_security_group_memberships DbOptionGroup#db_security_group_memberships}.
OptionSettings object option_settings block.
Port double Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#port DbOptionGroup#port}.
Version string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#version DbOptionGroup#version}.
VpcSecurityGroupMemberships string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#vpc_security_group_memberships DbOptionGroup#vpc_security_group_memberships}.

OptionNameRequired
public string OptionName { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#option_name DbOptionGroup#option_name}.


DbSecurityGroupMembershipsOptional
public string[] DbSecurityGroupMemberships { get; set; }
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#db_security_group_memberships DbOptionGroup#db_security_group_memberships}.


OptionSettingsOptional
public object OptionSettings { get; set; }
  • Type: object

option_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#option_settings DbOptionGroup#option_settings}


PortOptional
public double Port { get; set; }
  • Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#port DbOptionGroup#port}.


VersionOptional
public string Version { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#version DbOptionGroup#version}.


VpcSecurityGroupMembershipsOptional
public string[] VpcSecurityGroupMemberships { get; set; }
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#vpc_security_group_memberships DbOptionGroup#vpc_security_group_memberships}.


DbOptionGroupOptionOptionSettings

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DbOptionGroupOptionOptionSettings {
    string Name,
    string Value
};

Properties

Name Type Description
Name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#name DbOptionGroup#name}.
Value string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#value DbOptionGroup#value}.

NameRequired
public string Name { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#name DbOptionGroup#name}.


ValueRequired
public string Value { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#value DbOptionGroup#value}.


DbOptionGroupTimeouts

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DbOptionGroupTimeouts {
    string Delete = null
};

Properties

Name Type Description
Delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#delete DbOptionGroup#delete}.

DeleteOptional
public string Delete { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_option_group#delete DbOptionGroup#delete}.


Classes

DbOptionGroupOptionList

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DbOptionGroupOptionList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


WrapsSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

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.

AllWithMapKey
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

MapKeyAttributeNameRequired
  • Type: string

ComputeFqn
private string ComputeFqn()
Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get
private DbOptionGroupOptionOutputReference Get(double Index)
IndexRequired
  • Type: double

the index of the item to return.


Properties

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 object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • 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.


FqnRequired
public string Fqn { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object

DbOptionGroupOptionOptionSettingsList

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DbOptionGroupOptionOptionSettingsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


WrapsSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

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.

AllWithMapKey
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

MapKeyAttributeNameRequired
  • Type: string

ComputeFqn
private string ComputeFqn()
Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get
private DbOptionGroupOptionOptionSettingsOutputReference Get(double Index)
IndexRequired
  • Type: double

the index of the item to return.


Properties

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 object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • 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.


FqnRequired
public string Fqn { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object

DbOptionGroupOptionOptionSettingsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DbOptionGroupOptionOptionSettingsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.


ComplexObjectIsFromSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

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.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
NameInput string No description.
ValueInput string No description.
Name string No description.
Value string No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • 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.


FqnRequired
public string Fqn { get; }
  • Type: string

NameInputOptional
public string NameInput { get; }
  • Type: string

ValueInputOptional
public string ValueInput { get; }
  • Type: string

NameRequired
public string Name { get; }
  • Type: string

ValueRequired
public string Value { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object

DbOptionGroupOptionOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DbOptionGroupOptionOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.


ComplexObjectIsFromSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

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.
PutOptionSettings No description.
ResetDbSecurityGroupMemberships No description.
ResetOptionSettings No description.
ResetPort No description.
ResetVersion No description.
ResetVpcSecurityGroupMemberships No description.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

PutOptionSettings
private void PutOptionSettings(object Value)
ValueRequired
  • Type: object

ResetDbSecurityGroupMemberships
private void ResetDbSecurityGroupMemberships()
ResetOptionSettings
private void ResetOptionSettings()
ResetPort
private void ResetPort()
ResetVersion
private void ResetVersion()
ResetVpcSecurityGroupMemberships
private void ResetVpcSecurityGroupMemberships()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
OptionSettings DbOptionGroupOptionOptionSettingsList No description.
DbSecurityGroupMembershipsInput string[] No description.
OptionNameInput string No description.
OptionSettingsInput object No description.
PortInput double No description.
VersionInput string No description.
VpcSecurityGroupMembershipsInput string[] No description.
DbSecurityGroupMemberships string[] No description.
OptionName string No description.
Port double No description.
Version string No description.
VpcSecurityGroupMemberships string[] No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • 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.


FqnRequired
public string Fqn { get; }
  • Type: string

OptionSettingsRequired
public DbOptionGroupOptionOptionSettingsList OptionSettings { get; }

DbSecurityGroupMembershipsInputOptional
public string[] DbSecurityGroupMembershipsInput { get; }
  • Type: string[]

OptionNameInputOptional
public string OptionNameInput { get; }
  • Type: string

OptionSettingsInputOptional
public object OptionSettingsInput { get; }
  • Type: object

PortInputOptional
public double PortInput { get; }
  • Type: double

VersionInputOptional
public string VersionInput { get; }
  • Type: string

VpcSecurityGroupMembershipsInputOptional
public string[] VpcSecurityGroupMembershipsInput { get; }
  • Type: string[]

DbSecurityGroupMembershipsRequired
public string[] DbSecurityGroupMemberships { get; }
  • Type: string[]

OptionNameRequired
public string OptionName { get; }
  • Type: string

PortRequired
public double Port { get; }
  • Type: double

VersionRequired
public string Version { get; }
  • Type: string

VpcSecurityGroupMembershipsRequired
public string[] VpcSecurityGroupMemberships { get; }
  • Type: string[]

InternalValueOptional
public object InternalValue { get; }
  • Type: object

DbOptionGroupTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DbOptionGroupTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

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.
ResetDelete No description.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetDelete
private void ResetDelete()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
DeleteInput string No description.
Delete string No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • 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.


FqnRequired
public string Fqn { get; }
  • Type: string

DeleteInputOptional
public string DeleteInput { get; }
  • Type: string

DeleteRequired
public string Delete { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object