`snapshot` Submodule

Constructs

Snapshot

Represents a {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot azurerm_snapshot}.

Initializers

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.Snapshot(
  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,
  create_option: str,
  location: str,
  name: str,
  resource_group_name: str,
  disk_access_id: str = None,
  disk_size_gb: typing.Union[int, float] = None,
  encryption_settings: SnapshotEncryptionSettings = None,
  id: str = None,
  incremental_enabled: typing.Union[bool, IResolvable] = None,
  network_access_policy: str = None,
  public_network_access_enabled: typing.Union[bool, IResolvable] = None,
  source_resource_id: str = None,
  source_uri: str = None,
  storage_account_id: str = None,
  tags: typing.Mapping[str] = None,
  timeouts: SnapshotTimeouts = 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.
`create_option`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#create_option Snapshot#create_option}.
`location`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#location Snapshot#location}.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#name Snapshot#name}.
`resource_group_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#resource_group_name Snapshot#resource_group_name}.
`disk_access_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#disk_access_id Snapshot#disk_access_id}.
`disk_size_gb`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#disk_size_gb Snapshot#disk_size_gb}.
`encryption_settings`	`SnapshotEncryptionSettings`	encryption_settings block.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#id Snapshot#id}.
`incremental_enabled`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#incremental_enabled Snapshot#incremental_enabled}.
`network_access_policy`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#network_access_policy Snapshot#network_access_policy}.
`public_network_access_enabled`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#public_network_access_enabled Snapshot#public_network_access_enabled}.
`source_resource_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_resource_id Snapshot#source_resource_id}.
`source_uri`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_uri Snapshot#source_uri}.
`storage_account_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#storage_account_id Snapshot#storage_account_id}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#tags Snapshot#tags}.
`timeouts`	`SnapshotTimeouts`	timeouts block.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`create_option`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#create_option Snapshot#create_option}.

`location`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#location Snapshot#location}.

`name`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#name Snapshot#name}.

`resource_group_name`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#resource_group_name Snapshot#resource_group_name}.

`disk_access_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#disk_access_id Snapshot#disk_access_id}.

`disk_size_gb`^Optional

Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#disk_size_gb Snapshot#disk_size_gb}.

`encryption_settings`^Optional

Type: SnapshotEncryptionSettings

encryption_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#encryption_settings Snapshot#encryption_settings}

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#id Snapshot#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`incremental_enabled`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#incremental_enabled Snapshot#incremental_enabled}.

`network_access_policy`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#network_access_policy Snapshot#network_access_policy}.

`public_network_access_enabled`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#public_network_access_enabled Snapshot#public_network_access_enabled}.

`source_resource_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_resource_id Snapshot#source_resource_id}.

`source_uri`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_uri Snapshot#source_uri}.

`storage_account_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#storage_account_id Snapshot#storage_account_id}.

`tags`^Optional

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#tags Snapshot#tags}.

`timeouts`^Optional

Type: SnapshotTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#timeouts Snapshot#timeouts}

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_encryption_settings`	No description.
`put_timeouts`	No description.
`reset_disk_access_id`	No description.
`reset_disk_size_gb`	No description.
`reset_encryption_settings`	No description.
`reset_id`	No description.
`reset_incremental_enabled`	No description.
`reset_network_access_policy`	No description.
`reset_public_network_access_enabled`	No description.
`reset_source_resource_id`	No description.
`reset_source_uri`	No description.
`reset_storage_account_id`	No description.
`reset_tags`	No description.
`reset_timeouts`	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

`path`^Required

Type: str

`value`^Required

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_id`^Required

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_target`^Required

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_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

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.

`id`^Required

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_target`^Required

Type: str

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

`index`^Optional

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

`id`^Required

Type: str

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

`put_encryption_settings`

def put_encryption_settings(
  disk_encryption_key: SnapshotEncryptionSettingsDiskEncryptionKey,
  key_encryption_key: SnapshotEncryptionSettingsKeyEncryptionKey = None
) -> None

`disk_encryption_key`^Required

Type: SnapshotEncryptionSettingsDiskEncryptionKey

disk_encryption_key block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#disk_encryption_key Snapshot#disk_encryption_key}

`key_encryption_key`^Optional

Type: SnapshotEncryptionSettingsKeyEncryptionKey

key_encryption_key block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#key_encryption_key Snapshot#key_encryption_key}

`put_timeouts`

def put_timeouts(
  create: str = None,
  delete: str = None,
  read: str = None,
  update: str = None
) -> None

`create`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#create Snapshot#create}.

`delete`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#delete Snapshot#delete}.

`read`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#read Snapshot#read}.

`update`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#update Snapshot#update}.

`reset_disk_access_id`

def reset_disk_access_id() -> None

`reset_disk_size_gb`

def reset_disk_size_gb() -> None

`reset_encryption_settings`

def reset_encryption_settings() -> None

`reset_id`

def reset_id() -> None

`reset_incremental_enabled`

def reset_incremental_enabled() -> None

`reset_network_access_policy`

def reset_network_access_policy() -> None

`reset_public_network_access_enabled`

def reset_public_network_access_enabled() -> None

`reset_source_resource_id`

def reset_source_resource_id() -> None

`reset_source_uri`

def reset_source_uri() -> None

`reset_storage_account_id`

def reset_storage_account_id() -> None

`reset_tags`

def reset_tags() -> None

`reset_timeouts`

def reset_timeouts() -> 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 Snapshot resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.Snapshot.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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.Snapshot.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.Snapshot.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.Snapshot.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing Snapshot that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the Snapshot 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.
`encryption_settings`	`SnapshotEncryptionSettingsOutputReference`	No description.
`timeouts`	`SnapshotTimeoutsOutputReference`	No description.
`trusted_launch_enabled`	`cdktf.IResolvable`	No description.
`create_option_input`	`str`	No description.
`disk_access_id_input`	`str`	No description.
`disk_size_gb_input`	`typing.Union[int, float]`	No description.
`encryption_settings_input`	`SnapshotEncryptionSettings`	No description.
`id_input`	`str`	No description.
`incremental_enabled_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`location_input`	`str`	No description.
`name_input`	`str`	No description.
`network_access_policy_input`	`str`	No description.
`public_network_access_enabled_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`resource_group_name_input`	`str`	No description.
`source_resource_id_input`	`str`	No description.
`source_uri_input`	`str`	No description.
`storage_account_id_input`	`str`	No description.
`tags_input`	`typing.Mapping[str]`	No description.
`timeouts_input`	`typing.Union[cdktf.IResolvable, SnapshotTimeouts]`	No description.
`create_option`	`str`	No description.
`disk_access_id`	`str`	No description.
`disk_size_gb`	`typing.Union[int, float]`	No description.
`id`	`str`	No description.
`incremental_enabled`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`location`	`str`	No description.
`name`	`str`	No description.
`network_access_policy`	`str`	No description.
`public_network_access_enabled`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`resource_group_name`	`str`	No description.
`source_resource_id`	`str`	No description.
`source_uri`	`str`	No description.
`storage_account_id`	`str`	No description.
`tags`	`typing.Mapping[str]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`encryption_settings`^Required

encryption_settings: SnapshotEncryptionSettingsOutputReference

Type: SnapshotEncryptionSettingsOutputReference

`timeouts`^Required

timeouts: SnapshotTimeoutsOutputReference

Type: SnapshotTimeoutsOutputReference

`trusted_launch_enabled`^Required

trusted_launch_enabled: IResolvable

Type: cdktf.IResolvable

`create_option_input`^Optional

create_option_input: str

Type: str

`disk_access_id_input`^Optional

disk_access_id_input: str

Type: str

`disk_size_gb_input`^Optional

disk_size_gb_input: typing.Union[int, float]

Type: typing.Union[int, float]

`encryption_settings_input`^Optional

encryption_settings_input: SnapshotEncryptionSettings

Type: SnapshotEncryptionSettings

`id_input`^Optional

id_input: str

Type: str

`incremental_enabled_input`^Optional

incremental_enabled_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`location_input`^Optional

location_input: str

Type: str

`name_input`^Optional

name_input: str

Type: str

`network_access_policy_input`^Optional

network_access_policy_input: str

Type: str

`public_network_access_enabled_input`^Optional

public_network_access_enabled_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`resource_group_name_input`^Optional

resource_group_name_input: str

Type: str

`source_resource_id_input`^Optional

source_resource_id_input: str

Type: str

`source_uri_input`^Optional

source_uri_input: str

Type: str

`storage_account_id_input`^Optional

storage_account_id_input: str

Type: str

`tags_input`^Optional

tags_input: typing.Mapping[str]

Type: typing.Mapping[str]

`timeouts_input`^Optional

timeouts_input: typing.Union[IResolvable, SnapshotTimeouts]

Type: typing.Union[cdktf.IResolvable, SnapshotTimeouts]

`create_option`^Required

create_option: str

Type: str

`disk_access_id`^Required

disk_access_id: str

Type: str

`disk_size_gb`^Required

disk_size_gb: typing.Union[int, float]

Type: typing.Union[int, float]

`id`^Required

id: str

Type: str

`incremental_enabled`^Required

incremental_enabled: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`location`^Required

location: str

Type: str

`name`^Required

name: str

Type: str

`network_access_policy`^Required

network_access_policy: str

Type: str

`public_network_access_enabled`^Required

public_network_access_enabled: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`resource_group_name`^Required

resource_group_name: str

Type: str

`source_resource_id`^Required

source_resource_id: str

Type: str

`source_uri`^Required

source_uri: str

Type: str

`storage_account_id`^Required

storage_account_id: str

Type: str

`tags`^Required

tags: typing.Mapping[str]

Type: typing.Mapping[str]

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

SnapshotConfig

Initializer

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.SnapshotConfig(
  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,
  create_option: str,
  location: str,
  name: str,
  resource_group_name: str,
  disk_access_id: str = None,
  disk_size_gb: typing.Union[int, float] = None,
  encryption_settings: SnapshotEncryptionSettings = None,
  id: str = None,
  incremental_enabled: typing.Union[bool, IResolvable] = None,
  network_access_policy: str = None,
  public_network_access_enabled: typing.Union[bool, IResolvable] = None,
  source_resource_id: str = None,
  source_uri: str = None,
  storage_account_id: str = None,
  tags: typing.Mapping[str] = None,
  timeouts: SnapshotTimeouts = 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.
`create_option`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#create_option Snapshot#create_option}.
`location`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#location Snapshot#location}.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#name Snapshot#name}.
`resource_group_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#resource_group_name Snapshot#resource_group_name}.
`disk_access_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#disk_access_id Snapshot#disk_access_id}.
`disk_size_gb`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#disk_size_gb Snapshot#disk_size_gb}.
`encryption_settings`	`SnapshotEncryptionSettings`	encryption_settings block.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#id Snapshot#id}.
`incremental_enabled`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#incremental_enabled Snapshot#incremental_enabled}.
`network_access_policy`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#network_access_policy Snapshot#network_access_policy}.
`public_network_access_enabled`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#public_network_access_enabled Snapshot#public_network_access_enabled}.
`source_resource_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_resource_id Snapshot#source_resource_id}.
`source_uri`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_uri Snapshot#source_uri}.
`storage_account_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#storage_account_id Snapshot#storage_account_id}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#tags Snapshot#tags}.
`timeouts`	`SnapshotTimeouts`	timeouts block.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`create_option`^Required

create_option: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#create_option Snapshot#create_option}.

`location`^Required

location: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#location Snapshot#location}.

`name`^Required

name: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#name Snapshot#name}.

`resource_group_name`^Required

resource_group_name: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#resource_group_name Snapshot#resource_group_name}.

`disk_access_id`^Optional

disk_access_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#disk_access_id Snapshot#disk_access_id}.

`disk_size_gb`^Optional

disk_size_gb: typing.Union[int, float]

Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#disk_size_gb Snapshot#disk_size_gb}.

`encryption_settings`^Optional

encryption_settings: SnapshotEncryptionSettings

Type: SnapshotEncryptionSettings

encryption_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#encryption_settings Snapshot#encryption_settings}

`id`^Optional

id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#id Snapshot#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`incremental_enabled`^Optional

incremental_enabled: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#incremental_enabled Snapshot#incremental_enabled}.

`network_access_policy`^Optional

network_access_policy: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#network_access_policy Snapshot#network_access_policy}.

`public_network_access_enabled`^Optional

public_network_access_enabled: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#public_network_access_enabled Snapshot#public_network_access_enabled}.

`source_resource_id`^Optional

source_resource_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_resource_id Snapshot#source_resource_id}.

`source_uri`^Optional

source_uri: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_uri Snapshot#source_uri}.

`storage_account_id`^Optional

storage_account_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#storage_account_id Snapshot#storage_account_id}.

`tags`^Optional

tags: typing.Mapping[str]

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#tags Snapshot#tags}.

`timeouts`^Optional

timeouts: SnapshotTimeouts

Type: SnapshotTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#timeouts Snapshot#timeouts}

SnapshotEncryptionSettings

Initializer

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.SnapshotEncryptionSettings(
  disk_encryption_key: SnapshotEncryptionSettingsDiskEncryptionKey,
  key_encryption_key: SnapshotEncryptionSettingsKeyEncryptionKey = None
)

Properties

Name	Type	Description
`disk_encryption_key`	`SnapshotEncryptionSettingsDiskEncryptionKey`	disk_encryption_key block.
`key_encryption_key`	`SnapshotEncryptionSettingsKeyEncryptionKey`	key_encryption_key block.

`disk_encryption_key`^Required

disk_encryption_key: SnapshotEncryptionSettingsDiskEncryptionKey

Type: SnapshotEncryptionSettingsDiskEncryptionKey

disk_encryption_key block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#disk_encryption_key Snapshot#disk_encryption_key}

`key_encryption_key`^Optional

key_encryption_key: SnapshotEncryptionSettingsKeyEncryptionKey

Type: SnapshotEncryptionSettingsKeyEncryptionKey

key_encryption_key block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#key_encryption_key Snapshot#key_encryption_key}

SnapshotEncryptionSettingsDiskEncryptionKey

Initializer

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.SnapshotEncryptionSettingsDiskEncryptionKey(
  secret_url: str,
  source_vault_id: str
)

Properties

Name	Type	Description
`secret_url`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#secret_url Snapshot#secret_url}.
`source_vault_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_vault_id Snapshot#source_vault_id}.

`secret_url`^Required

secret_url: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#secret_url Snapshot#secret_url}.

`source_vault_id`^Required

source_vault_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_vault_id Snapshot#source_vault_id}.

SnapshotEncryptionSettingsKeyEncryptionKey

Initializer

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.SnapshotEncryptionSettingsKeyEncryptionKey(
  key_url: str,
  source_vault_id: str
)

Properties

Name	Type	Description
`key_url`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#key_url Snapshot#key_url}.
`source_vault_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_vault_id Snapshot#source_vault_id}.

`key_url`^Required

key_url: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#key_url Snapshot#key_url}.

`source_vault_id`^Required

source_vault_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_vault_id Snapshot#source_vault_id}.

SnapshotTimeouts

Initializer

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.SnapshotTimeouts(
  create: str = None,
  delete: str = None,
  read: str = None,
  update: str = None
)

Properties

Name	Type	Description
`create`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#create Snapshot#create}.
`delete`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#delete Snapshot#delete}.
`read`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#read Snapshot#read}.
`update`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#update Snapshot#update}.

`create`^Optional

create: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#create Snapshot#create}.

`delete`^Optional

delete: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#delete Snapshot#delete}.

`read`^Optional

read: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#read Snapshot#read}.

`update`^Optional

update: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#update Snapshot#update}.

Classes

SnapshotEncryptionSettingsDiskEncryptionKeyOutputReference

Initializers

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.SnapshotEncryptionSettingsDiskEncryptionKeyOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

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.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
`secret_url_input`	`str`	No description.
`source_vault_id_input`	`str`	No description.
`secret_url`	`str`	No description.
`source_vault_id`	`str`	No description.
`internal_value`	`SnapshotEncryptionSettingsDiskEncryptionKey`	No description.

`creation_stack`^Required

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.

`fqn`^Required

fqn: str

Type: str

`secret_url_input`^Optional

secret_url_input: str

Type: str

`source_vault_id_input`^Optional

source_vault_id_input: str

Type: str

`secret_url`^Required

secret_url: str

Type: str

`source_vault_id`^Required

source_vault_id: str

Type: str

`internal_value`^Optional

internal_value: SnapshotEncryptionSettingsDiskEncryptionKey

Type: SnapshotEncryptionSettingsDiskEncryptionKey

SnapshotEncryptionSettingsKeyEncryptionKeyOutputReference

Initializers

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.SnapshotEncryptionSettingsKeyEncryptionKeyOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

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.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
`key_url_input`	`str`	No description.
`source_vault_id_input`	`str`	No description.
`key_url`	`str`	No description.
`source_vault_id`	`str`	No description.
`internal_value`	`SnapshotEncryptionSettingsKeyEncryptionKey`	No description.

`creation_stack`^Required

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.

`fqn`^Required

fqn: str

Type: str

`key_url_input`^Optional

key_url_input: str

Type: str

`source_vault_id_input`^Optional

source_vault_id_input: str

Type: str

`key_url`^Required

key_url: str

Type: str

`source_vault_id`^Required

source_vault_id: str

Type: str

`internal_value`^Optional

internal_value: SnapshotEncryptionSettingsKeyEncryptionKey

Type: SnapshotEncryptionSettingsKeyEncryptionKey

SnapshotEncryptionSettingsOutputReference

Initializers

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.SnapshotEncryptionSettingsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

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.
`put_disk_encryption_key`	No description.
`put_key_encryption_key`	No description.
`reset_key_encryption_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_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`put_disk_encryption_key`

def put_disk_encryption_key(
  secret_url: str,
  source_vault_id: str
) -> None

`secret_url`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#secret_url Snapshot#secret_url}.

`source_vault_id`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_vault_id Snapshot#source_vault_id}.

`put_key_encryption_key`

def put_key_encryption_key(
  key_url: str,
  source_vault_id: str
) -> None

`key_url`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#key_url Snapshot#key_url}.

`source_vault_id`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs/resources/snapshot#source_vault_id Snapshot#source_vault_id}.

`reset_key_encryption_key`

def reset_key_encryption_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.
`disk_encryption_key`	`SnapshotEncryptionSettingsDiskEncryptionKeyOutputReference`	No description.
`key_encryption_key`	`SnapshotEncryptionSettingsKeyEncryptionKeyOutputReference`	No description.
`disk_encryption_key_input`	`SnapshotEncryptionSettingsDiskEncryptionKey`	No description.
`key_encryption_key_input`	`SnapshotEncryptionSettingsKeyEncryptionKey`	No description.
`internal_value`	`SnapshotEncryptionSettings`	No description.

`creation_stack`^Required

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.

`fqn`^Required

fqn: str

Type: str

`disk_encryption_key`^Required

disk_encryption_key: SnapshotEncryptionSettingsDiskEncryptionKeyOutputReference

Type: SnapshotEncryptionSettingsDiskEncryptionKeyOutputReference

`key_encryption_key`^Required

key_encryption_key: SnapshotEncryptionSettingsKeyEncryptionKeyOutputReference

Type: SnapshotEncryptionSettingsKeyEncryptionKeyOutputReference

`disk_encryption_key_input`^Optional

disk_encryption_key_input: SnapshotEncryptionSettingsDiskEncryptionKey

Type: SnapshotEncryptionSettingsDiskEncryptionKey

`key_encryption_key_input`^Optional

key_encryption_key_input: SnapshotEncryptionSettingsKeyEncryptionKey

Type: SnapshotEncryptionSettingsKeyEncryptionKey

`internal_value`^Optional

internal_value: SnapshotEncryptionSettings

Type: SnapshotEncryptionSettings

SnapshotTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_azurerm import snapshot

snapshot.SnapshotTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

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_create`	No description.
`reset_delete`	No description.
`reset_read`	No description.
`reset_update`	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_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_create`

def reset_create() -> None

`reset_delete`

def reset_delete() -> None

`reset_read`

def reset_read() -> None

`reset_update`

def reset_update() -> 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.
`create_input`	`str`	No description.
`delete_input`	`str`	No description.
`read_input`	`str`	No description.
`update_input`	`str`	No description.
`create`	`str`	No description.
`delete`	`str`	No description.
`read`	`str`	No description.
`update`	`str`	No description.
`internal_value`	`typing.Union[cdktf.IResolvable, SnapshotTimeouts]`	No description.

`creation_stack`^Required

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.

`fqn`^Required

fqn: str

Type: str

`create_input`^Optional

create_input: str

Type: str

`delete_input`^Optional

delete_input: str

Type: str

`read_input`^Optional

read_input: str

Type: str

`update_input`^Optional

update_input: str

Type: str

`create`^Required

create: str

Type: str

`delete`^Required

delete: str

Type: str

`read`^Required

read: str

Type: str

`update`^Required

update: str

Type: str

`internal_value`^Optional

internal_value: typing.Union[IResolvable, SnapshotTimeouts]

Type: typing.Union[cdktf.IResolvable, SnapshotTimeouts]

Files

snapshot.python.md

Latest commit

History

snapshot.python.md

File metadata and controls

snapshot Submodule

Constructs

Snapshot

Initializers

scopeRequired

idRequired

connectionOptional

countOptional

depends_onOptional

for_eachOptional

lifecycleOptional

providerOptional

provisionersOptional

create_optionRequired

locationRequired

nameRequired

resource_group_nameRequired

disk_access_idOptional

disk_size_gbOptional

encryption_settingsOptional

idOptional

incremental_enabledOptional

network_access_policyOptional

public_network_access_enabledOptional

source_resource_idOptional

source_uriOptional

storage_account_idOptional

tagsOptional

timeoutsOptional

Methods

to_string

add_override

pathRequired

valueRequired

override_logical_id

new_logical_idRequired

reset_override_logical_id

to_hcl_terraform

to_metadata

to_terraform

add_move_target

move_targetRequired

get_any_map_attribute

terraform_attributeRequired

get_boolean_attribute

terraform_attributeRequired

get_boolean_map_attribute

terraform_attributeRequired

get_list_attribute

terraform_attributeRequired

get_number_attribute

terraform_attributeRequired

get_number_list_attribute

terraform_attributeRequired

get_number_map_attribute

terraform_attributeRequired

get_string_attribute

terraform_attributeRequired

get_string_map_attribute

terraform_attributeRequired

has_resource_move

import_from

idRequired

providerOptional

interpolation_for_attribute

terraform_attributeRequired

move_from_id

idRequired

move_to

move_targetRequired

indexOptional

move_to_id

idRequired

put_encryption_settings

`snapshot` Submodule

`scope`^Required

`id`^Required

`connection`^Optional

`count`^Optional

`depends_on`^Optional

`for_each`^Optional

`lifecycle`^Optional

`provider`^Optional

`provisioners`^Optional

`create_option`^Required

`location`^Required

`name`^Required

`resource_group_name`^Required

`disk_access_id`^Optional

`disk_size_gb`^Optional

`encryption_settings`^Optional

`id`^Optional

`incremental_enabled`^Optional

`network_access_policy`^Optional

`public_network_access_enabled`^Optional

`source_resource_id`^Optional

`source_uri`^Optional

`storage_account_id`^Optional

`tags`^Optional

`timeouts`^Optional

`to_string`

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`add_move_target`

`move_target`^Required

`get_any_map_attribute`

`terraform_attribute`^Required

`get_boolean_attribute`

`terraform_attribute`^Required

`get_boolean_map_attribute`

`terraform_attribute`^Required

`get_list_attribute`

`terraform_attribute`^Required

`get_number_attribute`

`terraform_attribute`^Required

`get_number_list_attribute`

`terraform_attribute`^Required

`get_number_map_attribute`

`terraform_attribute`^Required

`get_string_attribute`

`terraform_attribute`^Required

`get_string_map_attribute`

`terraform_attribute`^Required

`has_resource_move`

`import_from`

`id`^Required

`provider`^Optional

`interpolation_for_attribute`

`terraform_attribute`^Required

`move_from_id`

`id`^Required

`move_to`

`move_target`^Required

`index`^Optional

`move_to_id`

`id`^Required

`put_encryption_settings`

`disk_encryption_key`^Required

`key_encryption_key`^Optional

`put_timeouts`

`create`^Optional

`delete`^Optional

`read`^Optional

`update`^Optional

`reset_disk_access_id`

`reset_disk_size_gb`

`reset_encryption_settings`