Skip to content

Latest commit

 

History

History
3492 lines (2221 loc) · 162 KB

encryptionAtRest.python.md

File metadata and controls

3492 lines (2221 loc) · 162 KB
Raw

encryptionAtRest Submodule

Constructs

EncryptionAtRest

Represents a {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest mongodbatlas_encryption_at_rest}.

Initializers 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRest(
  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,
  project_id: str,
  aws_kms_config: typing.Union[IResolvable, typing.List[EncryptionAtRestAwsKmsConfig]] = None,
  azure_key_vault_config: typing.Union[IResolvable, typing.List[EncryptionAtRestAzureKeyVaultConfig]] = None,
  google_cloud_kms_config: typing.Union[IResolvable, typing.List[EncryptionAtRestGoogleCloudKmsConfig]] = 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.
project_id str Unique 24-hexadecimal digit string that identifies your project.
aws_kms_config typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestAwsKmsConfig]] aws_kms_config block.
azure_key_vault_config typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestAzureKeyVaultConfig]] azure_key_vault_config block.
google_cloud_kms_config typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestGoogleCloudKmsConfig]] google_cloud_kms_config block.
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]]
project_idRequired
  • Type: str

Unique 24-hexadecimal digit string that identifies your project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#project_id EncryptionAtRest#project_id}

aws_kms_configOptional

aws_kms_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#aws_kms_config EncryptionAtRest#aws_kms_config}

azure_key_vault_configOptional

azure_key_vault_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#azure_key_vault_config EncryptionAtRest#azure_key_vault_config}

google_cloud_kms_configOptional

google_cloud_kms_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#google_cloud_kms_config EncryptionAtRest#google_cloud_kms_config}

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".
put_aws_kms_config No description.
put_azure_key_vault_config No description.
put_google_cloud_kms_config No description.
reset_aws_kms_config No description.
reset_azure_key_vault_config No description.
reset_google_cloud_kms_config 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".

put_aws_kms_config 
def put_aws_kms_config(
  value: typing.Union[IResolvable, typing.List[EncryptionAtRestAwsKmsConfig]]
) -> None
valueRequired
put_azure_key_vault_config 
def put_azure_key_vault_config(
  value: typing.Union[IResolvable, typing.List[EncryptionAtRestAzureKeyVaultConfig]]
) -> None
valueRequired
put_google_cloud_kms_config 
def put_google_cloud_kms_config(
  value: typing.Union[IResolvable, typing.List[EncryptionAtRestGoogleCloudKmsConfig]]
) -> None
valueRequired
reset_aws_kms_config 
def reset_aws_kms_config() -> None
reset_azure_key_vault_config 
def reset_azure_key_vault_config() -> None
reset_google_cloud_kms_config 
def reset_google_cloud_kms_config() -> 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 EncryptionAtRest resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRest.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_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRest.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRest.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRest.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

import_from_idRequired
  • Type: str

The id of the existing EncryptionAtRest that should be imported.

Refer to the {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#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 EncryptionAtRest 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.
aws_kms_config EncryptionAtRestAwsKmsConfigList No description.
azure_key_vault_config EncryptionAtRestAzureKeyVaultConfigList No description.
google_cloud_kms_config EncryptionAtRestGoogleCloudKmsConfigList No description.
id str No description.
aws_kms_config_input typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestAwsKmsConfig]] No description.
azure_key_vault_config_input typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestAzureKeyVaultConfig]] No description.
google_cloud_kms_config_input typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestGoogleCloudKmsConfig]] No description.
project_id_input str No description.
project_id 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]]
aws_kms_configRequired 
aws_kms_config: EncryptionAtRestAwsKmsConfigList
azure_key_vault_configRequired 
azure_key_vault_config: EncryptionAtRestAzureKeyVaultConfigList
google_cloud_kms_configRequired 
google_cloud_kms_config: EncryptionAtRestGoogleCloudKmsConfigList
idRequired 
id: str
  • Type: str
