Skip to content

Latest commit

 

History

History
2064 lines (1318 loc) · 91.2 KB

File metadata and controls

2064 lines (1318 loc) · 91.2 KB

workspaceswebPortal Submodule

Constructs

WorkspaceswebPortal

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

Initializers

from cdktn_provider_aws import workspacesweb_portal

workspaceswebPortal.WorkspaceswebPortal(
  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,
  additional_encryption_context: typing.Mapping[str] = None,
  authentication_type: str = None,
  browser_settings_arn: str = None,
  customer_managed_key: str = None,
  display_name: str = None,
  instance_type: str = None,
  max_concurrent_sessions: typing.Union[int, float] = None,
  region: str = None,
  tags: typing.Mapping[str] = None,
  timeouts: WorkspaceswebPortalTimeouts = 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.
additional_encryption_context typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#additional_encryption_context WorkspaceswebPortal#additional_encryption_context}.
authentication_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#authentication_type WorkspaceswebPortal#authentication_type}.
browser_settings_arn str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#browser_settings_arn WorkspaceswebPortal#browser_settings_arn}.
customer_managed_key str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#customer_managed_key WorkspaceswebPortal#customer_managed_key}.
display_name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#display_name WorkspaceswebPortal#display_name}.
instance_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#instance_type WorkspaceswebPortal#instance_type}.
max_concurrent_sessions typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#max_concurrent_sessions WorkspaceswebPortal#max_concurrent_sessions}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#tags WorkspaceswebPortal#tags}.
timeouts WorkspaceswebPortalTimeouts 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]

additional_encryption_contextOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#additional_encryption_context WorkspaceswebPortal#additional_encryption_context}.


authentication_typeOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#authentication_type WorkspaceswebPortal#authentication_type}.


browser_settings_arnOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#browser_settings_arn WorkspaceswebPortal#browser_settings_arn}.


customer_managed_keyOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#customer_managed_key WorkspaceswebPortal#customer_managed_key}.


display_nameOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#display_name WorkspaceswebPortal#display_name}.


instance_typeOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#instance_type WorkspaceswebPortal#instance_type}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#max_concurrent_sessions WorkspaceswebPortal#max_concurrent_sessions}.


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/workspacesweb_portal#region WorkspaceswebPortal#region}


tagsOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#tags WorkspaceswebPortal#tags}.


timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#timeouts WorkspaceswebPortal#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_timeouts No description.
reset_additional_encryption_context No description.
reset_authentication_type No description.
reset_browser_settings_arn No description.
reset_customer_managed_key No description.
reset_display_name No description.
reset_instance_type No description.
reset_max_concurrent_sessions No description.
reset_region No description.
reset_tags 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_timeouts
def put_timeouts(
  create: str = None,
  delete: 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/workspacesweb_portal#create WorkspaceswebPortal#create}


deleteOptional
  • 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#delete WorkspaceswebPortal#delete}


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/workspacesweb_portal#update WorkspaceswebPortal#update}


reset_additional_encryption_context
def reset_additional_encryption_context() -> None
reset_authentication_type
def reset_authentication_type() -> None
reset_browser_settings_arn
def reset_browser_settings_arn() -> None
reset_customer_managed_key
def reset_customer_managed_key() -> None
reset_display_name
def reset_display_name() -> None
reset_instance_type
def reset_instance_type() -> None
reset_max_concurrent_sessions
def reset_max_concurrent_sessions() -> None
reset_region
def reset_region() -> None
reset_tags
def reset_tags() -> None
reset_timeouts
def reset_timeouts() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTN code for importing a WorkspaceswebPortal resource upon running "cdktn plan ".

is_construct
from cdktn_provider_aws import workspacesweb_portal

workspaceswebPortal.WorkspaceswebPortal.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 workspacesweb_portal

workspaceswebPortal.WorkspaceswebPortal.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_resource
from cdktn_provider_aws import workspacesweb_portal

workspaceswebPortal.WorkspaceswebPortal.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktn_provider_aws import workspacesweb_portal

workspaceswebPortal.WorkspaceswebPortal.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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


import_from_idRequired
  • Type: str

The id of the existing WorkspaceswebPortal that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#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 WorkspaceswebPortal 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.
browser_type str No description.
creation_date str No description.
data_protection_settings_arn str No description.
ip_access_settings_arn str No description.
network_settings_arn str No description.
portal_arn str No description.
portal_endpoint str No description.
portal_status str No description.
renderer_type str No description.
session_logger_arn str No description.
status_reason str No description.
tags_all cdktn.StringMap No description.
timeouts WorkspaceswebPortalTimeoutsOutputReference No description.
trust_store_arn str No description.
user_access_logging_settings_arn str No description.
user_settings_arn str No description.
additional_encryption_context_input typing.Mapping[str] No description.
authentication_type_input str No description.
browser_settings_arn_input str No description.
customer_managed_key_input str No description.
display_name_input str No description.
instance_type_input str No description.
max_concurrent_sessions_input typing.Union[int, float] No description.
region_input str No description.
tags_input typing.Mapping[str] No description.
timeouts_input cdktn.IResolvable | WorkspaceswebPortalTimeouts No description.
additional_encryption_context typing.Mapping[str] No description.
authentication_type str No description.
browser_settings_arn str No description.
customer_managed_key str No description.
display_name str No description.
instance_type str No description.
max_concurrent_sessions typing.Union[int, float] No description.
region str No description.
tags typing.Mapping[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]

browser_typeRequired
browser_type: str
  • Type: str

creation_dateRequired
creation_date: str
  • Type: str

data_protection_settings_arnRequired
data_protection_settings_arn: str
  • Type: str

ip_access_settings_arnRequired
ip_access_settings_arn: str
  • Type: str

network_settings_arnRequired
network_settings_arn: str
  • Type: str

portal_arnRequired
portal_arn: str
  • Type: str

portal_endpointRequired
portal_endpoint: str
  • Type: str

portal_statusRequired
portal_status: str
  • Type: str

renderer_typeRequired
renderer_type: str
  • Type: str

session_logger_arnRequired
session_logger_arn: str
  • Type: str

status_reasonRequired
status_reason: str
  • Type: str

tags_allRequired
tags_all: StringMap
  • Type: cdktn.StringMap

timeoutsRequired
timeouts: WorkspaceswebPortalTimeoutsOutputReference

trust_store_arnRequired
trust_store_arn: str
  • Type: str

user_access_logging_settings_arnRequired
user_access_logging_settings_arn: str
  • Type: str

user_settings_arnRequired
user_settings_arn: str
  • Type: str

additional_encryption_context_inputOptional
additional_encryption_context_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

authentication_type_inputOptional
authentication_type_input: str
  • Type: str

browser_settings_arn_inputOptional
browser_settings_arn_input: str
  • Type: str

customer_managed_key_inputOptional
customer_managed_key_input: str
  • Type: str

display_name_inputOptional
display_name_input: str
  • Type: str

instance_type_inputOptional
instance_type_input: str
  • Type: str

max_concurrent_sessions_inputOptional
max_concurrent_sessions_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

region_inputOptional
region_input: str
  • Type: str

tags_inputOptional
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

timeouts_inputOptional
timeouts_input: IResolvable | WorkspaceswebPortalTimeouts

additional_encryption_contextRequired
additional_encryption_context: typing.Mapping[str]
  • Type: typing.Mapping[str]

authentication_typeRequired
authentication_type: str
  • Type: str

browser_settings_arnRequired
browser_settings_arn: str
  • Type: str

customer_managed_keyRequired
customer_managed_key: str
  • Type: str

display_nameRequired
display_name: str
  • Type: str

instance_typeRequired
instance_type: str
  • Type: str

max_concurrent_sessionsRequired
max_concurrent_sessions: typing.Union[int, float]
  • Type: typing.Union[int, float]

regionRequired
region: str
  • Type: str

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

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

WorkspaceswebPortalConfig

Initializer

from cdktn_provider_aws import workspacesweb_portal

workspaceswebPortal.WorkspaceswebPortalConfig(
  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,
  additional_encryption_context: typing.Mapping[str] = None,
  authentication_type: str = None,
  browser_settings_arn: str = None,
  customer_managed_key: str = None,
  display_name: str = None,
  instance_type: str = None,
  max_concurrent_sessions: typing.Union[int, float] = None,
  region: str = None,
  tags: typing.Mapping[str] = None,
  timeouts: WorkspaceswebPortalTimeouts = 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.
additional_encryption_context typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#additional_encryption_context WorkspaceswebPortal#additional_encryption_context}.
authentication_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#authentication_type WorkspaceswebPortal#authentication_type}.
browser_settings_arn str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#browser_settings_arn WorkspaceswebPortal#browser_settings_arn}.
customer_managed_key str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#customer_managed_key WorkspaceswebPortal#customer_managed_key}.
display_name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#display_name WorkspaceswebPortal#display_name}.
instance_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#instance_type WorkspaceswebPortal#instance_type}.
max_concurrent_sessions typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#max_concurrent_sessions WorkspaceswebPortal#max_concurrent_sessions}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#tags WorkspaceswebPortal#tags}.
timeouts WorkspaceswebPortalTimeouts 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]

additional_encryption_contextOptional
additional_encryption_context: typing.Mapping[str]
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#additional_encryption_context WorkspaceswebPortal#additional_encryption_context}.


authentication_typeOptional
authentication_type: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#authentication_type WorkspaceswebPortal#authentication_type}.


browser_settings_arnOptional
browser_settings_arn: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#browser_settings_arn WorkspaceswebPortal#browser_settings_arn}.


customer_managed_keyOptional
customer_managed_key: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#customer_managed_key WorkspaceswebPortal#customer_managed_key}.


display_nameOptional
display_name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#display_name WorkspaceswebPortal#display_name}.


instance_typeOptional
instance_type: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#instance_type WorkspaceswebPortal#instance_type}.


max_concurrent_sessionsOptional
max_concurrent_sessions: 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/workspacesweb_portal#max_concurrent_sessions WorkspaceswebPortal#max_concurrent_sessions}.


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/workspacesweb_portal#region WorkspaceswebPortal#region}


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#tags WorkspaceswebPortal#tags}.


timeoutsOptional
timeouts: WorkspaceswebPortalTimeouts

timeouts block.

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


WorkspaceswebPortalTimeouts

Initializer

from cdktn_provider_aws import workspacesweb_portal

workspaceswebPortal.WorkspaceswebPortalTimeouts(
  create: str = None,
  delete: 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).
delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
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/workspacesweb_portal#create WorkspaceswebPortal#create}


deleteOptional
delete: 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/workspacesweb_portal#delete WorkspaceswebPortal#delete}


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/workspacesweb_portal#update WorkspaceswebPortal#update}


Classes

WorkspaceswebPortalTimeoutsOutputReference

Initializers

from cdktn_provider_aws import workspacesweb_portal

workspaceswebPortal.WorkspaceswebPortalTimeoutsOutputReference(
  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_delete 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_delete
def reset_delete() -> 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.
update_input str No description.
create str No description.
delete str No description.
update str No description.
internal_value cdktn.IResolvable | WorkspaceswebPortalTimeouts 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

update_inputOptional
update_input: str
  • Type: str

createRequired
create: str
  • Type: str

deleteRequired
delete: str
  • Type: str

updateRequired
update: str
  • Type: str

internal_valueOptional
internal_value: IResolvable | WorkspaceswebPortalTimeouts