config_wrangler.config_templates.aws.dynamodb module

pydantic model config_wrangler.config_templates.aws.dynamodb.DynamoDB[source]

Bases: AWS_Session

Config:

  • validate_default: bool = True

  • validate_assignment: bool = True

  • validate_credentials: bool = True

Fields:

  • iam_role (str | None)

  • keepass (config_wrangler.config_templates.keepass_config.KeepassConfig | None)

  • keepass_config (str | None)

  • keepass_group (str | None)

  • keepass_title (str | None)

  • keyring_section (str | None)

  • password_source (config_wrangler.config_templates.password_source.PasswordSource | None)

  • raw_password (str | None)

  • region_name (str | None)

  • scan_progress_seconds (int)

  • user_id (str | None)

  • validate_password_on_load (bool)

Validators:

  • check_model » all fields

add_child(name: str, child_object: ConfigHierarchy)

Set this configuration as a child in the hierarchy of another config. For any programmatically created config objects this is required so that the new object ‘knows’ where it lives in the hierarchy – most importantly so that it can find the hierarchies root object.

assume_role()
validator check_model  »  all fields
full_item_name(item_name: str | None = None, delimiter: str = ' -> ')

The fully qualified name of this config item in the config hierarchy.

get_copy(copied_by: str = 'get_copy') → AWS_Session

Copy this configuration. Useful when you need to programmatically modify a configuration without modifying the original base configuration.

get_dynamo_table(dynamo_table_name, region_name: str = None) → Table[source]
get_password() → str

Get the password for this resource. password_source controls where it looks for the password. If that is None, then the root level passwords container is checked for password_source value.

get_request_v4_authorizer(service: str = None) → requests.auth.AuthBase
get_secrets_manager()
get_service_client(service: str)
get_service_resource(service: str)
get_session_expiry()
get_ssm()
model_dump_non_private(*, mode: Literal['json', 'python'] | str = 'python', exclude: Set[str] | None = None) → dict[str, Any]
nav_to_bucket(bucket_name) → S3_Bucket
query_dynamo_table(dynamo_table: Table, scan_args_list: Iterable[dict]) → Iterable[dict][source]
query_dynamo_table_by_name(dynamo_table_name: str, scan_args_list: Iterable[dict], region_name: str = None) → Iterable[dict][source]
scan_dynamo_table(dynamo_table: Table) → Iterator[dict][source]
scan_dynamo_table_by_name(dynamo_table_name: str, region_name: str = None) → Iterable[dict][source]
set_as_child(name: str, other_config_item: ConfigHierarchy)
set_session(session: Session)
static split_s3_uri(s3_uri: str) → Tuple[str, str]
static translate_config_data(config_data: MutableMapping)

Children classes can provide translation logic to allow older config files to be used with newer config class definitions.

pydantic model config_wrangler.config_templates.aws.dynamodb.DynamoDBTable[source]

Bases: DynamoDB

Config:

  • validate_default: bool = True

  • validate_assignment: bool = True

  • validate_credentials: bool = True

Fields:

  • iam_role (str | None)

  • keepass (config_wrangler.config_templates.keepass_config.KeepassConfig | None)

  • keepass_config (str | None)

  • keepass_group (str | None)

  • keepass_title (str | None)

  • keyring_section (str | None)

  • password_source (config_wrangler.config_templates.password_source.PasswordSource | None)

  • raw_password (str | None)

  • region_name (str | None)

  • scan_progress_seconds (int)

  • table_name (str)

  • user_id (str | None)

  • validate_password_on_load (bool)

Validators:

  • check_model » all fields

add_child(name: str, child_object: ConfigHierarchy)

Set this configuration as a child in the hierarchy of another config. For any programmatically created config objects this is required so that the new object ‘knows’ where it lives in the hierarchy – most importantly so that it can find the hierarchies root object.

assume_role()
validator check_model  »  all fields
full_item_name(item_name: str | None = None, delimiter: str = ' -> ')

The fully qualified name of this config item in the config hierarchy.

get_connected_pynamodb(model: pynamodb.models.Model, connect_table_name: str | None = None) → pynamodb.models.Model[source]
get_copy(copied_by: str = 'get_copy') → AWS_Session

Copy this configuration. Useful when you need to programmatically modify a configuration without modifying the original base configuration.

get_dynamo_table(**kwargs) → Table[source]
get_password() → str

Get the password for this resource. password_source controls where it looks for the password. If that is None, then the root level passwords container is checked for password_source value.

get_request_v4_authorizer(service: str = None) → requests.auth.AuthBase
get_secrets_manager()
get_service_client(service: str)
get_service_resource(service: str)
get_session_expiry()
get_ssm()
model_dump_non_private(*, mode: Literal['json', 'python'] | str = 'python', exclude: Set[str] | None = None) → dict[str, Any]
nav_to_bucket(bucket_name) → S3_Bucket
put_item(item: Mapping[str, Any]) → PutItemOutputTableTypeDef[source]
query_dynamo_table(scan_args_list: Iterable[dict], **kwargs) → Iterable[dict][source]
query_dynamo_table_by_name(dynamo_table_name: str, scan_args_list: Iterable[dict], region_name: str = None) → Iterable[dict]
scan_dynamo_table(**kwargs)[source]
scan_dynamo_table_by_name(dynamo_table_name: str, region_name: str = None) → Iterable[dict]
set_as_child(name: str, other_config_item: ConfigHierarchy)
set_session(session: Session)
static split_s3_uri(s3_uri: str) → Tuple[str, str]
static translate_config_data(config_data: MutableMapping)

Children classes can provide translation logic to allow older config files to be used with newer config class definitions.