Skip to content

Latest commit

 

History

History
2419 lines (1532 loc) · 99.9 KB

uptimeAlert.python.md

File metadata and controls

2419 lines (1532 loc) · 99.9 KB
Raw

uptimeAlert Submodule

Constructs

UptimeAlert

Represents a {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert digitalocean_uptime_alert}.

Initializers 

from cdktf_cdktf_provider_digitalocean import uptime_alert

uptimeAlert.UptimeAlert(
  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,
  check_id: str,
  name: str,
  notifications: typing.Union[IResolvable, typing.List[UptimeAlertNotifications]],
  type: str,
  comparison: str = None,
  period: str = None,
  threshold: typing.Union[int, float] = 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.
check_id str A unique identifier for a check.
name str A human-friendly display name for the alert.
notifications typing.Union[cdktf.IResolvable, typing.List[UptimeAlertNotifications]] notifications block.
type str The type of health check to perform. Enum: 'latency' 'down' 'down_global' 'ssl_expiry'.
comparison str The comparison operator used against the alert's threshold. Enum: 'greater_than' 'less_than.
period str Period of time the threshold must be exceeded to trigger the alert.
threshold typing.Union[int, float] The threshold at which the alert will enter a trigger state.
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]]
check_idRequired
  • Type: str

A unique identifier for a check.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#check_id UptimeAlert#check_id}

nameRequired
  • Type: str

A human-friendly display name for the alert.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#name UptimeAlert#name}

notificationsRequired

notifications block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#notifications UptimeAlert#notifications}

typeRequired
  • Type: str

The type of health check to perform. Enum: 'latency' 'down' 'down_global' 'ssl_expiry'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#type UptimeAlert#type}

comparisonOptional
  • Type: str

The comparison operator used against the alert's threshold. Enum: 'greater_than' 'less_than.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#comparison UptimeAlert#comparison}

periodOptional
  • Type: str

Period of time the threshold must be exceeded to trigger the alert.

Enum '2m' '3m' '5m' '10m' '15m' '30m' '1h'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#period UptimeAlert#period}

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

The threshold at which the alert will enter a trigger state.

The specific threshold is dependent on the alert type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#threshold UptimeAlert#threshold}

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_notifications No description.
reset_comparison No description.
reset_period No description.
reset_threshold 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_notifications 
def put_notifications(
  value: typing.Union[IResolvable, typing.List[UptimeAlertNotifications]]
) -> None
valueRequired
reset_comparison 
def reset_comparison() -> None
reset_period 
def reset_period() -> None
reset_threshold 
def reset_threshold() -> 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 UptimeAlert resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_digitalocean import uptime_alert

uptimeAlert.UptimeAlert.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_digitalocean import uptime_alert

uptimeAlert.UptimeAlert.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_digitalocean import uptime_alert

uptimeAlert.UptimeAlert.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_digitalocean import uptime_alert

uptimeAlert.UptimeAlert.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

import_from_idRequired
  • Type: str

The id of the existing UptimeAlert that should be imported.

Refer to the {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#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 UptimeAlert 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.
id str No description.
notifications UptimeAlertNotificationsList No description.
check_id_input str No description.
comparison_input str No description.
name_input str No description.
notifications_input typing.Union[cdktf.IResolvable, typing.List[UptimeAlertNotifications]] No description.
period_input str No description.
threshold_input typing.Union[int, float] No description.
type_input str No description.
check_id str No description.
comparison str No description.
name str No description.
period str No description.
threshold typing.Union[int, float] No description.
type 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]]
idRequired 
id: str
  • Type: str
notificationsRequired 
notifications: UptimeAlertNotificationsList
check_id_inputOptional 
check_id_input: str
  • Type: str
comparison_inputOptional 
comparison_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
notifications_inputOptional 
notifications_input: typing.Union[IResolvable, typing.List[UptimeAlertNotifications]]
period_inputOptional 
period_input: str
  • Type: str
threshold_inputOptional 
threshold_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
type_inputOptional 
type_input: str
  • Type: str
check_idRequired 
check_id: str
  • Type: str
comparisonRequired 
comparison: str
  • Type: str
nameRequired 
name: str
  • Type: str
periodRequired 
period: str
  • Type: str
thresholdRequired 
threshold: typing.Union[int, float]
  • Type: typing.Union[int, float]
typeRequired 
type: str
  • Type: str

Constants

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

Structs

UptimeAlertConfig

Initializer 

from cdktf_cdktf_provider_digitalocean import uptime_alert

uptimeAlert.UptimeAlertConfig(
  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,
  check_id: str,
  name: str,
  notifications: typing.Union[IResolvable, typing.List[UptimeAlertNotifications]],
  type: str,
  comparison: str = None,
  period: str = None,
  threshold: typing.Union[int, float] = 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.
check_id str A unique identifier for a check.
name str A human-friendly display name for the alert.
notifications typing.Union[cdktf.IResolvable, typing.List[UptimeAlertNotifications]] notifications block.
type str The type of health check to perform. Enum: 'latency' 'down' 'down_global' 'ssl_expiry'.
comparison str The comparison operator used against the alert's threshold. Enum: 'greater_than' 'less_than.
period str Period of time the threshold must be exceeded to trigger the alert.
threshold typing.Union[int, float] The threshold at which the alert will enter a trigger state.
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]]
check_idRequired 
check_id: str
  • Type: str

