Skip to content

connectInstance.python.md

Latest commit

 

History

History
2129 lines (1361 loc) · 93.8 KB

connectInstance.python.md

File metadata and controls

2129 lines (1361 loc) · 93.8 KB

connectInstance Submodule

Constructs

ConnectInstance

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

Initializers 

from cdktn_provider_aws import connect_instance

connectInstance.ConnectInstance(
  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,
  identity_management_type: str,
  inbound_calls_enabled: bool | IResolvable,
  outbound_calls_enabled: bool | IResolvable,
  auto_resolve_best_voices_enabled: bool | IResolvable = None,
  contact_flow_logs_enabled: bool | IResolvable = None,
  contact_lens_enabled: bool | IResolvable = None,
  directory_id: str = None,
  early_media_enabled: bool | IResolvable = None,
  id: str = None,
  instance_alias: str = None,
  multi_party_conference_enabled: bool | IResolvable = None,
  region: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  timeouts: ConnectInstanceTimeouts = 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.
identity_management_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#identity_management_type ConnectInstance#identity_management_type}.
inbound_calls_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#inbound_calls_enabled ConnectInstance#inbound_calls_enabled}.
outbound_calls_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#outbound_calls_enabled ConnectInstance#outbound_calls_enabled}.
auto_resolve_best_voices_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#auto_resolve_best_voices_enabled ConnectInstance#auto_resolve_best_voices_enabled}.
contact_flow_logs_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#contact_flow_logs_enabled ConnectInstance#contact_flow_logs_enabled}.
contact_lens_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#contact_lens_enabled ConnectInstance#contact_lens_enabled}.
directory_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#directory_id ConnectInstance#directory_id}.
early_media_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#early_media_enabled ConnectInstance#early_media_enabled}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#id ConnectInstance#id}.
instance_alias str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#instance_alias ConnectInstance#instance_alias}.
multi_party_conference_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#multi_party_conference_enabled ConnectInstance#multi_party_conference_enabled}.
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/connect_instance#tags ConnectInstance#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#tags_all ConnectInstance#tags_all}.
timeouts ConnectInstanceTimeouts 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]
identity_management_typeRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#identity_management_type ConnectInstance#identity_management_type}.

inbound_calls_enabledRequired
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#inbound_calls_enabled ConnectInstance#inbound_calls_enabled}.

outbound_calls_enabledRequired
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#outbound_calls_enabled ConnectInstance#outbound_calls_enabled}.

auto_resolve_best_voices_enabledOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#auto_resolve_best_voices_enabled ConnectInstance#auto_resolve_best_voices_enabled}.

contact_flow_logs_enabledOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#contact_flow_logs_enabled ConnectInstance#contact_flow_logs_enabled}.

contact_lens_enabledOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#contact_lens_enabled ConnectInstance#contact_lens_enabled}.

directory_idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#directory_id ConnectInstance#directory_id}.

early_media_enabledOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#early_media_enabled ConnectInstance#early_media_enabled}.

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#id ConnectInstance#id}.

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

instance_aliasOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#instance_alias ConnectInstance#instance_alias}.

multi_party_conference_enabledOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#multi_party_conference_enabled ConnectInstance#multi_party_conference_enabled}.

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/connect_instance#region ConnectInstance#region}

tagsOptional
  • Type: typing.Mapping[str]

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

tags_allOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#tags_all ConnectInstance#tags_all}.

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#timeouts ConnectInstance#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_auto_resolve_best_voices_enabled No description.
reset_contact_flow_logs_enabled No description.
reset_contact_lens_enabled No description.
reset_directory_id No description.
reset_early_media_enabled No description.
reset_id No description.
reset_instance_alias No description.
reset_multi_party_conference_enabled No description.
reset_region No description.
reset_tags No description.
reset_tags_all 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
) -> None
createOptional
  • Type: str

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

deleteOptional
  • Type: str

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

reset_auto_resolve_best_voices_enabled 
def reset_auto_resolve_best_voices_enabled() -> None
reset_contact_flow_logs_enabled 
def reset_contact_flow_logs_enabled() -> None
reset_contact_lens_enabled 
def reset_contact_lens_enabled() -> None
reset_directory_id 
def reset_directory_id() -> None
reset_early_media_enabled 
def reset_early_media_enabled() -> None
reset_id 
def reset_id() -> None
reset_instance_alias 
def reset_instance_alias() -> None
reset_multi_party_conference_enabled 
def reset_multi_party_conference_enabled() -> None
reset_region 
def reset_region() -> None
reset_tags 
def reset_tags() -> None
reset_tags_all 
def reset_tags_all() -> 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 ConnectInstance resource upon running "cdktn plan ".
is_construct 
from cdktn_provider_aws import connect_instance

