Interface GetScopedCredentialsResponse.Builder

  • Method Details

    • credentials

      The temporary security credentials for the scoped down session, which include an access key ID, a secret access key, and a security 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 for the scoped down session, which include an access key ID, a secret access key, and a security 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

      The temporary security credentials for the scoped down session, which include an access key ID, a secret access key, and a security 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 method 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:
    • sessionInfo

      Metadata about the resulting scoped session, including its identifier and ARN. Because the identity does not change, the identifiers reflect the same principal and session name as the calling session.

      Parameters:
      sessionInfo - Metadata about the resulting scoped session, including its identifier and ARN. Because the identity does not change, the identifiers reflect the same principal and session name as the calling session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sessionInfo

      Metadata about the resulting scoped session, including its identifier and ARN. Because the identity does not change, the identifiers reflect the same principal and session name as the calling session.

      This is a convenience method that creates an instance of the ScopedSession.Builder avoiding the need to create one manually via ScopedSession.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sessionInfo(ScopedSession).

      Parameters:
      sessionInfo - a consumer that will call methods on ScopedSession.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sessionTokenUtilization

      GetScopedCredentialsResponse.Builder sessionTokenUtilization(Integer sessionTokenUtilization)
      Sets the value of the SessionTokenUtilization property for this object.
      Parameters:
      sessionTokenUtilization - The new value for the SessionTokenUtilization property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sessionTokenSize

      GetScopedCredentialsResponse.Builder sessionTokenSize(Integer sessionTokenSize)
      Sets the value of the SessionTokenSize property for this object.
      Parameters:
      sessionTokenSize - The new value for the SessionTokenSize property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • scopedPoliciesCount

      GetScopedCredentialsResponse.Builder scopedPoliciesCount(Integer scopedPoliciesCount)

      GetScopedCredentials can be called recursively and ScopedPoliciesCount specifies the number of scope down policies applied to the session. Each recursive call adds another scope down policy layer. A maximum of 3 scope down policy layers are allowed per session. If a session already has 3 GetScopedCredentials scope-down policies, a subsequent GetScopedCredentials call that supplies a Policy (attempting to append a fourth scope-down policy) is denied.

      Parameters:
      scopedPoliciesCount - GetScopedCredentials can be called recursively and ScopedPoliciesCount specifies the number of scope down policies applied to the session. Each recursive call adds another scope down policy layer. A maximum of 3 scope down policy layers are allowed per session. If a session already has 3 GetScopedCredentials scope-down policies, a subsequent GetScopedCredentials call that supplies a Policy (attempting to append a fourth scope-down policy) is denied.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sourceIdentity

      GetScopedCredentialsResponse.Builder sourceIdentity(String sourceIdentity)

      The source identity of the calling session, carried forward unchanged. This operation never sets or modifies the source identity; it reflects the value established when the source identity was first set. For more information, see Monitor and control actions taken with assumed roles in the IAM User Guide.

      Parameters:
      sourceIdentity - The source identity of the calling session, carried forward unchanged. This operation never sets or modifies the source identity; it reflects the value established when the source identity was first set. For more information, see Monitor and control actions taken with assumed roles in the IAM User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.