Skip to content

Latest commit

 

History

History
1304 lines (830 loc) · 51.5 KB

sensitiveFile.python.md

File metadata and controls

1304 lines (830 loc) · 51.5 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 

from cdktf_cdktf_provider_local import sensitive_file

sensitiveFile.SensitiveFile(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  filename: str,
  content: str = None,
  content_base64: str = None,
  directory_permission: str = None,
  file_permission: str = None,
  source: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
filename str The path to the file that will be created.
content str Sensitive Content to store in the file, expected to be a UTF-8 encoded string.
content_base64 str Sensitive Content to store in the file, expected to be binary encoded as base64 string.
directory_permission str Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
file_permission str Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
source str Path to file to use as source for the one we are creating.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
filenameRequired
  • Type: str

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
  • Type: str

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}

content_base64Optional
  • Type: str

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}

directory_permissionOptional
  • Type: str

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}

file_permissionOptional
  • Type: str

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
  • Type: str

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}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_content No description.
reset_content_base64 No description.
reset_directory_permission No description.
reset_file_permission No description.
reset_source No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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: str

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

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

reset_content 
def reset_content() -> None
reset_content_base64 
def reset_content_base64() -> None
reset_directory_permission 
def reset_directory_permission() -> None
reset_file_permission 
def reset_file_permission() -> None
reset_source 
def reset_source() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a SensitiveFile resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_local import sensitive_file

sensitiveFile.SensitiveFile.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_local import sensitive_file

sensitiveFile.SensitiveFile.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_local import sensitive_file

sensitiveFile.SensitiveFile.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_local import sensitive_file

sensitiveFile.SensitiveFile.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

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: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
content_base64_sha256 str No description.
content_base64_sha512 str No description.
content_md5 str No description.
content_sha1 str No description.
content_sha256 str No description.
content_sha512 str No description.
id str No description.
content_base64_input str No description.
content_input str No description.
directory_permission_input str No description.
filename_input str No description.
file_permission_input str No description.
source_input str No description.
content str No description.
content_base64 str No description.
directory_permission str No description.
filename str No description.
file_permission str No description.
source str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
content_base64_sha256Required 
content_base64_sha256: str
  • Type: str
content_base64_sha512Required 
content_base64_sha512: str
  • Type: str
content_md5Required 
content_md5: str
  • Type: str
content_sha1Required 
content_sha1: str
  • Type: str
content_sha256Required 
content_sha256: str
  • Type: str
content_sha512Required 
content_sha512: str
  • Type: str
idRequired 
id: str
  • Type: str
content_base64_inputOptional 
content_base64_input: str
  • Type: str
content_inputOptional 
content_input: str
  • Type: str
directory_permission_inputOptional 
directory_permission_input: str
  • Type: str
filename_inputOptional 
filename_input: str
  • Type: str
file_permission_inputOptional 
file_permission_input: str
  • Type: str
source_inputOptional 
source_input: str
  • Type: str
contentRequired 
content: str
  • Type: str
content_base64Required 
content_base64: str
  • Type: str
directory_permissionRequired 
directory_permission: str
  • Type: str
filenameRequired 
filename: str
  • Type: str
file_permissionRequired 
file_permission: str
  • Type: str
sourceRequired 
source: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

SensitiveFileConfig

Initializer 

from cdktf_cdktf_provider_local import sensitive_file

sensitiveFile.SensitiveFileConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  filename: str,
  content: str = None,
  content_base64: str = None,
  directory_permission: str = None,
  file_permission: str = None,
  source: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
filename str The path to the file that will be created.
content str Sensitive Content to store in the file, expected to be a UTF-8 encoded string.
content_base64 str Sensitive Content to store in the file, expected to be binary encoded as base64 string.
directory_permission str Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
file_permission str Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
source str Path to file to use as source for the one we are creating.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
filenameRequired 
filename: str
  • Type: str

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 
content: str
  • Type: str

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}

content_base64Optional 
content_base64: str
  • Type: str

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}

directory_permissionOptional 
directory_permission: str
  • Type: str

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}

file_permissionOptional 
file_permission: str
  • Type: str

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 
source: str
  • Type: str

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}