Skip to content

Latest commit

 

History

History
1120 lines (698 loc) · 42.9 KB

sensitiveFile.csharp.md

File metadata and controls

1120 lines (698 loc) · 42.9 KB
Raw

sensitiveFile Submodule

Constructs

SensitiveFile

Represents a {@link https://registry.terraform.io/providers/hashicorp/local/2.5.1/docs/resources/sensitive_file local_sensitive_file}.

Initializers 

using HashiCorp.Cdktf.Providers.Local;

new SensitiveFile(Construct Scope, string Id, SensitiveFileConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config SensitiveFileConfig 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".
ResetContent No description.
ResetContentBase64 No description.
ResetDirectoryPermission No description.
ResetFilePermission No description.
ResetSource 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".

ResetContent 
private void ResetContent()
ResetContentBase64 
private void ResetContentBase64()
ResetDirectoryPermission 
private void ResetDirectoryPermission()
ResetFilePermission 
private void ResetFilePermission()
ResetSource 
private void ResetSource()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a SensitiveFile resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Local;

SensitiveFile.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.Local;

SensitiveFile.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using HashiCorp.Cdktf.Providers.Local;

SensitiveFile.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Local;

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

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

ImportFromIdRequired
  • Type: string

The id of the existing SensitiveFile that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/local/2.5.1/docs/resources/sensitive_file#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 SensitiveFile 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.
ContentBase64Sha256 string No description.
ContentBase64Sha512 string No description.
ContentMd5 string No description.
ContentSha1 string No description.
ContentSha256 string No description.
ContentSha512 string No description.
Id string No description.
ContentBase64Input string No description.
ContentInput string No description.
DirectoryPermissionInput string No description.
FilenameInput string No description.
FilePermissionInput string No description.
SourceInput string No description.
Content string No description.
ContentBase64 string No description.
DirectoryPermission string No description.
Filename string No description.
FilePermission string No description.
Source 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[]
ContentBase64Sha256Required 
public string ContentBase64Sha256 { get; }
  • Type: string
ContentBase64Sha512Required 
public string ContentBase64Sha512 { get; }
  • Type: string
ContentMd5Required 
public string ContentMd5 { get; }
  • Type: string
ContentSha1Required 
public string ContentSha1 { get; }
  • Type: string
ContentSha256Required 
public string ContentSha256 { get; }
  • Type: string
ContentSha512Required 
public string ContentSha512 { get; }
  • Type: string
IdRequired 
public string Id { get; }
  • Type: string
ContentBase64InputOptional 
public string ContentBase64Input { get; }
  • Type: string
ContentInputOptional 
public string ContentInput { get; }
  • Type: string
DirectoryPermissionInputOptional 
public string DirectoryPermissionInput { get; }
  • Type: string
FilenameInputOptional 
public string FilenameInput { get; }
  • Type: string
FilePermissionInputOptional 
public string FilePermissionInput { get; }
  • Type: string
SourceInputOptional 
public string SourceInput { get; }
  • Type: string
ContentRequired 
public string Content { get; }
  • Type: string
ContentBase64Required 
public string ContentBase64 { get; }
  • Type: string
DirectoryPermissionRequired 
public string DirectoryPermission { get; }
  • Type: string
FilenameRequired 
public string Filename { get; }
  • Type: string
FilePermissionRequired 
public string FilePermission { get; }
  • Type: string
SourceRequired 
public string Source { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

SensitiveFileConfig

Initializer 

using HashiCorp.Cdktf.Providers.Local;

new SensitiveFileConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Filename,
    string Content = null,
    string ContentBase64 = null,
    string DirectoryPermission = null,
    string FilePermission = null,
    string Source = 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.
Filename string The path to the file that will be created.
Content string Sensitive Content to store in the file, expected to be a UTF-8 encoded string.
ContentBase64 string Sensitive Content to store in the file, expected to be binary encoded as base64 string.
DirectoryPermission string Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
FilePermission string Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
Source string Path to file to use as source for the one we are creating.
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[]
FilenameRequired 
public string Filename { get; set; }
  • Type: string

The path to the file that will be created.

Missing parent directories will be created. If the file already exists, it will be overridden with the given content.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.5.1/docs/resources/sensitive_file#filename SensitiveFile#filename}

ContentOptional 
public string Content { get; set; }
  • Type: string

Sensitive Content to store in the file, expected to be a UTF-8 encoded string.

Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.5.1/docs/resources/sensitive_file#content SensitiveFile#content}

ContentBase64Optional 
public string ContentBase64 { get; set; }
  • Type: string

Sensitive Content to store in the file, expected to be binary encoded as base64 string.

Conflicts with content and source. Exactly one of these three arguments must be specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.5.1/docs/resources/sensitive_file#content_base64 SensitiveFile#content_base64}

DirectoryPermissionOptional 
public string DirectoryPermission { get; set; }
  • Type: string

Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.5.1/docs/resources/sensitive_file#directory_permission SensitiveFile#directory_permission}

FilePermissionOptional 
public string FilePermission { get; set; }
  • Type: string

Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.5.1/docs/resources/sensitive_file#file_permission SensitiveFile#file_permission}

SourceOptional 
public string Source { get; set; }
  • Type: string

Path to file to use as source for the one we are creating.

Conflicts with content and content_base64. Exactly one of these three arguments must be specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.5.1/docs/resources/sensitive_file#source SensitiveFile#source}