Skip to content

prometheusWorkspaceConfiguration.python.md

Latest commit

 

History

History
2686 lines (1708 loc) · 135 KB

prometheusWorkspaceConfiguration.python.md

File metadata and controls

2686 lines (1708 loc) · 135 KB

prometheusWorkspaceConfiguration Submodule

Constructs

PrometheusWorkspaceConfiguration

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration aws_prometheus_workspace_configuration}.

Initializers 

from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfiguration(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  workspace_id: str,
  limits_per_label_set: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSet] = None,
  region: str = None,
  retention_period_in_days: typing.Union[int, float] = None,
  timeouts: PrometheusWorkspaceConfigurationTimeouts = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
workspace_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#workspace_id PrometheusWorkspaceConfiguration#workspace_id}.
limits_per_label_set cdktn.IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSet] limits_per_label_set block.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
retention_period_in_days typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#retention_period_in_days PrometheusWorkspaceConfiguration#retention_period_in_days}.
timeouts PrometheusWorkspaceConfigurationTimeouts timeouts block.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#workspace_id PrometheusWorkspaceConfiguration#workspace_id}.

limits_per_label_setOptional

limits_per_label_set block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#limits_per_label_set PrometheusWorkspaceConfiguration#limits_per_label_set}

regionOptional
  • Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#region PrometheusWorkspaceConfiguration#region}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#retention_period_in_days PrometheusWorkspaceConfiguration#retention_period_in_days}.

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#timeouts PrometheusWorkspaceConfiguration#timeouts}

Methods

Name Description
to_string Returns a string representation of this construct.
with Applies one or more mixins to 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_limits_per_label_set No description.
put_timeouts No description.
reset_limits_per_label_set No description.
reset_region No description.
reset_retention_period_in_days No description.
reset_timeouts No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

with 
def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: *constructs.IMixin

The mixins to apply.

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() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktn.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: 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: 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_limits_per_label_set 
def put_limits_per_label_set(
  value: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSet]
) -> None
valueRequired
put_timeouts 
def put_timeouts(
  create: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#create PrometheusWorkspaceConfiguration#create}

updateOptional
  • Type: str

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#update PrometheusWorkspaceConfiguration#update}

reset_limits_per_label_set 
def reset_limits_per_label_set() -> None
reset_region 
def reset_region() -> None
reset_retention_period_in_days 
def reset_retention_period_in_days() -> 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 CDKTN code for importing a PrometheusWorkspaceConfiguration resource upon running "cdktn plan ".
is_construct 
from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfiguration.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 cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfiguration.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfiguration.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfiguration.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a PrometheusWorkspaceConfiguration resource upon running "cdktn 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 PrometheusWorkspaceConfiguration to import.

import_from_idRequired
  • Type: str

The id of the existing PrometheusWorkspaceConfiguration that should be imported.

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

providerOptional
  • Type: cdktn.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktn.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 cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[str] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
limits_per_label_set PrometheusWorkspaceConfigurationLimitsPerLabelSetList No description.
timeouts PrometheusWorkspaceConfigurationTimeoutsOutputReference No description.
limits_per_label_set_input cdktn.IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSet] No description.
region_input str No description.
retention_period_in_days_input typing.Union[int, float] No description.
timeouts_input cdktn.IResolvable | PrometheusWorkspaceConfigurationTimeouts No description.
workspace_id_input str No description.
region str No description.
retention_period_in_days typing.Union[int, float] No description.
workspace_id str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktn.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: cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
limits_per_label_setRequired 
limits_per_label_set: PrometheusWorkspaceConfigurationLimitsPerLabelSetList
timeoutsRequired 
timeouts: PrometheusWorkspaceConfigurationTimeoutsOutputReference
limits_per_label_set_inputOptional 
limits_per_label_set_input: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSet]
region_inputOptional 
region_input: str
  • Type: str
retention_period_in_days_inputOptional 
retention_period_in_days_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
timeouts_inputOptional 
timeouts_input: IResolvable | PrometheusWorkspaceConfigurationTimeouts
workspace_id_inputOptional 
workspace_id_input: str
  • Type: str
regionRequired 
region: str
  • Type: str
retention_period_in_daysRequired 
retention_period_in_days: typing.Union[int, float]
  • Type: typing.Union[int, float]
workspace_idRequired 
workspace_id: str
  • Type: str

Constants

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

Structs

PrometheusWorkspaceConfigurationConfig

Initializer 

from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfigurationConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  workspace_id: str,
  limits_per_label_set: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSet] = None,
  region: str = None,
  retention_period_in_days: typing.Union[int, float] = None,
  timeouts: PrometheusWorkspaceConfigurationTimeouts = None
)

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
workspace_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#workspace_id PrometheusWorkspaceConfiguration#workspace_id}.
limits_per_label_set cdktn.IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSet] limits_per_label_set block.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
retention_period_in_days typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#retention_period_in_days PrometheusWorkspaceConfiguration#retention_period_in_days}.
timeouts PrometheusWorkspaceConfigurationTimeouts timeouts block.
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
workspace_idRequired 
workspace_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#workspace_id PrometheusWorkspaceConfiguration#workspace_id}.