aws_kms_config_inputOptional 
aws_kms_config_input: typing.Union[IResolvable, typing.List[EncryptionAtRestAwsKmsConfig]]
azure_key_vault_config_inputOptional 
azure_key_vault_config_input: typing.Union[IResolvable, typing.List[EncryptionAtRestAzureKeyVaultConfig]]
google_cloud_kms_config_inputOptional 
google_cloud_kms_config_input: typing.Union[IResolvable, typing.List[EncryptionAtRestGoogleCloudKmsConfig]]
project_id_inputOptional 
project_id_input: str
  • Type: str
project_idRequired 
project_id: str
  • Type: str

Constants

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

Structs

EncryptionAtRestAwsKmsConfig

Initializer 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRestAwsKmsConfig(
  access_key_id: str = None,
  customer_master_key_id: str = None,
  enabled: typing.Union[bool, IResolvable] = None,
  region: str = None,
  role_id: str = None,
  secret_access_key: str = None
)

Properties

Name Type Description
access_key_id str Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).
customer_master_key_id str Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.
enabled typing.Union[bool, cdktf.IResolvable] Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS).
region str Physical location where MongoDB Atlas deploys your AWS-hosted MongoDB cluster nodes.
role_id str Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role.
secret_access_key str Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.
access_key_idOptional 
access_key_id: str
  • Type: str

Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#access_key_id EncryptionAtRest#access_key_id}

customer_master_key_idOptional 
customer_master_key_id: str
  • Type: str

Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#customer_master_key_id EncryptionAtRest#customer_master_key_id}

enabledOptional 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS).

To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#enabled EncryptionAtRest#enabled}

regionOptional 
region: str
  • Type: str

Physical location where MongoDB Atlas deploys your AWS-hosted MongoDB cluster nodes.

The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Atlas creates them as part of the deployment. MongoDB Atlas assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#region EncryptionAtRest#region}

role_idOptional 
role_id: str
  • Type: str

Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role.

This IAM role has the permissions required to manage your AWS customer master key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#role_id EncryptionAtRest#role_id}

secret_access_keyOptional 
secret_access_key: str
  • Type: str

Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#secret_access_key EncryptionAtRest#secret_access_key}

EncryptionAtRestAzureKeyVaultConfig

Initializer 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRestAzureKeyVaultConfig(
  azure_environment: str = None,
  client_id: str = None,
  enabled: typing.Union[bool, IResolvable] = None,
  key_identifier: str = None,
  key_vault_name: str = None,
  require_private_networking: typing.Union[bool, IResolvable] = None,
  resource_group_name: str = None,
  secret: str = None,
  subscription_id: str = None,
  tenant_id: str = None
)

Properties

Name Type Description
azure_environment str Azure environment in which your account credentials reside.
client_id str Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant.
enabled typing.Union[bool, cdktf.IResolvable] Flag that indicates whether someone enabled encryption at rest for the specified project.
key_identifier str Web address with a unique key that identifies for your Azure Key Vault.
key_vault_name str Unique string that identifies the Azure Key Vault that contains your key.
require_private_networking typing.Union[bool, cdktf.IResolvable] Enable connection to your Azure Key Vault over private networking.
resource_group_name str Name of the Azure resource group that contains your Azure Key Vault.
secret str Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (azureKeyVault.tenantID). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.
subscription_id str Unique 36-hexadecimal character string that identifies your Azure subscription.
tenant_id str Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription.
azure_environmentOptional 
azure_environment: str
  • Type: str

Azure environment in which your account credentials reside.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#azure_environment EncryptionAtRest#azure_environment}

client_idOptional 
client_id: str
  • Type: str

Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#client_id EncryptionAtRest#client_id}

enabledOptional 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Flag that indicates whether someone enabled encryption at rest for the specified project.

To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#enabled EncryptionAtRest#enabled}

key_identifierOptional 
key_identifier: str
  • Type: str

Web address with a unique key that identifies for your Azure Key Vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#key_identifier EncryptionAtRest#key_identifier}

