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