Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret aws_secretsmanager_secret}.
using HashiCorp.Cdktf.Providers.Aws;
new SecretsmanagerSecret(Construct Scope, string Id, SecretsmanagerSecretConfig Config = null);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
SecretsmanagerSecretConfig |
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
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". |
PutReplica |
No description. |
ResetDescription |
No description. |
ResetForceOverwriteReplicaSecret |
No description. |
ResetId |
No description. |
ResetKmsKeyId |
No description. |
ResetName |
No description. |
ResetNamePrefix |
No description. |
ResetPolicy |
No description. |
ResetRecoveryWindowInDays |
No description. |
ResetReplica |
No description. |
ResetTags |
No description. |
ResetTagsAll |
No description. |
private string ToString()
Returns a string representation of this construct.
private void AddOverride(string Path, object Value)
- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private object HasResourceMove()
private void ImportFrom(string Id, TerraformProvider Provider = null)
- Type: string
- Type: HashiCorp.Cdktf.TerraformProvider
private IResolvable InterpolationForAttribute(string TerraformAttribute)
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
private void MoveTo(string MoveTarget, object Index = null)
Moves 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: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
private void PutReplica(object Value)
- Type: object
private void ResetDescription()
private void ResetForceOverwriteReplicaSecret()
private void ResetId()
private void ResetKmsKeyId()
private void ResetName()
private void ResetNamePrefix()
private void ResetPolicy()
private void ResetRecoveryWindowInDays()
private void ResetReplica()
private void ResetTags()
private void ResetTagsAll()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a SecretsmanagerSecret resource upon running "cdktf plan ". |
using HashiCorp.Cdktf.Providers.Aws;
SecretsmanagerSecret.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.
- Type: object
Any object.
using HashiCorp.Cdktf.Providers.Aws;
SecretsmanagerSecret.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Aws;
SecretsmanagerSecret.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Aws;
SecretsmanagerSecret.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a SecretsmanagerSecret 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 SecretsmanagerSecret to import.
- Type: string
The id of the existing SecretsmanagerSecret that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#import import section} in the documentation of this resource for the id to use
- Type: HashiCorp.Cdktf.TerraformProvider
? Optional instance of the provider where the SecretsmanagerSecret to import is found.
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. |
Replica |
SecretsmanagerSecretReplicaList |
No description. |
DescriptionInput |
string |
No description. |
ForceOverwriteReplicaSecretInput |
object |
No description. |
IdInput |
string |
No description. |
KmsKeyIdInput |
string |
No description. |
NameInput |
string |
No description. |
NamePrefixInput |
string |
No description. |
PolicyInput |
string |
No description. |
RecoveryWindowInDaysInput |
double |
No description. |
ReplicaInput |
object |
No description. |
TagsAllInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
TagsInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
Description |
string |
No description. |
ForceOverwriteReplicaSecret |
object |
No description. |
Id |
string |
No description. |
KmsKeyId |
string |
No description. |
Name |
string |
No description. |
NamePrefix |
string |
No description. |
Policy |
string |
No description. |
RecoveryWindowInDays |
double |
No description. |
Tags |
System.Collections.Generic.IDictionary<string, string> |
No description. |
TagsAll |
System.Collections.Generic.IDictionary<string, string> |
No description. |
public Node Node { get; }
- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }
- Type: HashiCorp.Cdktf.TerraformStack
public string Fqn { get; }
- Type: string
public string FriendlyUniqueId { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }
- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
- Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
public object Connection { get; }
- Type: object
public object Count { get; }
- Type: object
public string[] DependsOn { get; }
- Type: string[]
public ITerraformIterator ForEach { get; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; }
- Type: object[]
public string Arn { get; }
- Type: string
public SecretsmanagerSecretReplicaList Replica { get; }
public string DescriptionInput { get; }
- Type: string
public object ForceOverwriteReplicaSecretInput { get; }
- Type: object
public string IdInput { get; }
- Type: string
public string KmsKeyIdInput { get; }
- Type: string
public string NameInput { get; }
- Type: string
public string NamePrefixInput { get; }
- Type: string
public string PolicyInput { get; }
- Type: string
public double RecoveryWindowInDaysInput { get; }
- Type: double
public object ReplicaInput { get; }
- Type: object
public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string Description { get; }
- Type: string
public object ForceOverwriteReplicaSecret { get; }
- Type: object
public string Id { get; }
- Type: string
public string KmsKeyId { get; }
- Type: string
public string Name { get; }
- Type: string
public string NamePrefix { get; }
- Type: string
public string Policy { get; }
- Type: string
public double RecoveryWindowInDays { get; }
- Type: double
public System.Collections.Generic.IDictionary<string, string> Tags { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Aws;
new SecretsmanagerSecretConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
string Description = null,
object ForceOverwriteReplicaSecret = null,
string Id = null,
string KmsKeyId = null,
string Name = null,
string NamePrefix = null,
string Policy = null,
double RecoveryWindowInDays = null,
object Replica = null,
System.Collections.Generic.IDictionary<string, string> Tags = null,
System.Collections.Generic.IDictionary<string, string> TagsAll = null
};
public object Connection { get; set; }
- Type: object
public object Count { get; set; }
- Type: object
public ITerraformDependable[] DependsOn { get; set; }
- Type: HashiCorp.Cdktf.ITerraformDependable[]
public ITerraformIterator ForEach { get; set; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; set; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; set; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; set; }
- Type: object[]
public string Description { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#description SecretsmanagerSecret#description}.
public object ForceOverwriteReplicaSecret { get; set; }
- Type: object
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#force_overwrite_replica_secret SecretsmanagerSecret#force_overwrite_replica_secret}.
public string Id { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#id SecretsmanagerSecret#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 string KmsKeyId { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#kms_key_id SecretsmanagerSecret#kms_key_id}.
public string Name { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#name SecretsmanagerSecret#name}.
public string NamePrefix { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#name_prefix SecretsmanagerSecret#name_prefix}.
public string Policy { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#policy SecretsmanagerSecret#policy}.
public double RecoveryWindowInDays { get; set; }
- Type: double
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#recovery_window_in_days SecretsmanagerSecret#recovery_window_in_days}.
public object Replica { get; set; }
- Type: object
replica block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#replica SecretsmanagerSecret#replica}
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.84.0/docs/resources/secretsmanager_secret#tags SecretsmanagerSecret#tags}.
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.84.0/docs/resources/secretsmanager_secret#tags_all SecretsmanagerSecret#tags_all}.
using HashiCorp.Cdktf.Providers.Aws;
new SecretsmanagerSecretReplica {
string Region,
string KmsKeyId = null
};
Name | Type | Description |
---|---|---|
Region |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#region SecretsmanagerSecret#region}. |
KmsKeyId |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#kms_key_id SecretsmanagerSecret#kms_key_id}. |
public string Region { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#region SecretsmanagerSecret#region}.
public string KmsKeyId { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/secretsmanager_secret#kms_key_id SecretsmanagerSecret#kms_key_id}.
using HashiCorp.Cdktf.Providers.Aws;
new SecretsmanagerSecretReplicaList(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). |
- Type: HashiCorp.Cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: bool
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. |
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.
- Type: string
private string ComputeFqn()
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private SecretsmanagerSecretReplicaOutputReference Get(double Index)
- Type: double
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 |
object |
No description. |
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.
public string Fqn { get; }
- Type: string
public object InternalValue { get; }
- Type: object
using HashiCorp.Cdktf.Providers.Aws;
new SecretsmanagerSecretReplicaOutputReference(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). |
- Type: HashiCorp.Cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: double
the index of this item in the list.
- Type: bool
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. |
ResetKmsKeyId |
No description. |
private string ComputeFqn()
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable InterpolationForAttribute(string Property)
- Type: string
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private void ResetKmsKeyId()
Name | Type | Description |
---|---|---|
CreationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
Fqn |
string |
No description. |
LastAccessedDate |
string |
No description. |
Status |
string |
No description. |
StatusMessage |
string |
No description. |
KmsKeyIdInput |
string |
No description. |
RegionInput |
string |
No description. |
KmsKeyId |
string |
No description. |
Region |
string |
No description. |
InternalValue |
object |
No description. |
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.
public string Fqn { get; }
- Type: string
public string LastAccessedDate { get; }
- Type: string
public string Status { get; }
- Type: string
public string StatusMessage { get; }
- Type: string
public string KmsKeyIdInput { get; }
- Type: string
public string RegionInput { get; }
- Type: string
public string KmsKeyId { get; }
- Type: string
public string Region { get; }
- Type: string
public object InternalValue { get; }
- Type: object