connectInstance.ConnectInstance.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 connect_instance

connectInstance.ConnectInstance.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktn_provider_aws import connect_instance

connectInstance.ConnectInstance.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktn_provider_aws import connect_instance

connectInstance.ConnectInstance.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

import_from_idRequired
  • Type: str

The id of the existing ConnectInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#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 ConnectInstance 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.
arn str No description.
created_time str No description.
service_role str No description.
status str No description.
timeouts ConnectInstanceTimeoutsOutputReference No description.
auto_resolve_best_voices_enabled_input bool | cdktn.IResolvable No description.
contact_flow_logs_enabled_input bool | cdktn.IResolvable No description.
contact_lens_enabled_input bool | cdktn.IResolvable No description.
directory_id_input str No description.
early_media_enabled_input bool | cdktn.IResolvable No description.
identity_management_type_input str No description.
id_input str No description.
inbound_calls_enabled_input bool | cdktn.IResolvable No description.
instance_alias_input str No description.
multi_party_conference_enabled_input bool | cdktn.IResolvable No description.
outbound_calls_enabled_input bool | cdktn.IResolvable No description.
region_input str No description.
tags_all_input typing.Mapping[str] No description.
tags_input typing.Mapping[str] No description.
timeouts_input cdktn.IResolvable | ConnectInstanceTimeouts No description.
auto_resolve_best_voices_enabled bool | cdktn.IResolvable No description.
contact_flow_logs_enabled bool | cdktn.IResolvable No description.
contact_lens_enabled bool | cdktn.IResolvable No description.
directory_id str No description.
early_media_enabled bool | cdktn.IResolvable No description.
id str No description.
identity_management_type str No description.
inbound_calls_enabled bool | cdktn.IResolvable No description.
instance_alias str No description.
multi_party_conference_enabled bool | cdktn.IResolvable No description.
outbound_calls_enabled bool | cdktn.IResolvable No description.
region str No description.
tags typing.Mapping[str] No description.
tags_all 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]
arnRequired 
arn: str
  • Type: str
created_timeRequired 
created_time: str
  • Type: str
service_roleRequired 
service_role: str
  • Type: str
statusRequired 
status: str
  • Type: str
timeoutsRequired 
timeouts: ConnectInstanceTimeoutsOutputReference
auto_resolve_best_voices_enabled_inputOptional 
auto_resolve_best_voices_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
contact_flow_logs_enabled_inputOptional 
contact_flow_logs_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
contact_lens_enabled_inputOptional 
contact_lens_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
directory_id_inputOptional 
directory_id_input: str
  • Type: str
early_media_enabled_inputOptional 
early_media_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
identity_management_type_inputOptional 
identity_management_type_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
inbound_calls_enabled_inputOptional 
inbound_calls_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
instance_alias_inputOptional 
instance_alias_input: str
  • Type: str
multi_party_conference_enabled_inputOptional 
multi_party_conference_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
outbound_calls_enabled_inputOptional 
outbound_calls_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
region_inputOptional 
region_input: str
  • Type: str
tags_all_inputOptional 
tags_all_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
tags_inputOptional 
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
timeouts_inputOptional 
timeouts_input: IResolvable | ConnectInstanceTimeouts
auto_resolve_best_voices_enabledRequired 
auto_resolve_best_voices_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable
contact_flow_logs_enabledRequired 
contact_flow_logs_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable
contact_lens_enabledRequired 
contact_lens_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable
directory_idRequired 
directory_id: str
  • Type: str
early_media_enabledRequired 
early_media_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable
idRequired 
id: str
  • Type: str
identity_management_typeRequired 
identity_management_type: str
  • Type: str
inbound_calls_enabledRequired 
inbound_calls_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable
instance_aliasRequired 
instance_alias: str
  • Type: str
multi_party_conference_enabledRequired 
multi_party_conference_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable
outbound_calls_enabledRequired 
outbound_calls_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable
regionRequired 
region: str
  • Type: str