limits_per_label_setOptional 
limits_per_label_set: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSet]

limits_per_label_set block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#limits_per_label_set PrometheusWorkspaceConfiguration#limits_per_label_set}

regionOptional 
region: str
  • Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#region PrometheusWorkspaceConfiguration#region}

retention_period_in_daysOptional 
retention_period_in_days: typing.Union[int, float]
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#retention_period_in_days PrometheusWorkspaceConfiguration#retention_period_in_days}.

timeoutsOptional 
timeouts: PrometheusWorkspaceConfigurationTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#timeouts PrometheusWorkspaceConfiguration#timeouts}

PrometheusWorkspaceConfigurationLimitsPerLabelSet

Initializer 

from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfigurationLimitsPerLabelSet(
  label_set: typing.Mapping[str],
  limits: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits] = None
)

Properties

Name Type Description
label_set typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#label_set PrometheusWorkspaceConfiguration#label_set}.
limits cdktn.IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits] limits block.
label_setRequired 
label_set: typing.Mapping[str]
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#label_set PrometheusWorkspaceConfiguration#label_set}.

limitsOptional 
limits: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits]

limits block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#limits PrometheusWorkspaceConfiguration#limits}

PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits

Initializer 

from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits(
  max_series: typing.Union[int, float]
)

Properties

Name Type Description
max_series typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#max_series PrometheusWorkspaceConfiguration#max_series}.
max_seriesRequired 
max_series: typing.Union[int, float]
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#max_series PrometheusWorkspaceConfiguration#max_series}.

PrometheusWorkspaceConfigurationTimeouts

Initializer 

from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfigurationTimeouts(
  create: str = None,
  update: str = None
)

Properties

Name Type Description
create str A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
update str A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
createOptional 
create: str
  • Type: str

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#create PrometheusWorkspaceConfiguration#create}

updateOptional 
update: str
  • Type: str

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/prometheus_workspace_configuration#update PrometheusWorkspaceConfiguration#update}

Classes

PrometheusWorkspaceConfigurationLimitsPerLabelSetLimitsList

Initializers 

from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfigurationLimitsPerLabelSetLimitsList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktn.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: cdktn.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: cdktn.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]
) -> PrometheusWorkspaceConfigurationLimitsPerLabelSetLimitsOutputReference
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 cdktn.IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits] 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: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits]

PrometheusWorkspaceConfigurationLimitsPerLabelSetLimitsOutputReference

Initializers 

from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfigurationLimitsPerLabelSetLimitsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktn.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: cdktn.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: cdktn.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.
max_series_input typing.Union[int, float] No description.
max_series typing.Union[int, float] No description.
internal_value cdktn.IResolvable | PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits 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
max_series_inputOptional 
max_series_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
max_seriesRequired 
max_series: typing.Union[int, float]
  • Type: typing.Union[int, float]
internal_valueOptional 
internal_value: IResolvable | PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits

PrometheusWorkspaceConfigurationLimitsPerLabelSetList

Initializers 

from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfigurationLimitsPerLabelSetList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktn.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: cdktn.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: cdktn.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]
) -> PrometheusWorkspaceConfigurationLimitsPerLabelSetOutputReference
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 cdktn.IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSet] 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: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSet]

PrometheusWorkspaceConfigurationLimitsPerLabelSetOutputReference

Initializers 

from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfigurationLimitsPerLabelSetOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktn.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: cdktn.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_limits No description.
reset_limits 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: cdktn.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_limits 
def put_limits(
  value: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits]
) -> None
valueRequired
reset_limits 
def reset_limits() -> 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.
limits PrometheusWorkspaceConfigurationLimitsPerLabelSetLimitsList No description.
label_set_input typing.Mapping[str] No description.
limits_input cdktn.IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits] No description.
label_set typing.Mapping[str] No description.
internal_value cdktn.IResolvable | PrometheusWorkspaceConfigurationLimitsPerLabelSet 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
limitsRequired 
limits: PrometheusWorkspaceConfigurationLimitsPerLabelSetLimitsList
label_set_inputOptional 
label_set_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
limits_inputOptional 
limits_input: IResolvable | typing.List[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits]
label_setRequired 
label_set: typing.Mapping[str]
  • Type: typing.Mapping[str]
internal_valueOptional 
internal_value: IResolvable | PrometheusWorkspaceConfigurationLimitsPerLabelSet

PrometheusWorkspaceConfigurationTimeoutsOutputReference

Initializers 

from cdktn_provider_aws import prometheus_workspace_configuration

prometheusWorkspaceConfiguration.PrometheusWorkspaceConfigurationTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktn.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktn.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_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: cdktn.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_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.
update_input str No description.
create str No description.
update str No description.
internal_value cdktn.IResolvable | PrometheusWorkspaceConfigurationTimeouts 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
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: IResolvable | PrometheusWorkspaceConfigurationTimeouts