Skip to content

Latest commit

 

History

History
1824 lines (1164 loc) · 83.6 KB

File metadata and controls

1824 lines (1164 loc) · 83.6 KB

dataAwsElasticacheUser Submodule

Constructs

DataAwsElasticacheUser

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user aws_elasticache_user}.

Initializers

from cdktn_provider_aws import data_aws_elasticache_user

dataAwsElasticacheUser.DataAwsElasticacheUser(
  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,
  user_id: str,
  access_string: str = None,
  authentication_mode: IResolvable | typing.List[DataAwsElasticacheUserAuthenticationMode] = None,
  engine: str = None,
  id: str = None,
  no_password_required: bool | IResolvable = None,
  passwords: typing.List[str] = None,
  region: str = None,
  user_name: str = 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.
user_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#user_id DataAwsElasticacheUser#user_id}.
access_string str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#access_string DataAwsElasticacheUser#access_string}.
authentication_mode cdktn.IResolvable | typing.List[DataAwsElasticacheUserAuthenticationMode] authentication_mode block.
engine str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#engine DataAwsElasticacheUser#engine}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#id DataAwsElasticacheUser#id}.
no_password_required bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#no_password_required DataAwsElasticacheUser#no_password_required}.
passwords typing.List[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#passwords DataAwsElasticacheUser#passwords}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
user_name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#user_name DataAwsElasticacheUser#user_name}.

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]

user_idRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#user_id DataAwsElasticacheUser#user_id}.


access_stringOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#access_string DataAwsElasticacheUser#access_string}.


authentication_modeOptional

authentication_mode block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#authentication_mode DataAwsElasticacheUser#authentication_mode}


engineOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#engine DataAwsElasticacheUser#engine}.


idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#id DataAwsElasticacheUser#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.


no_password_requiredOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#no_password_required DataAwsElasticacheUser#no_password_required}.


passwordsOptional
  • Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#passwords DataAwsElasticacheUser#passwords}.


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/data-sources/elasticache_user#region DataAwsElasticacheUser#region}


user_nameOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#user_name DataAwsElasticacheUser#user_name}.


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 Adds this resource to the terraform JSON output.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
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.
put_authentication_mode No description.
reset_access_string No description.
reset_authentication_mode No description.
reset_engine No description.
reset_id No description.
reset_no_password_required No description.
reset_passwords No description.
reset_region No description.
reset_user_name 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

Adds this resource to the terraform JSON output.

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

Adds this resource to the terraform JSON output.

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(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

put_authentication_mode
def put_authentication_mode(
  value: IResolvable | typing.List[DataAwsElasticacheUserAuthenticationMode]
) -> None
valueRequired

reset_access_string
def reset_access_string() -> None
reset_authentication_mode
def reset_authentication_mode() -> None
reset_engine
def reset_engine() -> None
reset_id
def reset_id() -> None
reset_no_password_required
def reset_no_password_required() -> None
reset_passwords
def reset_passwords() -> None
reset_region
def reset_region() -> None
reset_user_name
def reset_user_name() -> None

Static Functions

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

is_construct
from cdktn_provider_aws import data_aws_elasticache_user

dataAwsElasticacheUser.DataAwsElasticacheUser.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 data_aws_elasticache_user

dataAwsElasticacheUser.DataAwsElasticacheUser.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_data_source
from cdktn_provider_aws import data_aws_elasticache_user

dataAwsElasticacheUser.DataAwsElasticacheUser.is_terraform_data_source(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktn_provider_aws import data_aws_elasticache_user

dataAwsElasticacheUser.DataAwsElasticacheUser.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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


import_from_idRequired
  • Type: str

The id of the existing DataAwsElasticacheUser that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#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 DataAwsElasticacheUser 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.
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.
authentication_mode DataAwsElasticacheUserAuthenticationModeList No description.
access_string_input str No description.
authentication_mode_input cdktn.IResolvable | typing.List[DataAwsElasticacheUserAuthenticationMode] No description.
engine_input str No description.
id_input str No description.
no_password_required_input bool | cdktn.IResolvable No description.
passwords_input typing.List[str] No description.
region_input str No description.
user_id_input str No description.
user_name_input str No description.
access_string str No description.
engine str No description.
id str No description.
no_password_required bool | cdktn.IResolvable No description.
passwords typing.List[str] No description.
region str No description.
user_id str No description.
user_name 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

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

authentication_modeRequired
authentication_mode: DataAwsElasticacheUserAuthenticationModeList

access_string_inputOptional
access_string_input: str
  • Type: str

authentication_mode_inputOptional
authentication_mode_input: IResolvable | typing.List[DataAwsElasticacheUserAuthenticationMode]

engine_inputOptional
engine_input: str
  • Type: str

id_inputOptional
id_input: str
  • Type: str

no_password_required_inputOptional
no_password_required_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable

passwords_inputOptional
passwords_input: typing.List[str]
  • Type: typing.List[str]

region_inputOptional
region_input: str
  • Type: str

user_id_inputOptional
user_id_input: str
  • Type: str

user_name_inputOptional
user_name_input: str
  • Type: str

access_stringRequired
access_string: str
  • Type: str

engineRequired
engine: str
  • Type: str

idRequired
id: str
  • Type: str

no_password_requiredRequired
no_password_required: bool | IResolvable
  • Type: bool | cdktn.IResolvable

passwordsRequired
passwords: typing.List[str]
  • Type: typing.List[str]

regionRequired
region: str
  • Type: str

user_idRequired
user_id: str
  • Type: str

user_nameRequired
user_name: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

DataAwsElasticacheUserAuthenticationMode

Initializer

from cdktn_provider_aws import data_aws_elasticache_user

dataAwsElasticacheUser.DataAwsElasticacheUserAuthenticationMode(
  password_count: typing.Union[int, float] = None,
  type: str = None
)

Properties

Name Type Description
password_count typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#password_count DataAwsElasticacheUser#password_count}.
type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#type DataAwsElasticacheUser#type}.

password_countOptional
password_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#password_count DataAwsElasticacheUser#password_count}.


typeOptional
type: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#type DataAwsElasticacheUser#type}.


DataAwsElasticacheUserConfig

Initializer

from cdktn_provider_aws import data_aws_elasticache_user

dataAwsElasticacheUser.DataAwsElasticacheUserConfig(
  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,
  user_id: str,
  access_string: str = None,
  authentication_mode: IResolvable | typing.List[DataAwsElasticacheUserAuthenticationMode] = None,
  engine: str = None,
  id: str = None,
  no_password_required: bool | IResolvable = None,
  passwords: typing.List[str] = None,
  region: str = None,
  user_name: str = 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.
user_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#user_id DataAwsElasticacheUser#user_id}.
access_string str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#access_string DataAwsElasticacheUser#access_string}.
authentication_mode cdktn.IResolvable | typing.List[DataAwsElasticacheUserAuthenticationMode] authentication_mode block.
engine str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#engine DataAwsElasticacheUser#engine}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#id DataAwsElasticacheUser#id}.
no_password_required bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#no_password_required DataAwsElasticacheUser#no_password_required}.
passwords typing.List[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#passwords DataAwsElasticacheUser#passwords}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
user_name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#user_name DataAwsElasticacheUser#user_name}.

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]

user_idRequired
user_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#user_id DataAwsElasticacheUser#user_id}.


access_stringOptional
access_string: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#access_string DataAwsElasticacheUser#access_string}.


authentication_modeOptional
authentication_mode: IResolvable | typing.List[DataAwsElasticacheUserAuthenticationMode]

authentication_mode block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#authentication_mode DataAwsElasticacheUser#authentication_mode}


engineOptional
engine: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#engine DataAwsElasticacheUser#engine}.


idOptional
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#id DataAwsElasticacheUser#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.


no_password_requiredOptional
no_password_required: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#no_password_required DataAwsElasticacheUser#no_password_required}.


passwordsOptional
passwords: typing.List[str]
  • Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#passwords DataAwsElasticacheUser#passwords}.


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/data-sources/elasticache_user#region DataAwsElasticacheUser#region}


user_nameOptional
user_name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/data-sources/elasticache_user#user_name DataAwsElasticacheUser#user_name}.


Classes

DataAwsElasticacheUserAuthenticationModeList

Initializers

from cdktn_provider_aws import data_aws_elasticache_user

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

terraform_resourceRequired
  • Type: cdktn.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


wraps_setRequired
  • Type: bool

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


Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.

all_with_map_key
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

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

map_key_attribute_nameRequired
  • Type: str

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

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktn.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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

the index of the item to return.


Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value cdktn.IResolvable | typing.List[DataAwsElasticacheUserAuthenticationMode] No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

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

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


fqnRequired
fqn: str
  • Type: str

internal_valueOptional
internal_value: IResolvable | typing.List[DataAwsElasticacheUserAuthenticationMode]

DataAwsElasticacheUserAuthenticationModeOutputReference

Initializers

from cdktn_provider_aws import data_aws_elasticache_user

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

terraform_resourceRequired
  • Type: cdktn.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


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

the index of this item in the list.


complex_object_is_from_setRequired
  • Type: bool

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


Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_password_count No description.
reset_type 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_password_count
def reset_password_count() -> None
reset_type
def reset_type() -> 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.
password_count_input typing.Union[int, float] No description.
type_input str No description.
password_count typing.Union[int, float] No description.
type str No description.
internal_value cdktn.IResolvable | DataAwsElasticacheUserAuthenticationMode 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

password_count_inputOptional
password_count_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

type_inputOptional
type_input: str
  • Type: str

password_countRequired
password_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

typeRequired
type: str
  • Type: str

internal_valueOptional
internal_value: IResolvable | DataAwsElasticacheUserAuthenticationMode