Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

Latest commit

 

History

History
1090 lines (688 loc) · 55.5 KB

File metadata and controls

1090 lines (688 loc) · 55.5 KB

dataAwsSecretsmanagerRandomPassword Submodule

Constructs

DataAwsSecretsmanagerRandomPassword

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password aws_secretsmanager_random_password}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsSecretsmanagerRandomPassword(Construct Scope, string Id, DataAwsSecretsmanagerRandomPasswordConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DataAwsSecretsmanagerRandomPasswordConfig 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


ConfigOptional

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 Adds this resource to the terraform JSON output.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
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.
ResetExcludeCharacters No description.
ResetExcludeLowercase No description.
ResetExcludeNumbers No description.
ResetExcludePunctuation No description.
ResetExcludeUppercase No description.
ResetId No description.
ResetIncludeSpace No description.
ResetPasswordLength No description.
ResetRegion No description.
ResetRequireEachIncludedType 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()

Adds this resource to the terraform JSON output.

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

Adds this resource to the terraform JSON output.

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 TerraformAttribute)
TerraformAttributeRequired
  • Type: string

ResetExcludeCharacters
private void ResetExcludeCharacters()
ResetExcludeLowercase
private void ResetExcludeLowercase()
ResetExcludeNumbers
private void ResetExcludeNumbers()
ResetExcludePunctuation
private void ResetExcludePunctuation()
ResetExcludeUppercase
private void ResetExcludeUppercase()
ResetId
private void ResetId()
ResetIncludeSpace
private void ResetIncludeSpace()
ResetPasswordLength
private void ResetPasswordLength()
ResetRegion
private void ResetRegion()
ResetRequireEachIncludedType
private void ResetRequireEachIncludedType()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

DataAwsSecretsmanagerRandomPassword.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;

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

IsTerraformDataSource
using HashiCorp.Cdktf.Providers.Aws;

DataAwsSecretsmanagerRandomPassword.IsTerraformDataSource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

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

Generates CDKTF code for importing a DataAwsSecretsmanagerRandomPassword 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 DataAwsSecretsmanagerRandomPassword to import.


ImportFromIdRequired
  • Type: string

The id of the existing DataAwsSecretsmanagerRandomPassword that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#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 DataAwsSecretsmanagerRandomPassword 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.
Count double|HashiCorp.Cdktf.TerraformCount No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
RandomPassword string No description.
ExcludeCharactersInput string No description.
ExcludeLowercaseInput bool|HashiCorp.Cdktf.IResolvable No description.
ExcludeNumbersInput bool|HashiCorp.Cdktf.IResolvable No description.
ExcludePunctuationInput bool|HashiCorp.Cdktf.IResolvable No description.
ExcludeUppercaseInput bool|HashiCorp.Cdktf.IResolvable No description.
IdInput string No description.
IncludeSpaceInput bool|HashiCorp.Cdktf.IResolvable No description.
PasswordLengthInput double No description.
RegionInput string No description.
RequireEachIncludedTypeInput bool|HashiCorp.Cdktf.IResolvable No description.
ExcludeCharacters string No description.
ExcludeLowercase bool|HashiCorp.Cdktf.IResolvable No description.
ExcludeNumbers bool|HashiCorp.Cdktf.IResolvable No description.
ExcludePunctuation bool|HashiCorp.Cdktf.IResolvable No description.
ExcludeUppercase bool|HashiCorp.Cdktf.IResolvable No description.
Id string No description.
IncludeSpace bool|HashiCorp.Cdktf.IResolvable No description.
PasswordLength double No description.
Region string No description.
RequireEachIncludedType bool|HashiCorp.Cdktf.IResolvable 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

CountOptional
public double|TerraformCount Count { get; }
  • Type: double|HashiCorp.Cdktf.TerraformCount

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

RandomPasswordRequired
public string RandomPassword { get; }
  • Type: string

ExcludeCharactersInputOptional
public string ExcludeCharactersInput { get; }
  • Type: string

