public static interface AssumeRoleWithSamlResponse.Builder extends StsResponse.Builder, SdkPojo, CopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>
Modifier and Type | Method and Description |
---|---|
AssumeRoleWithSamlResponse.Builder |
assumedRoleUser(AssumedRoleUser assumedRoleUser)
The identifiers for the temporary security credentials that the operation returns.
|
default AssumeRoleWithSamlResponse.Builder |
assumedRoleUser(Consumer<AssumedRoleUser.Builder> assumedRoleUser)
The identifiers for the temporary security credentials that the operation returns.
|
AssumeRoleWithSamlResponse.Builder |
audience(String audience)
The value of the
Recipient attribute of the SubjectConfirmationData element of the
SAML assertion. |
default AssumeRoleWithSamlResponse.Builder |
credentials(Consumer<Credentials.Builder> credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security (or
session) token.
|
AssumeRoleWithSamlResponse.Builder |
credentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security (or
session) token.
|
AssumeRoleWithSamlResponse.Builder |
issuer(String issuer)
The value of the
Issuer element of the SAML assertion. |
AssumeRoleWithSamlResponse.Builder |
nameQualifier(String nameQualifier)
A hash value based on the concatenation of the
Issuer response value, the AWS account ID, and
the friendly name (the last part of the ARN) of the SAML provider in IAM. |
AssumeRoleWithSamlResponse.Builder |
packedPolicySize(Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form.
|
AssumeRoleWithSamlResponse.Builder |
subject(String subject)
The value of the
NameID element in the Subject element of the SAML assertion. |
AssumeRoleWithSamlResponse.Builder |
subjectType(String subjectType)
The format of the name ID, as defined by the
Format attribute in the NameID element
of the SAML assertion. |
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
copy
applyMutation, build
AssumeRoleWithSamlResponse.Builder credentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
credentials
- The temporary security credentials, which include an access key ID, a secret access key, and a
security (or session) token. The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
default AssumeRoleWithSamlResponse.Builder credentials(Consumer<Credentials.Builder> credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
Credentials.Builder
avoiding the need
to create one manually via Credentials.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to credentials(Credentials)
.credentials
- a consumer that will call methods on Credentials.Builder
credentials(Credentials)
AssumeRoleWithSamlResponse.Builder assumedRoleUser(AssumedRoleUser assumedRoleUser)
The identifiers for the temporary security credentials that the operation returns.
assumedRoleUser
- The identifiers for the temporary security credentials that the operation returns.default AssumeRoleWithSamlResponse.Builder assumedRoleUser(Consumer<AssumedRoleUser.Builder> assumedRoleUser)
The identifiers for the temporary security credentials that the operation returns.
This is a convenience that creates an instance of theAssumedRoleUser.Builder
avoiding the need to
create one manually via AssumedRoleUser.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to assumedRoleUser(AssumedRoleUser)
.assumedRoleUser
- a consumer that will call methods on AssumedRoleUser.Builder
assumedRoleUser(AssumedRoleUser)
AssumeRoleWithSamlResponse.Builder packedPolicySize(Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
packedPolicySize
- A percentage value that indicates the size of the policy in packed form. The service rejects any
policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.AssumeRoleWithSamlResponse.Builder subject(String subject)
The value of the NameID
element in the Subject
element of the SAML assertion.
subject
- The value of the NameID
element in the Subject
element of the SAML
assertion.AssumeRoleWithSamlResponse.Builder subjectType(String subjectType)
The format of the name ID, as defined by the Format
attribute in the NameID
element
of the SAML assertion. Typical examples of the format are transient
or persistent
.
If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format
, that prefix is
removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient
is returned as
transient
. If the format includes any other prefix, the format is returned with no
modifications.
subjectType
- The format of the name ID, as defined by the Format
attribute in the NameID
element of the SAML assertion. Typical examples of the format are transient
or
persistent
.
If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format
, that prefix
is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient
is returned
as transient
. If the format includes any other prefix, the format is returned with no
modifications.
AssumeRoleWithSamlResponse.Builder issuer(String issuer)
The value of the Issuer
element of the SAML assertion.
issuer
- The value of the Issuer
element of the SAML assertion.AssumeRoleWithSamlResponse.Builder audience(String audience)
The value of the Recipient
attribute of the SubjectConfirmationData
element of the
SAML assertion.
audience
- The value of the Recipient
attribute of the SubjectConfirmationData
element
of the SAML assertion.AssumeRoleWithSamlResponse.Builder nameQualifier(String nameQualifier)
A hash value based on the concatenation of the Issuer
response value, the AWS account ID, and
the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of
NameQualifier
and Subject
can be used to uniquely identify a federated user.
The following pseudocode shows how the hash value is calculated:
BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
nameQualifier
- A hash value based on the concatenation of the Issuer
response value, the AWS account ID,
and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of
NameQualifier
and Subject
can be used to uniquely identify a federated user.
The following pseudocode shows how the hash value is calculated:
BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
Copyright © 2019. All rights reserved.