Class MdaaRoleHelper

A Helper class which can be used to resolve MdaaRoleRefs using CustomResources.

Index

Constructors

Methods

createProviderServiceToken resolveRoleRef resolveRoleRefs resolveRoleRefsWithOrdinals resolveRoleRefWithRefId

Constructors

constructor

new MdaaRoleHelper(
    scope: Construct,
    naming: IMdaaResourceNaming,
    providerServiceToken?: string,
): MdaaRoleHelper
Parameters
- scope: Construct
  The scope in which role resolution CR Provider will be created.
- naming: IMdaaResourceNaming
  The MDAA naming implementation which will be used to name resources
- OptionalproviderServiceToken: string
  from the perspective of the calling module.
Returns MdaaRoleHelper
- Defined in rolehelper.ts:36

Methods

createProviderServiceToken

createProviderServiceToken(): string
Returns string
A Custom Resource Provider Service Token which can be used to create role resolver custom resources.
- Defined in rolehelper.ts:121

resolveRoleRef

resolveRoleRef(roleRef: MdaaResolvableRoleRef): MdaaResolvableRole
Parameters
- roleRef: MdaaResolvableRoleRef
  The role reference to be resolved
Returns MdaaResolvableRole
Resolvable roles.
- Defined in rolehelper.ts:88

resolveRoleRefs

resolveRoleRefs(roleRefs: MdaaResolvableRoleRef[]): MdaaResolvableRole[]
Parameters
- roleRefs: MdaaResolvableRoleRef[]
  The role references to be resolved
Returns MdaaResolvableRole[]
Resolvable roles.
- Defined in rolehelper.ts:65

resolveRoleRefsWithOrdinals

resolveRoleRefsWithOrdinals(
roleRefs: MdaaRoleRef[],
refPrefix: string,
): MdaaResolvableRole[]
Can be used to resolve MdaaRoleRefs. Each MdaaRoleRef is first converted to a MdaaResolvableRoleRef by auto generating a role ref unique id using refPrefix and a generated ordinal.
Parameters
- roleRefs: MdaaRoleRef[]
  The role references to be resolved
- refPrefix: string
  The prefix which will be used with ordinal to create a unique ID for use as a resource ID within scopes
Returns MdaaResolvableRole[]
Resolvable roles.
- Defined in rolehelper.ts:50

resolveRoleRefWithRefId

resolveRoleRefWithRefId(roleRef: MdaaRoleRef, refId: string): MdaaResolvableRole
Parameters
- roleRef: MdaaRoleRef
  The role references to be resolved
- refId: string
  The id of the reference to be used in creating the custom resource
Returns MdaaResolvableRole
Resolvable roles.
- Defined in rolehelper.ts:76