Skip to main content

EnsLib.Amazon.AssumeRoleCommon

EnsLib.Amazon.AssumeRoleCommon includes the settings required for the sts:AssumeRole action. TODO: Move these settings to EnsLib.Amazon.Common when the AssumeRole feature is more broadly implemented in other adapters that extend EnsLib.Amazon.Common. As of now, only the HealthLake adapters support this feature.

Property Inventory

Parameters

parameter SETTINGS = AssumeRoleArn:AWS,AssumeRoleSessionName:AWS,AssumeRoleExternalId:AWS;

Properties

property AssumeRoleArn as %String (MAXLEN = 2048, MINLEN = 20);
The ARN (Amazon Resource Name) of the role to assume.
Required for AssumeRole.
Property methods: AssumeRoleArnDisplayToLogical(), AssumeRoleArnGet(), AssumeRoleArnIsValid(), AssumeRoleArnLogicalToDisplay(), AssumeRoleArnLogicalToOdbc(), AssumeRoleArnNormalize(), AssumeRoleArnSet()
property AssumeRoleExternalId as %String (MAXLEN = 1224, MINLEN = 2);
External ID - a unique identifier that might be required when you assume a role in another account.
Property methods: AssumeRoleExternalIdDisplayToLogical(), AssumeRoleExternalIdGet(), AssumeRoleExternalIdIsValid(), AssumeRoleExternalIdLogicalToDisplay(), AssumeRoleExternalIdLogicalToOdbc(), AssumeRoleExternalIdNormalize(), AssumeRoleExternalIdSet()
property AssumeRoleSessionName as %String (MAXLEN = 64, MINLEN = 2);
Session name - an identifier for the assumed role session.
Please refer to Amazon DocumentationOpens in a new tab for the requirements for RoleSessionName.
Required for AssumeRole.
Property methods: AssumeRoleSessionNameDisplayToLogical(), AssumeRoleSessionNameGet(), AssumeRoleSessionNameIsValid(), AssumeRoleSessionNameLogicalToDisplay(), AssumeRoleSessionNameLogicalToOdbc(), AssumeRoleSessionNameNormalize(), AssumeRoleSessionNameSet()

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab