saml_credentials.d.ts 1.1 KB

12345678910111213141516171819202122232425262728293031323334
  1. import {Credentials} from '../credentials';
  2. export class SAMLCredentials extends Credentials {
  3. /**
  4. * Creates a new credentials object.
  5. * @param {object} params - The map of params passed to AWS.STS.assumeRoleWithSAML().
  6. */
  7. constructor(params: SAMLCredentialsParams);
  8. params: SAMLCredentialsParams
  9. }
  10. interface SAMLCredentialsParams {
  11. /**
  12. * The Amazon Resource Name (ARN) of the role that the caller is assuming.
  13. */
  14. RoleArn: string
  15. /**
  16. * The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
  17. */
  18. PrincipalArn: string
  19. /**
  20. * The base-64 encoded SAML authentication response provided by the IdP.
  21. */
  22. SAMLAssertion: string
  23. /**
  24. * An IAM policy in JSON format.
  25. * The policy plain text must be 2048 bytes or shorter.
  26. */
  27. Policy?: string
  28. /**
  29. * The duration, in seconds, of the role session.
  30. * The minimum duration is 15 minutes.
  31. * The maximum duration is 12 hours.
  32. */
  33. DurationSeconds?: number
  34. }