Skip to content

Latest commit

 

History

History
2441 lines (1560 loc) · 99 KB

publicIp.python.md

File metadata and controls

2441 lines (1560 loc) · 99 KB

publicIp Submodule

Constructs

PublicIp

Represents a {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip azurerm_public_ip}.

Initializers 

from cdktf_cdktf_provider_azurerm import public_ip

publicIp.PublicIp(
  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,
  allocation_method: str,
  location: str,
  name: str,
  resource_group_name: str,
  ddos_protection_mode: str = None,
  ddos_protection_plan_id: str = None,
  domain_name_label: str = None,
  domain_name_label_scope: str = None,
  edge_zone: str = None,
  id: str = None,
  idle_timeout_in_minutes: typing.Union[int, float] = None,
  ip_tags: typing.Mapping[str] = None,
  ip_version: str = None,
  public_ip_prefix_id: str = None,
  reverse_fqdn: str = None,
  sku: str = None,
  sku_tier: str = None,
  tags: typing.Mapping[str] = None,
  timeouts: PublicIpTimeouts = None,
  zones: typing.List[str] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
allocation_method str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#allocation_method PublicIp#allocation_method}.
location str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#location PublicIp#location}.
name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#name PublicIp#name}.
resource_group_name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#resource_group_name PublicIp#resource_group_name}.
ddos_protection_mode str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ddos_protection_mode PublicIp#ddos_protection_mode}.
ddos_protection_plan_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ddos_protection_plan_id PublicIp#ddos_protection_plan_id}.
domain_name_label str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#domain_name_label PublicIp#domain_name_label}.
domain_name_label_scope str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#domain_name_label_scope PublicIp#domain_name_label_scope}.
edge_zone str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#edge_zone PublicIp#edge_zone}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#id PublicIp#id}.
idle_timeout_in_minutes typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#idle_timeout_in_minutes PublicIp#idle_timeout_in_minutes}.
ip_tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ip_tags PublicIp#ip_tags}.
ip_version str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ip_version PublicIp#ip_version}.
public_ip_prefix_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#public_ip_prefix_id PublicIp#public_ip_prefix_id}.
reverse_fqdn str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#reverse_fqdn PublicIp#reverse_fqdn}.
sku str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#sku PublicIp#sku}.
sku_tier str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#sku_tier PublicIp#sku_tier}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#tags PublicIp#tags}.
timeouts PublicIpTimeouts timeouts block.
zones typing.List[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#zones PublicIp#zones}.
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]]
allocation_methodRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#allocation_method PublicIp#allocation_method}.

locationRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#location PublicIp#location}.

nameRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#name PublicIp#name}.

resource_group_nameRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#resource_group_name PublicIp#resource_group_name}.

ddos_protection_modeOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ddos_protection_mode PublicIp#ddos_protection_mode}.

ddos_protection_plan_idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ddos_protection_plan_id PublicIp#ddos_protection_plan_id}.

domain_name_labelOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#domain_name_label PublicIp#domain_name_label}.

domain_name_label_scopeOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#domain_name_label_scope PublicIp#domain_name_label_scope}.

edge_zoneOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#edge_zone PublicIp#edge_zone}.

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#id PublicIp#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.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#idle_timeout_in_minutes PublicIp#idle_timeout_in_minutes}.

ip_tagsOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ip_tags PublicIp#ip_tags}.

ip_versionOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ip_version PublicIp#ip_version}.

public_ip_prefix_idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#public_ip_prefix_id PublicIp#public_ip_prefix_id}.

reverse_fqdnOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#reverse_fqdn PublicIp#reverse_fqdn}.

skuOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#sku PublicIp#sku}.

sku_tierOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#sku_tier PublicIp#sku_tier}.

tagsOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#tags PublicIp#tags}.

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#timeouts PublicIp#timeouts}

