software.amazon.awssdk.services.sts.model

Interface AssumeRoleWithSamlResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>, SdkBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>, SdkPojo, SdkResponse.Builder, StsResponse.Builder

Enclosing class:

AssumeRoleWithSamlResponse

public static interface AssumeRoleWithSamlResponse.Builder
extends StsResponse.Builder, SdkPojo, CopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>

Method Summary

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 packed size of the session policies and session tags combined passed in the request.
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.

Methods inherited from interface software.amazon.awssdk.services.sts.model.StsResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

credentials

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

credentials

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.

This is a convenience that creates an instance of the 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).

Parameters:

credentials - a consumer that will call methods on Credentials.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

credentials(Credentials)

assumedRoleUser

AssumeRoleWithSamlResponse.Builder assumedRoleUser(AssumedRoleUser assumedRoleUser)

The identifiers for the temporary security credentials that the operation returns.

Parameters:

assumedRoleUser - The identifiers for the temporary security credentials that the operation returns.

Returns:

Returns a reference to this object so that method calls can be chained together.

assumedRoleUser

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 the AssumedRoleUser.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).

Parameters:

assumedRoleUser - a consumer that will call methods on AssumedRoleUser.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

assumedRoleUser(AssumedRoleUser)

packedPolicySize

AssumeRoleWithSamlResponse.Builder packedPolicySize(Integer packedPolicySize)

A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

Parameters:

packedPolicySize - A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

Returns:

Returns a reference to this object so that method calls can be chained together.

subject

AssumeRoleWithSamlResponse.Builder subject(String subject)

The value of the NameID element in the Subject element of the SAML assertion.

Parameters:

subject - The value of the NameID element in the Subject element of the SAML assertion.

Returns:

Returns a reference to this object so that method calls can be chained together.

subjectType

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

issuer

AssumeRoleWithSamlResponse.Builder issuer(String issuer)

The value of the Issuer element of the SAML assertion.

Parameters:

issuer - The value of the Issuer element of the SAML assertion.

Returns:

Returns a reference to this object so that method calls can be chained together.

audience

AssumeRoleWithSamlResponse.Builder audience(String audience)

The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

Parameters:

audience - The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

Returns:

Returns a reference to this object so that method calls can be chained together.

nameQualifier

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" ) )

Parameters:

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" ) )

Returns:

Returns a reference to this object so that method calls can be chained together.