key_vault_nameOptional 
key_vault_name: str
  • Type: str

Unique string that identifies the Azure Key Vault that contains your key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#key_vault_name EncryptionAtRest#key_vault_name}

require_private_networkingOptional 
require_private_networking: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Enable connection to your Azure Key Vault over private networking.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#require_private_networking EncryptionAtRest#require_private_networking}

resource_group_nameOptional 
resource_group_name: str
  • Type: str

Name of the Azure resource group that contains your Azure Key Vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#resource_group_name EncryptionAtRest#resource_group_name}

secretOptional 
secret: str
  • Type: str

Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (azureKeyVault.tenantID). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#secret EncryptionAtRest#secret}

subscription_idOptional 
subscription_id: str
  • Type: str

Unique 36-hexadecimal character string that identifies your Azure subscription.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#subscription_id EncryptionAtRest#subscription_id}

tenant_idOptional 
tenant_id: str
  • Type: str

Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#tenant_id EncryptionAtRest#tenant_id}

EncryptionAtRestConfig

Initializer 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRestConfig(
  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,
  project_id: str,
  aws_kms_config: typing.Union[IResolvable, typing.List[EncryptionAtRestAwsKmsConfig]] = None,
  azure_key_vault_config: typing.Union[IResolvable, typing.List[EncryptionAtRestAzureKeyVaultConfig]] = None,
  google_cloud_kms_config: typing.Union[IResolvable, typing.List[EncryptionAtRestGoogleCloudKmsConfig]] = 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.
project_id str Unique 24-hexadecimal digit string that identifies your project.
aws_kms_config typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestAwsKmsConfig]] aws_kms_config block.
azure_key_vault_config typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestAzureKeyVaultConfig]] azure_key_vault_config block.
google_cloud_kms_config typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestGoogleCloudKmsConfig]] google_cloud_kms_config block.
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]]
project_idRequired 
project_id: str
  • Type: str

Unique 24-hexadecimal digit string that identifies your project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#project_id EncryptionAtRest#project_id}

aws_kms_configOptional 
aws_kms_config: typing.Union[IResolvable, typing.List[EncryptionAtRestAwsKmsConfig]]

aws_kms_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#aws_kms_config EncryptionAtRest#aws_kms_config}

azure_key_vault_configOptional 
azure_key_vault_config: typing.Union[IResolvable, typing.List[EncryptionAtRestAzureKeyVaultConfig]]

azure_key_vault_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#azure_key_vault_config EncryptionAtRest#azure_key_vault_config}

google_cloud_kms_configOptional 
google_cloud_kms_config: typing.Union[IResolvable, typing.List[EncryptionAtRestGoogleCloudKmsConfig]]

google_cloud_kms_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#google_cloud_kms_config EncryptionAtRest#google_cloud_kms_config}

EncryptionAtRestGoogleCloudKmsConfig

Initializer 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRestGoogleCloudKmsConfig(
  enabled: typing.Union[bool, IResolvable] = None,
  key_version_resource_id: str = None,
  service_account_key: str = None
)

Properties

Name Type Description
enabled typing.Union[bool, cdktf.IResolvable] Flag that indicates whether someone enabled encryption at rest for the specified project.
key_version_resource_id str Resource path that displays the key version resource ID for your Google Cloud KMS.
service_account_key str JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS).
enabledOptional 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Flag that indicates whether someone enabled encryption at rest for the specified project.

To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#enabled EncryptionAtRest#enabled}

key_version_resource_idOptional 
key_version_resource_id: str
  • Type: str

Resource path that displays the key version resource ID for your Google Cloud KMS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#key_version_resource_id EncryptionAtRest#key_version_resource_id}

service_account_keyOptional 
service_account_key: str
  • Type: str

JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS).

Format the JSON as a string and not as an object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/encryption_at_rest#service_account_key EncryptionAtRest#service_account_key}

Classes

EncryptionAtRestAwsKmsConfigList