zonesOptional
  • Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#zones PublicIp#zones}.

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_timeouts No description.
reset_ddos_protection_mode No description.
reset_ddos_protection_plan_id No description.
reset_domain_name_label No description.
reset_domain_name_label_scope No description.
reset_edge_zone No description.
reset_id No description.
reset_idle_timeout_in_minutes No description.
reset_ip_tags No description.
reset_ip_version No description.
reset_public_ip_prefix_id No description.
reset_reverse_fqdn No description.
reset_sku No description.
reset_sku_tier No description.
reset_tags No description.
reset_timeouts No description.
reset_zones 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_timeouts 
def put_timeouts(
  create: str = None,
  delete: str = None,
  read: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#create PublicIp#create}.

deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#delete PublicIp#delete}.

readOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#read PublicIp#read}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#update PublicIp#update}.

reset_ddos_protection_mode 
def reset_ddos_protection_mode() -> None
reset_ddos_protection_plan_id 
def reset_ddos_protection_plan_id() -> None
reset_domain_name_label 
def reset_domain_name_label() -> None
reset_domain_name_label_scope 
def reset_domain_name_label_scope() -> None
reset_edge_zone 
def reset_edge_zone() -> None
reset_id 
def reset_id() -> None
reset_idle_timeout_in_minutes 
def reset_idle_timeout_in_minutes() -> None
reset_ip_tags 
def reset_ip_tags() -> None
reset_ip_version 
def reset_ip_version() -> None
reset_public_ip_prefix_id 
def reset_public_ip_prefix_id() -> None
reset_reverse_fqdn 
def reset_reverse_fqdn() -> None
reset_sku 
def reset_sku() -> None
reset_sku_tier 
def reset_sku_tier() -> None
reset_tags 
def reset_tags() -> None
reset_timeouts 
def reset_timeouts() -> None
reset_zones 
def reset_zones() -> 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 PublicIp resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_azurerm import public_ip

publicIp.PublicIp.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_azurerm import public_ip

publicIp.PublicIp.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_azurerm import public_ip

publicIp.PublicIp.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_azurerm import public_ip

publicIp.PublicIp.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

import_from_idRequired
  • Type: str

The id of the existing PublicIp that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#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 PublicIp 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.
fqdn str No description.
ip_address str No description.
timeouts PublicIpTimeoutsOutputReference No description.
allocation_method_input str No description.
ddos_protection_mode_input str No description.
ddos_protection_plan_id_input str No description.
domain_name_label_input str No description.
domain_name_label_scope_input str No description.
edge_zone_input str No description.
id_input str No description.
idle_timeout_in_minutes_input typing.Union[int, float] No description.
ip_tags_input typing.Mapping[str] No description.
ip_version_input str No description.
location_input str No description.
name_input str No description.
public_ip_prefix_id_input str No description.
resource_group_name_input str No description.
reverse_fqdn_input str No description.
sku_input str No description.
sku_tier_input str No description.
tags_input typing.Mapping[str] No description.
timeouts_input typing.Union[cdktf.IResolvable, PublicIpTimeouts] No description.
zones_input typing.List[str] No description.
allocation_method str No description.
ddos_protection_mode str No description.
ddos_protection_plan_id str No description.
domain_name_label str No description.
domain_name_label_scope str No description.
edge_zone str No description.
id str No description.
idle_timeout_in_minutes typing.Union[int, float] No description.
ip_tags typing.Mapping[str] No description.
ip_version str No description.
location str No description.
name str No description.
public_ip_prefix_id str No description.
resource_group_name str No description.
reverse_fqdn str No description.
sku str No description.
sku_tier str No description.
tags typing.Mapping[str] No description.
zones typing.List[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]]
fqdnRequired 
fqdn: str
  • Type: str
ip_addressRequired 
ip_address: str
  • Type: str
timeoutsRequired 
timeouts: PublicIpTimeoutsOutputReference
allocation_method_inputOptional 
allocation_method_input: str
  • Type: str
ddos_protection_mode_inputOptional 
ddos_protection_mode_input: str
  • Type: str
ddos_protection_plan_id_inputOptional 
ddos_protection_plan_id_input: str
  • Type: str
domain_name_label_inputOptional 
domain_name_label_input: str
  • Type: str
domain_name_label_scope_inputOptional 
domain_name_label_scope_input: str
  • Type: str
edge_zone_inputOptional 
edge_zone_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
idle_timeout_in_minutes_inputOptional 
idle_timeout_in_minutes_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
ip_tags_inputOptional 
ip_tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
ip_version_inputOptional 
ip_version_input: str
  • Type: str
location_inputOptional 
location_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
public_ip_prefix_id_inputOptional 
public_ip_prefix_id_input: str
  • Type: str
resource_group_name_inputOptional 
resource_group_name_input: str
  • Type: str
reverse_fqdn_inputOptional 
reverse_fqdn_input: str
  • Type: str
sku_inputOptional 
sku_input: str
  • Type: str
sku_tier_inputOptional 
sku_tier_input: str
  • Type: str
tags_inputOptional 
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, PublicIpTimeouts]
zones_inputOptional 
zones_input: typing.List[str]
  • Type: typing.List[str]
allocation_methodRequired 
allocation_method: str
  • Type: str
ddos_protection_modeRequired 
ddos_protection_mode: str
  • Type: str
ddos_protection_plan_idRequired 
ddos_protection_plan_id: str
  • Type: str
domain_name_labelRequired 
domain_name_label: str
  • Type: str
domain_name_label_scopeRequired 
domain_name_label_scope: str
  • Type: str
edge_zoneRequired 
edge_zone: str
  • Type: str
idRequired 
id: str
  • Type: str
idle_timeout_in_minutesRequired 
idle_timeout_in_minutes: typing.Union[int, float]
  • Type: typing.Union[int, float]
ip_tagsRequired 
ip_tags: typing.Mapping[str]
  • Type: typing.Mapping[str]
ip_versionRequired 
ip_version: str
  • Type: str
locationRequired 
location: str
  • Type: str
nameRequired 
name: str
  • Type: str
public_ip_prefix_idRequired 
public_ip_prefix_id: str
  • Type: str
resource_group_nameRequired 
resource_group_name: str
  • Type: str
reverse_fqdnRequired 
reverse_fqdn: str
  • Type: str
skuRequired 
sku: str
  • Type: str
sku_tierRequired 
sku_tier: str
  • Type: str
