`secretsSyncAssociation` Submodule

Constructs

SecretsSyncAssociation

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/secrets_sync_association vault_secrets_sync_association}.

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new SecretsSyncAssociation(Construct Scope, string Id, SecretsSyncAssociationConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`SecretsSyncAssociationConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`Id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`Config`^Required

Type: SecretsSyncAssociationConfig

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".
`ResetId`	No description.
`ResetNamespace`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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

`NewLogicalId`^Required

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.

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

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.

`Id`^Required

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.

`MoveTarget`^Required

Type: string

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

`Index`^Optional

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

`Id`^Required

Type: string

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

`ResetId`

private void ResetId()

`ResetNamespace`

private void ResetNamespace()

Static Functions

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

`IsConstruct`

using HashiCorp.Cdktf.Providers.Vault;

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

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Vault;

SecretsSyncAssociation.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Vault;

SecretsSyncAssociation.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Vault;

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

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

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`ImportToId`^Required

Type: string

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

`ImportFromId`^Required

Type: string

The id of the existing SecretsSyncAssociation that should be imported.

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

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the SecretsSyncAssociation 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.
`Metadata`	`SecretsSyncAssociationMetadataList`	No description.
`IdInput`	`string`	No description.
`MountInput`	`string`	No description.
`NameInput`	`string`	No description.
`NamespaceInput`	`string`	No description.
`SecretNameInput`	`string`	No description.
`TypeInput`	`string`	No description.
`Id`	`string`	No description.
`Mount`	`string`	No description.
`Name`	`string`	No description.
`Namespace`	`string`	No description.
`SecretName`	`string`	No description.
`Type`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

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

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`Metadata`^Required

public SecretsSyncAssociationMetadataList Metadata { get; }

Type: SecretsSyncAssociationMetadataList

`IdInput`^Optional

public string IdInput { get; }

Type: string

`MountInput`^Optional

public string MountInput { get; }

Type: string

`NameInput`^Optional

public string NameInput { get; }

Type: string

`NamespaceInput`^Optional

public string NamespaceInput { get; }

Type: string

`SecretNameInput`^Optional

public string SecretNameInput { get; }

Type: string

`TypeInput`^Optional

public string TypeInput { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`Mount`^Required

public string Mount { get; }

Type: string

`Name`^Required

public string Name { get; }

Type: string

`Namespace`^Required

public string Namespace { get; }

Type: string

`SecretName`^Required

public string SecretName { get; }

Type: string

`Type`^Required

public string Type { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

SecretsSyncAssociationConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new SecretsSyncAssociationConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Mount,
    string Name,
    string SecretName,
    string Type,
    string Id = null,
    string Namespace = 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.
`Mount`	`string`	Specifies the mount where the secret is located.
`Name`	`string`	Name of the destination.
`SecretName`	`string`	Specifies the name of the secret to synchronize.
`Type`	`string`	Type of sync destination.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/secrets_sync_association#id SecretsSyncAssociation#id}.
`Namespace`	`string`	Target namespace. (requires Enterprise).

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`Mount`^Required

public string Mount { get; set; }

Type: string

Specifies the mount where the secret is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/secrets_sync_association#mount SecretsSyncAssociation#mount}

`Name`^Required

public string Name { get; set; }

Type: string

Name of the destination.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/secrets_sync_association#name SecretsSyncAssociation#name}

`SecretName`^Required

public string SecretName { get; set; }

Type: string

Specifies the name of the secret to synchronize.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/secrets_sync_association#secret_name SecretsSyncAssociation#secret_name}

`Type`^Required

public string Type { get; set; }

Type: string

Type of sync destination.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/secrets_sync_association#type SecretsSyncAssociation#type}

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/secrets_sync_association#id SecretsSyncAssociation#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.

`Namespace`^Optional

public string Namespace { get; set; }

Type: string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/secrets_sync_association#namespace SecretsSyncAssociation#namespace}

SecretsSyncAssociationMetadata

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new SecretsSyncAssociationMetadata {

};

Classes

SecretsSyncAssociationMetadataList

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new SecretsSyncAssociationMetadataList(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).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`WrapsSet`^Required

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.

`MapKeyAttributeName`^Required

Type: string

`ComputeFqn`

private string ComputeFqn()

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

private SecretsSyncAssociationMetadataOutputReference Get(double Index)

`Index`^Required

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.

`CreationStack`^Required

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.

`Fqn`^Required

public string Fqn { get; }

Type: string

SecretsSyncAssociationMetadataOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new SecretsSyncAssociationMetadataOutputReference(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).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`ComplexObjectIndex`^Required

Type: double

the index of this item in the list.

`ComplexObjectIsFromSet`^Required

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)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

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.
`SubKey`	`string`	No description.
`SyncStatus`	`string`	No description.
`UpdatedAt`	`string`	No description.
`InternalValue`	`SecretsSyncAssociationMetadata`	No description.

`CreationStack`^Required

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.

`Fqn`^Required

public string Fqn { get; }

Type: string

`SubKey`^Required

public string SubKey { get; }

Type: string

`SyncStatus`^Required

public string SyncStatus { get; }

Type: string

`UpdatedAt`^Required

public string UpdatedAt { get; }

Type: string

`InternalValue`^Optional

public SecretsSyncAssociationMetadata InternalValue { get; }

Type: SecretsSyncAssociationMetadata

Files

secretsSyncAssociation.csharp.md

Latest commit

History

secretsSyncAssociation.csharp.md

File metadata and controls

secretsSyncAssociation Submodule

Constructs