Initializers 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRestAwsKmsConfigList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • 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
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> EncryptionAtRestAwsKmsConfigOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestAwsKmsConfig]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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.

fqnRequired 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[EncryptionAtRestAwsKmsConfig]]

EncryptionAtRestAwsKmsConfigOutputReference

Initializers 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRestAwsKmsConfigOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • 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
compute_fqn No description.
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.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_access_key_id No description.
reset_customer_master_key_id No description.
reset_enabled No description.
reset_region No description.
reset_role_id No description.
reset_secret_access_key No description.
compute_fqn 
def compute_fqn() -> str
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
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_access_key_id 
def reset_access_key_id() -> None
reset_customer_master_key_id 
def reset_customer_master_key_id() -> None
reset_enabled 
def reset_enabled() -> None
reset_region 
def reset_region() -> None
reset_role_id 
def reset_role_id() -> None
reset_secret_access_key 
def reset_secret_access_key() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
valid cdktf.IResolvable No description.
access_key_id_input str No description.
customer_master_key_id_input str No description.
enabled_input typing.Union[bool, cdktf.IResolvable] No description.
region_input str No description.
role_id_input str No description.
secret_access_key_input str No description.
access_key_id str No description.
customer_master_key_id str No description.
enabled typing.Union[bool, cdktf.IResolvable] No description.
region str No description.
role_id str No description.
secret_access_key str No description.
internal_value typing.Union[cdktf.IResolvable, EncryptionAtRestAwsKmsConfig] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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.

fqnRequired 
fqn: str
  • Type: str
validRequired 
valid: IResolvable
  • Type: cdktf.IResolvable
access_key_id_inputOptional 
access_key_id_input: str
  • Type: str
customer_master_key_id_inputOptional 
customer_master_key_id_input: str
  • Type: str
enabled_inputOptional 
enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
region_inputOptional 
region_input: str
  • Type: str
role_id_inputOptional 
role_id_input: str
  • Type: str
secret_access_key_inputOptional 
secret_access_key_input: str
  • Type: str
access_key_idRequired 
access_key_id: str
  • Type: str
customer_master_key_idRequired 
customer_master_key_id: str
  • Type: str
enabledRequired 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
regionRequired 
region: str
  • Type: str
role_idRequired 
role_id: str
  • Type: str
secret_access_keyRequired 
secret_access_key: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, EncryptionAtRestAwsKmsConfig]

EncryptionAtRestAzureKeyVaultConfigList

Initializers 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRestAzureKeyVaultConfigList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • 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
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> EncryptionAtRestAzureKeyVaultConfigOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestAzureKeyVaultConfig]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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.

fqnRequired 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[EncryptionAtRestAzureKeyVaultConfig]]

EncryptionAtRestAzureKeyVaultConfigOutputReference

Initializers 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRestAzureKeyVaultConfigOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • 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
compute_fqn No description.
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.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_azure_environment No description.
reset_client_id No description.
reset_enabled No description.
reset_key_identifier No description.
reset_key_vault_name No description.
reset_require_private_networking No description.
reset_resource_group_name No description.
reset_secret No description.
reset_subscription_id No description.
reset_tenant_id No description.
compute_fqn 
def compute_fqn() -> str
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
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_azure_environment 
def reset_azure_environment() -> None
reset_client_id 
def reset_client_id() -> None
reset_enabled 
def reset_enabled() -> None
reset_key_identifier 
def reset_key_identifier() -> None
reset_key_vault_name 
def reset_key_vault_name() -> None
reset_require_private_networking 
def reset_require_private_networking() -> None
reset_resource_group_name 
def reset_resource_group_name() -> None
reset_secret 
def reset_secret() -> None
reset_subscription_id 
def reset_subscription_id() -> None
reset_tenant_id 
def reset_tenant_id() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
valid cdktf.IResolvable No description.
azure_environment_input str No description.
client_id_input str No description.
enabled_input typing.Union[bool, cdktf.IResolvable] No description.
key_identifier_input str No description.
key_vault_name_input str No description.
require_private_networking_input typing.Union[bool, cdktf.IResolvable] No description.
resource_group_name_input str No description.
secret_input str No description.
subscription_id_input str No description.
tenant_id_input str No description.
azure_environment str No description.
client_id str No description.
enabled typing.Union[bool, cdktf.IResolvable] No description.
key_identifier str No description.
key_vault_name str No description.
require_private_networking typing.Union[bool, cdktf.IResolvable] No description.
resource_group_name str No description.
secret str No description.
subscription_id str No description.
tenant_id str No description.
internal_value typing.Union[cdktf.IResolvable, EncryptionAtRestAzureKeyVaultConfig] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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.