A unique identifier for a check.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#check_id UptimeAlert#check_id}

nameRequired 
name: str
  • Type: str

A human-friendly display name for the alert.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#name UptimeAlert#name}

notificationsRequired 
notifications: typing.Union[IResolvable, typing.List[UptimeAlertNotifications]]

notifications block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#notifications UptimeAlert#notifications}

typeRequired 
type: str
  • Type: str

The type of health check to perform. Enum: 'latency' 'down' 'down_global' 'ssl_expiry'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#type UptimeAlert#type}

comparisonOptional 
comparison: str
  • Type: str

The comparison operator used against the alert's threshold. Enum: 'greater_than' 'less_than.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#comparison UptimeAlert#comparison}

periodOptional 
period: str
  • Type: str

Period of time the threshold must be exceeded to trigger the alert.

Enum '2m' '3m' '5m' '10m' '15m' '30m' '1h'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#period UptimeAlert#period}

thresholdOptional 
threshold: typing.Union[int, float]
  • Type: typing.Union[int, float]

The threshold at which the alert will enter a trigger state.

The specific threshold is dependent on the alert type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#threshold UptimeAlert#threshold}

UptimeAlertNotifications

Initializer 

from cdktf_cdktf_provider_digitalocean import uptime_alert

uptimeAlert.UptimeAlertNotifications(
  email: typing.List[str] = None,
  slack: typing.Union[IResolvable, typing.List[UptimeAlertNotificationsSlack]] = None
)

Properties

Name Type Description
email typing.List[str] List of email addresses to sent notifications to.
slack typing.Union[cdktf.IResolvable, typing.List[UptimeAlertNotificationsSlack]] slack block.
emailOptional 
email: typing.List[str]
  • Type: typing.List[str]

List of email addresses to sent notifications to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#email UptimeAlert#email}

slackOptional 
slack: typing.Union[IResolvable, typing.List[UptimeAlertNotificationsSlack]]

slack block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#slack UptimeAlert#slack}

UptimeAlertNotificationsSlack

Initializer 

from cdktf_cdktf_provider_digitalocean import uptime_alert

uptimeAlert.UptimeAlertNotificationsSlack(
  channel: str,
  url: str
)

Properties

Name Type Description
channel str The Slack channel to send alerts to.
url str The webhook URL for Slack.
channelRequired 
channel: str
  • Type: str

The Slack channel to send alerts to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#channel UptimeAlert#channel}

urlRequired 
url: str
  • Type: str

The webhook URL for Slack.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/uptime_alert#url UptimeAlert#url}

Classes

UptimeAlertNotificationsList

Initializers 

from cdktf_cdktf_provider_digitalocean import uptime_alert

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

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

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

Creating an iterator for this complex list.

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

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

Produce the Token's value at resolution time.

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

Return a string representation of this resolvable object.

Returns a reversible string representation.

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

the index of the item to return.

Properties

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

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

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

UptimeAlertNotificationsOutputReference

Initializers 

from cdktf_cdktf_provider_digitalocean import uptime_alert

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

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

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

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
put_slack No description.
reset_email No description.
reset_slack 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.

put_slack 
def put_slack(
  value: typing.Union[IResolvable, typing.List[UptimeAlertNotificationsSlack]]
) -> None
valueRequired
reset_email 
def reset_email() -> None
reset_slack 
def reset_slack() -> 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.
slack UptimeAlertNotificationsSlackList No description.
email_input typing.List[str] No description.
slack_input typing.Union[cdktf.IResolvable, typing.List[UptimeAlertNotificationsSlack]] No description.
email typing.List[str] No description.
internal_value typing.Union[cdktf.IResolvable, UptimeAlertNotifications] 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
slackRequired 
slack: UptimeAlertNotificationsSlackList
email_inputOptional 
email_input: typing.List[str]
  • Type: typing.List[str]
slack_inputOptional 
slack_input: typing.Union[IResolvable, typing.List[UptimeAlertNotificationsSlack]]
emailRequired 
email: typing.List[str]
  • Type: typing.List[str]
internal_valueOptional 
internal_value: typing.Union[IResolvable, UptimeAlertNotifications]

UptimeAlertNotificationsSlackList

Initializers 

from cdktf_cdktf_provider_digitalocean import uptime_alert

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

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

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

Creating an iterator for this complex list.

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

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

Produce the Token's value at resolution time.

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

Return a string representation of this resolvable object.

Returns a reversible string representation.

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

the index of the item to return.

Properties

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

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

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

UptimeAlertNotificationsSlackOutputReference

Initializers 

from cdktf_cdktf_provider_digitalocean import uptime_alert

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

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

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

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
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.

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.
channel_input str No description.
url_input str No description.
channel str No description.
url str No description.
internal_value typing.Union[cdktf.IResolvable, UptimeAlertNotificationsSlack] 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
channel_inputOptional 
channel_input: str
  • Type: str
url_inputOptional 
url_input: str
  • Type: str
channelRequired 
channel: str
  • Type: str
urlRequired 
url: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, UptimeAlertNotificationsSlack]