Skip to content

Latest commit

 

History

History
2953 lines (1875 loc) · 128 KB

appSharedCredentials.python.md

File metadata and controls

2953 lines (1875 loc) · 128 KB
Raw

appSharedCredentials Submodule

Constructs

AppSharedCredentials

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials okta_app_shared_credentials}.

Initializers 

from cdktf_cdktf_provider_okta import app_shared_credentials

appSharedCredentials.AppSharedCredentials(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  label: str,
  accessibility_error_redirect_url: str = None,
  accessibility_login_redirect_url: str = None,
  accessibility_self_service: typing.Union[bool, IResolvable] = None,
  admin_note: str = None,
  app_links_json: str = None,
  auto_submit_toolbar: typing.Union[bool, IResolvable] = None,
  button_field: str = None,
  checkbox: str = None,
  enduser_note: str = None,
  hide_ios: typing.Union[bool, IResolvable] = None,
  hide_web: typing.Union[bool, IResolvable] = None,
  id: str = None,
  logo: str = None,
  password_field: str = None,
  preconfigured_app: str = None,
  redirect_url: str = None,
  shared_password: str = None,
  shared_username: str = None,
  status: str = None,
  timeouts: AppSharedCredentialsTimeouts = None,
  url: str = None,
  url_regex: str = None,
  username_field: str = None,
  user_name_template: str = None,
  user_name_template_push_status: str = None,
  user_name_template_suffix: str = None,
  user_name_template_type: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
label str The Application's display name.
accessibility_error_redirect_url str Custom error page URL.
accessibility_login_redirect_url str Custom login page URL.
accessibility_self_service typing.Union[bool, cdktf.IResolvable] Enable self service. Default is false.
admin_note str Application notes for admins.
app_links_json str Displays specific appLinks for the app. The value for each application link should be boolean.
auto_submit_toolbar typing.Union[bool, cdktf.IResolvable] Display auto submit toolbar.
button_field str Login button field.
checkbox str CSS selector for the checkbox.
enduser_note str Application notes for end users.
hide_ios typing.Union[bool, cdktf.IResolvable] Do not display application icon on mobile app.
hide_web typing.Union[bool, cdktf.IResolvable] Do not display application icon to users.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#id AppSharedCredentials#id}.
logo str Local file path to the logo.
password_field str Login password field.
preconfigured_app str Name of application from the Okta Integration Network, if not included a custom app will be created.
redirect_url str Secondary URL of the sign-in page for this app.
shared_password str Shared password, required for certain schemes.
shared_username str Shared username, required for certain schemes.
status str Status of application. By default, it is ACTIVE.
timeouts AppSharedCredentialsTimeouts timeouts block.
url str The URL of the sign-in page for this app.
url_regex str A regular expression that further restricts url to the specified regular expression.
username_field str Login username field.
user_name_template str Username template. Default: ${source.login}.
user_name_template_push_status str Push username on update. Valid values: PUSH and DONT_PUSH.
user_name_template_suffix str Username template suffix.
user_name_template_type str Username template type. Default: BUILT_IN.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

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

The Application's display name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#label AppSharedCredentials#label}

accessibility_error_redirect_urlOptional
  • Type: str

Custom error page URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#accessibility_error_redirect_url AppSharedCredentials#accessibility_error_redirect_url}

accessibility_login_redirect_urlOptional
  • Type: str

Custom login page URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#accessibility_login_redirect_url AppSharedCredentials#accessibility_login_redirect_url}

accessibility_self_serviceOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Enable self service. Default is false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#accessibility_self_service AppSharedCredentials#accessibility_self_service}

admin_noteOptional
  • Type: str

Application notes for admins.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#admin_note AppSharedCredentials#admin_note}

app_links_jsonOptional
  • Type: str

Displays specific appLinks for the app. The value for each application link should be boolean.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#app_links_json AppSharedCredentials#app_links_json}

auto_submit_toolbarOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Display auto submit toolbar.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#auto_submit_toolbar AppSharedCredentials#auto_submit_toolbar}

button_fieldOptional
  • Type: str

Login button field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#button_field AppSharedCredentials#button_field}

checkboxOptional
  • Type: str

CSS selector for the checkbox.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#checkbox AppSharedCredentials#checkbox}

enduser_noteOptional
  • Type: str

Application notes for end users.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#enduser_note AppSharedCredentials#enduser_note}

hide_iosOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Do not display application icon on mobile app.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#hide_ios AppSharedCredentials#hide_ios}

hide_webOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Do not display application icon to users.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#hide_web AppSharedCredentials#hide_web}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#id AppSharedCredentials#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.

logoOptional
  • Type: str

Local file path to the logo.

The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#logo AppSharedCredentials#logo}

password_fieldOptional
  • Type: str

Login password field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#password_field AppSharedCredentials#password_field}

preconfigured_appOptional
  • Type: str

Name of application from the Okta Integration Network, if not included a custom app will be created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#preconfigured_app AppSharedCredentials#preconfigured_app}

redirect_urlOptional
  • Type: str

Secondary URL of the sign-in page for this app.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#redirect_url AppSharedCredentials#redirect_url}

shared_passwordOptional
  • Type: str

Shared password, required for certain schemes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#shared_password AppSharedCredentials#shared_password}

shared_usernameOptional
  • Type: str

Shared username, required for certain schemes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#shared_username AppSharedCredentials#shared_username}

statusOptional
  • Type: str

Status of application. By default, it is ACTIVE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#status AppSharedCredentials#status}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#timeouts AppSharedCredentials#timeouts}

urlOptional
  • Type: str

The URL of the sign-in page for this app.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#url AppSharedCredentials#url}

url_regexOptional
  • Type: str

A regular expression that further restricts url to the specified regular expression.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#url_regex AppSharedCredentials#url_regex}

username_fieldOptional
  • Type: str

Login username field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#username_field AppSharedCredentials#username_field}

user_name_templateOptional
  • Type: str

Username template. Default: ${source.login}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#user_name_template AppSharedCredentials#user_name_template}

user_name_template_push_statusOptional
  • Type: str

Push username on update. Valid values: PUSH and DONT_PUSH.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#user_name_template_push_status AppSharedCredentials#user_name_template_push_status}

user_name_template_suffixOptional
  • Type: str

Username template suffix.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#user_name_template_suffix AppSharedCredentials#user_name_template_suffix}

user_name_template_typeOptional
  • Type: str

Username template type. Default: BUILT_IN.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#user_name_template_type AppSharedCredentials#user_name_template_type}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_timeouts No description.
reset_accessibility_error_redirect_url No description.
reset_accessibility_login_redirect_url No description.
reset_accessibility_self_service No description.
reset_admin_note No description.
reset_app_links_json No description.
reset_auto_submit_toolbar No description.
reset_button_field No description.
reset_checkbox No description.
reset_enduser_note No description.
reset_hide_ios No description.
reset_hide_web No description.
reset_id No description.
reset_logo No description.
reset_password_field No description.
reset_preconfigured_app No description.
reset_redirect_url No description.
reset_shared_password No description.
reset_shared_username No description.
reset_status No description.
reset_timeouts No description.
reset_url No description.
reset_url_regex No description.
reset_username_field No description.
reset_user_name_template No description.
reset_user_name_template_push_status No description.
reset_user_name_template_suffix No description.
reset_user_name_template_type No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_timeouts 
def put_timeouts(
  create: str = None,
  read: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#create AppSharedCredentials#create}.

readOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#read AppSharedCredentials#read}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#update AppSharedCredentials#update}.

reset_accessibility_error_redirect_url 
def reset_accessibility_error_redirect_url() -> None
reset_accessibility_login_redirect_url 
def reset_accessibility_login_redirect_url() -> None
reset_accessibility_self_service 
def reset_accessibility_self_service() -> None
reset_admin_note 
def reset_admin_note() -> None
reset_app_links_json 
def reset_app_links_json() -> None
reset_auto_submit_toolbar 
def reset_auto_submit_toolbar() -> None
reset_button_field 
def reset_button_field() -> None
reset_checkbox 
def reset_checkbox() -> None
reset_enduser_note 
def reset_enduser_note() -> None
reset_hide_ios 
def reset_hide_ios() -> None
reset_hide_web 
def reset_hide_web() -> None
reset_id 
def reset_id() -> None
reset_logo 
def reset_logo() -> None
reset_password_field 
def reset_password_field() -> None
reset_preconfigured_app 
def reset_preconfigured_app() -> None
reset_redirect_url 
def reset_redirect_url() -> None
reset_shared_password 
def reset_shared_password() -> None
reset_shared_username 
def reset_shared_username() -> None
reset_status 
def reset_status() -> None
reset_timeouts 
def reset_timeouts() -> None
reset_url 
def reset_url() -> None
reset_url_regex 
def reset_url_regex() -> None
reset_username_field 
def reset_username_field() -> None
reset_user_name_template 
def reset_user_name_template() -> None
reset_user_name_template_push_status 
def reset_user_name_template_push_status() -> None
reset_user_name_template_suffix 
def reset_user_name_template_suffix() -> None
reset_user_name_template_type 
def reset_user_name_template_type() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a AppSharedCredentials resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_okta import app_shared_credentials

appSharedCredentials.AppSharedCredentials.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_okta import app_shared_credentials

appSharedCredentials.AppSharedCredentials.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_okta import app_shared_credentials

appSharedCredentials.AppSharedCredentials.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_okta import app_shared_credentials

appSharedCredentials.AppSharedCredentials.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a AppSharedCredentials resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the AppSharedCredentials to import.

import_from_idRequired
  • Type: str

The id of the existing AppSharedCredentials that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
logo_url str No description.
name str No description.
sign_on_mode str No description.
timeouts AppSharedCredentialsTimeoutsOutputReference No description.
accessibility_error_redirect_url_input str No description.
accessibility_login_redirect_url_input str No description.
accessibility_self_service_input typing.Union[bool, cdktf.IResolvable] No description.
admin_note_input str No description.
app_links_json_input str No description.
auto_submit_toolbar_input typing.Union[bool, cdktf.IResolvable] No description.
button_field_input str No description.
checkbox_input str No description.
enduser_note_input str No description.
hide_ios_input typing.Union[bool, cdktf.IResolvable] No description.
hide_web_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
label_input str No description.
logo_input str No description.
password_field_input str No description.
preconfigured_app_input str No description.
redirect_url_input str No description.
shared_password_input str No description.
shared_username_input str No description.
status_input str No description.
timeouts_input typing.Union[cdktf.IResolvable, AppSharedCredentialsTimeouts] No description.
url_input str No description.
url_regex_input str No description.
username_field_input str No description.
user_name_template_input str No description.
user_name_template_push_status_input str No description.
user_name_template_suffix_input str No description.
user_name_template_type_input str No description.
accessibility_error_redirect_url str No description.
accessibility_login_redirect_url str No description.
accessibility_self_service typing.Union[bool, cdktf.IResolvable] No description.
admin_note str No description.
app_links_json str No description.
auto_submit_toolbar typing.Union[bool, cdktf.IResolvable] No description.
button_field str No description.
checkbox str No description.
enduser_note str No description.
hide_ios typing.Union[bool, cdktf.IResolvable] No description.
hide_web typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
label str No description.
logo str No description.
password_field str No description.
preconfigured_app str No description.
redirect_url str No description.
shared_password str No description.
shared_username str No description.
status str No description.
url str No description.
url_regex str No description.
username_field str No description.
user_name_template str No description.
user_name_template_push_status str No description.
user_name_template_suffix str No description.
user_name_template_type str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
logo_urlRequired 
logo_url: str
  • Type: str
nameRequired 
name: str
  • Type: str
sign_on_modeRequired 
sign_on_mode: str
  • Type: str
timeoutsRequired 
timeouts: AppSharedCredentialsTimeoutsOutputReference
accessibility_error_redirect_url_inputOptional 
accessibility_error_redirect_url_input: str
  • Type: str
accessibility_login_redirect_url_inputOptional 
accessibility_login_redirect_url_input: str
  • Type: str
accessibility_self_service_inputOptional 
accessibility_self_service_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
admin_note_inputOptional 
admin_note_input: str
  • Type: str
app_links_json_inputOptional 
app_links_json_input: str
  • Type: str
auto_submit_toolbar_inputOptional 
auto_submit_toolbar_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
button_field_inputOptional 
button_field_input: str
  • Type: str
checkbox_inputOptional 
checkbox_input: str
  • Type: str
enduser_note_inputOptional 
enduser_note_input: str
  • Type: str
hide_ios_inputOptional 
hide_ios_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
hide_web_inputOptional 
hide_web_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
id_inputOptional 
id_input: str
  • Type: str
label_inputOptional 
label_input: str
  • Type: str
logo_inputOptional 
logo_input: str
  • Type: str
password_field_inputOptional 
password_field_input: str
  • Type: str
preconfigured_app_inputOptional 
preconfigured_app_input: str
  • Type: str
redirect_url_inputOptional 
redirect_url_input: str
  • Type: str
shared_password_inputOptional 
shared_password_input: str
  • Type: str
shared_username_inputOptional 
shared_username_input: str
  • Type: str
status_inputOptional 
status_input: str
  • Type: str
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, AppSharedCredentialsTimeouts]
url_inputOptional 
url_input: str
  • Type: str
url_regex_inputOptional 
url_regex_input: str
  • Type: str
username_field_inputOptional 
username_field_input: str
  • Type: str
user_name_template_inputOptional 
user_name_template_input: str
  • Type: str
user_name_template_push_status_inputOptional 
user_name_template_push_status_input: str
  • Type: str
user_name_template_suffix_inputOptional 
user_name_template_suffix_input: str
  • Type: str
user_name_template_type_inputOptional 
user_name_template_type_input: str
  • Type: str
accessibility_error_redirect_urlRequired 
accessibility_error_redirect_url: str
  • Type: str
accessibility_login_redirect_urlRequired 
accessibility_login_redirect_url: str
  • Type: str
accessibility_self_serviceRequired 
accessibility_self_service: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
admin_noteRequired 
admin_note: str
  • Type: str
app_links_jsonRequired 
app_links_json: str
  • Type: str
auto_submit_toolbarRequired 
auto_submit_toolbar: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
button_fieldRequired 
button_field: str
  • Type: str
checkboxRequired 
checkbox: str
  • Type: str
enduser_noteRequired 
enduser_note: str
  • Type: str
hide_iosRequired 
hide_ios: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
hide_webRequired 
hide_web: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
labelRequired 
label: str
  • Type: str
logoRequired 
logo: str
  • Type: str
password_fieldRequired 
password_field: str
  • Type: str
preconfigured_appRequired 
preconfigured_app: str
  • Type: str
redirect_urlRequired 
redirect_url: str
  • Type: str
shared_passwordRequired 
shared_password: str
  • Type: str
shared_usernameRequired 
shared_username: str
  • Type: str
statusRequired 
status: str
  • Type: str
urlRequired 
url: str
  • Type: str
url_regexRequired 
url_regex: str
  • Type: str
username_fieldRequired 
username_field: str
  • Type: str
user_name_templateRequired 
user_name_template: str
  • Type: str
user_name_template_push_statusRequired 
user_name_template_push_status: str
  • Type: str
user_name_template_suffixRequired 
user_name_template_suffix: str
  • Type: str
user_name_template_typeRequired 
user_name_template_type: str
  • Type: str

Constants

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

Structs

AppSharedCredentialsConfig

Initializer 

from cdktf_cdktf_provider_okta import app_shared_credentials

appSharedCredentials.AppSharedCredentialsConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  label: str,
  accessibility_error_redirect_url: str = None,
  accessibility_login_redirect_url: str = None,
  accessibility_self_service: typing.Union[bool, IResolvable] = None,
  admin_note: str = None,
  app_links_json: str = None,
  auto_submit_toolbar: typing.Union[bool, IResolvable] = None,
  button_field: str = None,
  checkbox: str = None,
  enduser_note: str = None,
  hide_ios: typing.Union[bool, IResolvable] = None,
  hide_web: typing.Union[bool, IResolvable] = None,
  id: str = None,
  logo: str = None,
  password_field: str = None,
  preconfigured_app: str = None,
  redirect_url: str = None,
  shared_password: str = None,
  shared_username: str = None,
  status: str = None,
  timeouts: AppSharedCredentialsTimeouts = None,
  url: str = None,
  url_regex: str = None,
  username_field: str = None,
  user_name_template: str = None,
  user_name_template_push_status: str = None,
  user_name_template_suffix: str = None,
  user_name_template_type: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
label str The Application's display name.
accessibility_error_redirect_url str Custom error page URL.
accessibility_login_redirect_url str Custom login page URL.
accessibility_self_service typing.Union[bool, cdktf.IResolvable] Enable self service. Default is false.
admin_note str Application notes for admins.
app_links_json str Displays specific appLinks for the app. The value for each application link should be boolean.
auto_submit_toolbar typing.Union[bool, cdktf.IResolvable] Display auto submit toolbar.
button_field str Login button field.
checkbox str CSS selector for the checkbox.
enduser_note str Application notes for end users.
hide_ios typing.Union[bool, cdktf.IResolvable] Do not display application icon on mobile app.
hide_web typing.Union[bool, cdktf.IResolvable] Do not display application icon to users.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#id AppSharedCredentials#id}.
logo str Local file path to the logo.
password_field str Login password field.
preconfigured_app str Name of application from the Okta Integration Network, if not included a custom app will be created.
redirect_url str Secondary URL of the sign-in page for this app.
shared_password str Shared password, required for certain schemes.
shared_username str Shared username, required for certain schemes.
status str Status of application. By default, it is ACTIVE.
timeouts AppSharedCredentialsTimeouts timeouts block.
url str The URL of the sign-in page for this app.
url_regex str A regular expression that further restricts url to the specified regular expression.
username_field str Login username field.
user_name_template str Username template. Default: ${source.login}.
user_name_template_push_status str Push username on update. Valid values: PUSH and DONT_PUSH.
user_name_template_suffix str Username template suffix.
user_name_template_type str Username template type. Default: BUILT_IN.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
labelRequired 
label: str
  • Type: str

The Application's display name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#label AppSharedCredentials#label}

accessibility_error_redirect_urlOptional 
accessibility_error_redirect_url: str
  • Type: str

Custom error page URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#accessibility_error_redirect_url AppSharedCredentials#accessibility_error_redirect_url}

accessibility_login_redirect_urlOptional 
accessibility_login_redirect_url: str
  • Type: str

Custom login page URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#accessibility_login_redirect_url AppSharedCredentials#accessibility_login_redirect_url}

accessibility_self_serviceOptional 
accessibility_self_service: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Enable self service. Default is false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#accessibility_self_service AppSharedCredentials#accessibility_self_service}

admin_noteOptional 
admin_note: str
  • Type: str

Application notes for admins.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#admin_note AppSharedCredentials#admin_note}

app_links_jsonOptional 
app_links_json: str
  • Type: str

Displays specific appLinks for the app. The value for each application link should be boolean.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#app_links_json AppSharedCredentials#app_links_json}

auto_submit_toolbarOptional 
auto_submit_toolbar: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Display auto submit toolbar.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#auto_submit_toolbar AppSharedCredentials#auto_submit_toolbar}

button_fieldOptional 
button_field: str
  • Type: str

Login button field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#button_field AppSharedCredentials#button_field}

checkboxOptional 
checkbox: str
  • Type: str

CSS selector for the checkbox.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#checkbox AppSharedCredentials#checkbox}

enduser_noteOptional 
enduser_note: str
  • Type: str

Application notes for end users.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#enduser_note AppSharedCredentials#enduser_note}

hide_iosOptional 
hide_ios: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Do not display application icon on mobile app.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#hide_ios AppSharedCredentials#hide_ios}

hide_webOptional 
hide_web: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Do not display application icon to users.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#hide_web AppSharedCredentials#hide_web}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#id AppSharedCredentials#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.

logoOptional 
logo: str
  • Type: str

Local file path to the logo.

The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#logo AppSharedCredentials#logo}

password_fieldOptional 
password_field: str
  • Type: str

Login password field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#password_field AppSharedCredentials#password_field}

preconfigured_appOptional 
preconfigured_app: str
  • Type: str

Name of application from the Okta Integration Network, if not included a custom app will be created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#preconfigured_app AppSharedCredentials#preconfigured_app}

redirect_urlOptional 
redirect_url: str
  • Type: str

Secondary URL of the sign-in page for this app.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#redirect_url AppSharedCredentials#redirect_url}

shared_passwordOptional 
shared_password: str
  • Type: str

Shared password, required for certain schemes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#shared_password AppSharedCredentials#shared_password}

shared_usernameOptional 
shared_username: str
  • Type: str

Shared username, required for certain schemes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#shared_username AppSharedCredentials#shared_username}

statusOptional 
status: str
  • Type: str

Status of application. By default, it is ACTIVE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#status AppSharedCredentials#status}

timeoutsOptional 
timeouts: AppSharedCredentialsTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#timeouts AppSharedCredentials#timeouts}

urlOptional 
url: str
  • Type: str

The URL of the sign-in page for this app.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#url AppSharedCredentials#url}

url_regexOptional 
url_regex: str
  • Type: str

A regular expression that further restricts url to the specified regular expression.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#url_regex AppSharedCredentials#url_regex}

username_fieldOptional 
username_field: str
  • Type: str

Login username field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#username_field AppSharedCredentials#username_field}

user_name_templateOptional 
user_name_template: str
  • Type: str

Username template. Default: ${source.login}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#user_name_template AppSharedCredentials#user_name_template}

user_name_template_push_statusOptional 
user_name_template_push_status: str
  • Type: str

Push username on update. Valid values: PUSH and DONT_PUSH.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#user_name_template_push_status AppSharedCredentials#user_name_template_push_status}

user_name_template_suffixOptional 
user_name_template_suffix: str
  • Type: str

Username template suffix.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#user_name_template_suffix AppSharedCredentials#user_name_template_suffix}

user_name_template_typeOptional 
user_name_template_type: str
  • Type: str

Username template type. Default: BUILT_IN.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#user_name_template_type AppSharedCredentials#user_name_template_type}

AppSharedCredentialsTimeouts

Initializer 

from cdktf_cdktf_provider_okta import app_shared_credentials

appSharedCredentials.AppSharedCredentialsTimeouts(
  create: str = None,
  read: str = None,
  update: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#create AppSharedCredentials#create}.
read str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#read AppSharedCredentials#read}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#update AppSharedCredentials#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#create AppSharedCredentials#create}.

readOptional 
read: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#read AppSharedCredentials#read}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/app_shared_credentials#update AppSharedCredentials#update}.

Classes

AppSharedCredentialsTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_okta import app_shared_credentials

appSharedCredentials.AppSharedCredentialsTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_read No description.
reset_update No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

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

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create 
def reset_create() -> None
reset_read 
def reset_read() -> None
reset_update 
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
read_input str No description.
update_input str No description.
create str No description.
read str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, AppSharedCredentialsTimeouts] 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
read_inputOptional 
read_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
readRequired 
read: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, AppSharedCredentialsTimeouts]