impersonation_role_effects

Creates, updates, deletes, gets or lists an impersonation_role_effects resource.

Overview

Name	impersonation_role_effects
Type	Resource
Id	aws.workmail.impersonation_role_effects

Fields

The following fields are returned by SELECT queries:

get_impersonation_role_effect

Name	Datatype	Description
effect	string	Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY. (ALLOW, DENY)
matched_rules	array	A list of the rules that match the input and produce the configured effect.
type	string	The impersonation role type. (FULL_ACCESS, READ_ONLY)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_impersonation_role_effect	select	region		Tests whether the given impersonation role can impersonate a target user.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_impersonation_role_effect

Tests whether the given impersonation role can impersonate a target user.

SELECT
effect,
matched_rules,
type
FROM aws.workmail.impersonation_role_effects
WHERE region = '{{ region }}' -- required
;