fqnRequired 
fqn: str
  • Type: str
validRequired 
valid: IResolvable
  • Type: cdktf.IResolvable
azure_environment_inputOptional 
azure_environment_input: str
  • Type: str
client_id_inputOptional 
client_id_input: str
  • Type: str
enabled_inputOptional 
enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
key_identifier_inputOptional 
key_identifier_input: str
  • Type: str
key_vault_name_inputOptional 
key_vault_name_input: str
  • Type: str
require_private_networking_inputOptional 
require_private_networking_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
resource_group_name_inputOptional 
resource_group_name_input: str
  • Type: str
secret_inputOptional 
secret_input: str
  • Type: str
subscription_id_inputOptional 
subscription_id_input: str
  • Type: str
tenant_id_inputOptional 
tenant_id_input: str
  • Type: str
azure_environmentRequired 
azure_environment: str
  • Type: str
client_idRequired 
client_id: str
  • Type: str
enabledRequired 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
key_identifierRequired 
key_identifier: str
  • Type: str
key_vault_nameRequired 
key_vault_name: str
  • Type: str
require_private_networkingRequired 
require_private_networking: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
resource_group_nameRequired 
resource_group_name: str
  • Type: str
secretRequired 
secret: str
  • Type: str
subscription_idRequired 
subscription_id: str
  • Type: str
tenant_idRequired 
tenant_id: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, EncryptionAtRestAzureKeyVaultConfig]

EncryptionAtRestGoogleCloudKmsConfigList

Initializers 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRestGoogleCloudKmsConfigList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • 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
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> EncryptionAtRestGoogleCloudKmsConfigOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[EncryptionAtRestGoogleCloudKmsConfig]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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.

fqnRequired 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[EncryptionAtRestGoogleCloudKmsConfig]]

EncryptionAtRestGoogleCloudKmsConfigOutputReference

Initializers 

from cdktf_cdktf_provider_mongodbatlas import encryption_at_rest

encryptionAtRest.EncryptionAtRestGoogleCloudKmsConfigOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • 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
compute_fqn No description.
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.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_enabled No description.
reset_key_version_resource_id No description.
reset_service_account_key No description.
compute_fqn 
def compute_fqn() -> str
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
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_enabled 
def reset_enabled() -> None
reset_key_version_resource_id 
def reset_key_version_resource_id() -> None
reset_service_account_key 
def reset_service_account_key() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
valid cdktf.IResolvable No description.
enabled_input typing.Union[bool, cdktf.IResolvable] No description.
key_version_resource_id_input str No description.
service_account_key_input str No description.
enabled typing.Union[bool, cdktf.IResolvable] No description.
key_version_resource_id str No description.
service_account_key str No description.
internal_value typing.Union[cdktf.IResolvable, EncryptionAtRestGoogleCloudKmsConfig] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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.

fqnRequired 
fqn: str
  • Type: str
validRequired 
valid: IResolvable
  • Type: cdktf.IResolvable
enabled_inputOptional 
enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
key_version_resource_id_inputOptional 
key_version_resource_id_input: str
  • Type: str
service_account_key_inputOptional 
service_account_key_input: str
  • Type: str
enabledRequired 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
key_version_resource_idRequired 
key_version_resource_id: str
  • Type: str
service_account_keyRequired 
service_account_key: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, EncryptionAtRestGoogleCloudKmsConfig]