tagsRequired 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]
zonesRequired 
zones: typing.List[str]
  • Type: typing.List[str]

Constants

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

Structs

PublicIpConfig

Initializer 

from cdktf_cdktf_provider_azurerm import public_ip

publicIp.PublicIpConfig(
  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,
  allocation_method: str,
  location: str,
  name: str,
  resource_group_name: str,
  ddos_protection_mode: str = None,
  ddos_protection_plan_id: str = None,
  domain_name_label: str = None,
  domain_name_label_scope: str = None,
  edge_zone: str = None,
  id: str = None,
  idle_timeout_in_minutes: typing.Union[int, float] = None,
  ip_tags: typing.Mapping[str] = None,
  ip_version: str = None,
  public_ip_prefix_id: str = None,
  reverse_fqdn: str = None,
  sku: str = None,
  sku_tier: str = None,
  tags: typing.Mapping[str] = None,
  timeouts: PublicIpTimeouts = None,
  zones: typing.List[str] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
allocation_method str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#allocation_method PublicIp#allocation_method}.
location str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#location PublicIp#location}.
name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#name PublicIp#name}.
resource_group_name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#resource_group_name PublicIp#resource_group_name}.
ddos_protection_mode str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ddos_protection_mode PublicIp#ddos_protection_mode}.
ddos_protection_plan_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ddos_protection_plan_id PublicIp#ddos_protection_plan_id}.
domain_name_label str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#domain_name_label PublicIp#domain_name_label}.
domain_name_label_scope str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#domain_name_label_scope PublicIp#domain_name_label_scope}.
edge_zone str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#edge_zone PublicIp#edge_zone}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#id PublicIp#id}.
idle_timeout_in_minutes typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#idle_timeout_in_minutes PublicIp#idle_timeout_in_minutes}.
ip_tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ip_tags PublicIp#ip_tags}.
ip_version str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ip_version PublicIp#ip_version}.
public_ip_prefix_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#public_ip_prefix_id PublicIp#public_ip_prefix_id}.
reverse_fqdn str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#reverse_fqdn PublicIp#reverse_fqdn}.
sku str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#sku PublicIp#sku}.
sku_tier str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#sku_tier PublicIp#sku_tier}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#tags PublicIp#tags}.
timeouts PublicIpTimeouts timeouts block.
zones typing.List[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#zones PublicIp#zones}.
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]]
allocation_methodRequired 
allocation_method: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#allocation_method PublicIp#allocation_method}.

locationRequired 
location: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#location PublicIp#location}.

nameRequired 
name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#name PublicIp#name}.

resource_group_nameRequired 
resource_group_name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#resource_group_name PublicIp#resource_group_name}.

ddos_protection_modeOptional 
ddos_protection_mode: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ddos_protection_mode PublicIp#ddos_protection_mode}.

ddos_protection_plan_idOptional 
ddos_protection_plan_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ddos_protection_plan_id PublicIp#ddos_protection_plan_id}.

domain_name_labelOptional 
domain_name_label: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#domain_name_label PublicIp#domain_name_label}.

domain_name_label_scopeOptional 
domain_name_label_scope: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#domain_name_label_scope PublicIp#domain_name_label_scope}.

edge_zoneOptional 
edge_zone: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#edge_zone PublicIp#edge_zone}.

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#id PublicIp#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.

idle_timeout_in_minutesOptional 
idle_timeout_in_minutes: typing.Union[int, float]
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#idle_timeout_in_minutes PublicIp#idle_timeout_in_minutes}.

ip_tagsOptional 
ip_tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ip_tags PublicIp#ip_tags}.

ip_versionOptional 
ip_version: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#ip_version PublicIp#ip_version}.

public_ip_prefix_idOptional 
public_ip_prefix_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#public_ip_prefix_id PublicIp#public_ip_prefix_id}.

reverse_fqdnOptional 
reverse_fqdn: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#reverse_fqdn PublicIp#reverse_fqdn}.

skuOptional 
sku: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#sku PublicIp#sku}.

sku_tierOptional 
sku_tier: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#sku_tier PublicIp#sku_tier}.

tagsOptional 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#tags PublicIp#tags}.

timeoutsOptional 
timeouts: PublicIpTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#timeouts PublicIp#timeouts}

zonesOptional 
zones: typing.List[str]
  • Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#zones PublicIp#zones}.

PublicIpTimeouts

Initializer 

from cdktf_cdktf_provider_azurerm import public_ip

publicIp.PublicIpTimeouts(
  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.21.1/docs/resources/public_ip#create PublicIp#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#delete PublicIp#delete}.
read str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#read PublicIp#read}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#update PublicIp#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#create PublicIp#create}.

deleteOptional 
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#delete PublicIp#delete}.

readOptional 
read: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#read PublicIp#read}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.21.1/docs/resources/public_ip#update PublicIp#update}.

Classes

PublicIpTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_azurerm import public_ip

publicIp.PublicIpTimeoutsOutputReference(
  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_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • 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_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_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, PublicIpTimeouts] 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
create_inputOptional 
create_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
read_inputOptional 
read_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
readRequired 
read: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, PublicIpTimeouts]