tagsRequired 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]
tags_allRequired 
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

Constants

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

Structs

ConnectInstanceConfig

Initializer 

from cdktn_provider_aws import connect_instance

connectInstance.ConnectInstanceConfig(
  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,
  identity_management_type: str,
  inbound_calls_enabled: bool | IResolvable,
  outbound_calls_enabled: bool | IResolvable,
  auto_resolve_best_voices_enabled: bool | IResolvable = None,
  contact_flow_logs_enabled: bool | IResolvable = None,
  contact_lens_enabled: bool | IResolvable = None,
  directory_id: str = None,
  early_media_enabled: bool | IResolvable = None,
  id: str = None,
  instance_alias: str = None,
  multi_party_conference_enabled: bool | IResolvable = None,
  region: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  timeouts: ConnectInstanceTimeouts = 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.
identity_management_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#identity_management_type ConnectInstance#identity_management_type}.
inbound_calls_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#inbound_calls_enabled ConnectInstance#inbound_calls_enabled}.
outbound_calls_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#outbound_calls_enabled ConnectInstance#outbound_calls_enabled}.
auto_resolve_best_voices_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#auto_resolve_best_voices_enabled ConnectInstance#auto_resolve_best_voices_enabled}.
contact_flow_logs_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#contact_flow_logs_enabled ConnectInstance#contact_flow_logs_enabled}.
contact_lens_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#contact_lens_enabled ConnectInstance#contact_lens_enabled}.
directory_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#directory_id ConnectInstance#directory_id}.
early_media_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#early_media_enabled ConnectInstance#early_media_enabled}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#id ConnectInstance#id}.
instance_alias str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#instance_alias ConnectInstance#instance_alias}.
multi_party_conference_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#multi_party_conference_enabled ConnectInstance#multi_party_conference_enabled}.
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/connect_instance#tags ConnectInstance#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#tags_all ConnectInstance#tags_all}.
timeouts ConnectInstanceTimeouts 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]
identity_management_typeRequired 
identity_management_type: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#identity_management_type ConnectInstance#identity_management_type}.

inbound_calls_enabledRequired 
inbound_calls_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#inbound_calls_enabled ConnectInstance#inbound_calls_enabled}.

outbound_calls_enabledRequired 
outbound_calls_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#outbound_calls_enabled ConnectInstance#outbound_calls_enabled}.

auto_resolve_best_voices_enabledOptional 
auto_resolve_best_voices_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#auto_resolve_best_voices_enabled ConnectInstance#auto_resolve_best_voices_enabled}.

contact_flow_logs_enabledOptional 
contact_flow_logs_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#contact_flow_logs_enabled ConnectInstance#contact_flow_logs_enabled}.

contact_lens_enabledOptional 
contact_lens_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#contact_lens_enabled ConnectInstance#contact_lens_enabled}.

directory_idOptional 
directory_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#directory_id ConnectInstance#directory_id}.

early_media_enabledOptional 
early_media_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#early_media_enabled ConnectInstance#early_media_enabled}.

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#id ConnectInstance#id}.

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

instance_aliasOptional 
instance_alias: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#instance_alias ConnectInstance#instance_alias}.

multi_party_conference_enabledOptional 
multi_party_conference_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#multi_party_conference_enabled ConnectInstance#multi_party_conference_enabled}.

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/connect_instance#region ConnectInstance#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/connect_instance#tags ConnectInstance#tags}.

tags_allOptional 
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#tags_all ConnectInstance#tags_all}.

timeoutsOptional 
timeouts: ConnectInstanceTimeouts

timeouts block.

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

ConnectInstanceTimeouts

Initializer 

from cdktn_provider_aws import connect_instance

connectInstance.ConnectInstanceTimeouts(
  create: str = None,
  delete: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#create ConnectInstance#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/connect_instance#delete ConnectInstance#delete}.
createOptional 
create: str
  • Type: str

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

deleteOptional 
delete: str
  • Type: str

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

Classes

ConnectInstanceTimeoutsOutputReference

Initializers 

from cdktn_provider_aws import connect_instance

connectInstance.ConnectInstanceTimeoutsOutputReference(
  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.
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

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.
create str No description.
delete str No description.
internal_value cdktn.IResolvable | ConnectInstanceTimeouts 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
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
internal_valueOptional 
internal_value: IResolvable | ConnectInstanceTimeouts