ExcludeLowercaseInputOptional
public bool|IResolvable ExcludeLowercaseInput { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

ExcludeNumbersInputOptional
public bool|IResolvable ExcludeNumbersInput { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

ExcludePunctuationInputOptional
public bool|IResolvable ExcludePunctuationInput { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

ExcludeUppercaseInputOptional
public bool|IResolvable ExcludeUppercaseInput { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

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

IncludeSpaceInputOptional
public bool|IResolvable IncludeSpaceInput { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

PasswordLengthInputOptional
public double PasswordLengthInput { get; }
  • Type: double

RegionInputOptional
public string RegionInput { get; }
  • Type: string

RequireEachIncludedTypeInputOptional
public bool|IResolvable RequireEachIncludedTypeInput { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

ExcludeCharactersRequired
public string ExcludeCharacters { get; }
  • Type: string

ExcludeLowercaseRequired
public bool|IResolvable ExcludeLowercase { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

ExcludeNumbersRequired
public bool|IResolvable ExcludeNumbers { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

ExcludePunctuationRequired
public bool|IResolvable ExcludePunctuation { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

ExcludeUppercaseRequired
public bool|IResolvable ExcludeUppercase { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

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

IncludeSpaceRequired
public bool|IResolvable IncludeSpace { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

PasswordLengthRequired
public double PasswordLength { get; }
  • Type: double

RegionRequired
public string Region { get; }
  • Type: string

RequireEachIncludedTypeRequired
public bool|IResolvable RequireEachIncludedType { get; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

Constants

Name Type Description
TfResourceType string No description.

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

Structs

DataAwsSecretsmanagerRandomPasswordConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsSecretsmanagerRandomPasswordConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string ExcludeCharacters = null,
    bool|IResolvable ExcludeLowercase = null,
    bool|IResolvable ExcludeNumbers = null,
    bool|IResolvable ExcludePunctuation = null,
    bool|IResolvable ExcludeUppercase = null,
    string Id = null,
    bool|IResolvable IncludeSpace = null,
    double PasswordLength = null,
    string Region = null,
    bool|IResolvable RequireEachIncludedType = null
};

Properties

Name Type Description
Connection HashiCorp.Cdktf.SSHProvisionerConnection|HashiCorp.Cdktf.WinrmProvisionerConnection No description.
Count double|HashiCorp.Cdktf.TerraformCount 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 HashiCorp.Cdktf.FileProvisioner|HashiCorp.Cdktf.LocalExecProvisioner|HashiCorp.Cdktf.RemoteExecProvisioner[] No description.
ExcludeCharacters string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#exclude_characters DataAwsSecretsmanagerRandomPassword#exclude_characters}.
ExcludeLowercase bool|HashiCorp.Cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#exclude_lowercase DataAwsSecretsmanagerRandomPassword#exclude_lowercase}.
ExcludeNumbers bool|HashiCorp.Cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#exclude_numbers DataAwsSecretsmanagerRandomPassword#exclude_numbers}.
ExcludePunctuation bool|HashiCorp.Cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#exclude_punctuation DataAwsSecretsmanagerRandomPassword#exclude_punctuation}.
ExcludeUppercase bool|HashiCorp.Cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#exclude_uppercase DataAwsSecretsmanagerRandomPassword#exclude_uppercase}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#id DataAwsSecretsmanagerRandomPassword#id}.
IncludeSpace bool|HashiCorp.Cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#include_space DataAwsSecretsmanagerRandomPassword#include_space}.
PasswordLength double Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#password_length DataAwsSecretsmanagerRandomPassword#password_length}.
Region string Region where this resource will be managed. Defaults to the Region set in the provider configuration.
RequireEachIncludedType bool|HashiCorp.Cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#require_each_included_type DataAwsSecretsmanagerRandomPassword#require_each_included_type}.

ConnectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }
  • Type: HashiCorp.Cdktf.SSHProvisionerConnection|HashiCorp.Cdktf.WinrmProvisionerConnection

CountOptional
public double|TerraformCount Count { get; set; }
  • Type: double|HashiCorp.Cdktf.TerraformCount

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 (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }
  • Type: HashiCorp.Cdktf.FileProvisioner|HashiCorp.Cdktf.LocalExecProvisioner|HashiCorp.Cdktf.RemoteExecProvisioner[]

ExcludeCharactersOptional
public string ExcludeCharacters { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#exclude_characters DataAwsSecretsmanagerRandomPassword#exclude_characters}.


ExcludeLowercaseOptional
public bool|IResolvable ExcludeLowercase { get; set; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#exclude_lowercase DataAwsSecretsmanagerRandomPassword#exclude_lowercase}.


ExcludeNumbersOptional
public bool|IResolvable ExcludeNumbers { get; set; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#exclude_numbers DataAwsSecretsmanagerRandomPassword#exclude_numbers}.


ExcludePunctuationOptional
public bool|IResolvable ExcludePunctuation { get; set; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#exclude_punctuation DataAwsSecretsmanagerRandomPassword#exclude_punctuation}.


ExcludeUppercaseOptional
public bool|IResolvable ExcludeUppercase { get; set; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#exclude_uppercase DataAwsSecretsmanagerRandomPassword#exclude_uppercase}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#id DataAwsSecretsmanagerRandomPassword#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.


IncludeSpaceOptional
public bool|IResolvable IncludeSpace { get; set; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#include_space DataAwsSecretsmanagerRandomPassword#include_space}.


PasswordLengthOptional
public double PasswordLength { get; set; }
  • Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#password_length DataAwsSecretsmanagerRandomPassword#password_length}.


RegionOptional
public string Region { get; set; }
  • Type: string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#region DataAwsSecretsmanagerRandomPassword#region}


RequireEachIncludedTypeOptional
public bool|IResolvable RequireEachIncludedType { get; set; }
  • Type: bool|HashiCorp.Cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/secretsmanager_random_password#require_each_included_type DataAwsSecretsmanagerRandomPassword#require_each_included_type}.