Package software.amazon.awssdk.services.sts.model

Interface GetWebIdentityTokenRequest.Builder

    • Method Detail

      • audience

        GetWebIdentityTokenRequest.Builder audience​(Collection<String> audience)

        The intended recipient of the web identity token. This value populates the aud claim in the JWT and should identify the service or application that will validate and use the token. The external service should verify this claim to ensure the token was intended for their use.

        Parameters:
        audience - The intended recipient of the web identity token. This value populates the aud claim in the JWT and should identify the service or application that will validate and use the token. The external service should verify this claim to ensure the token was intended for their use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • audience

        GetWebIdentityTokenRequest.Builder audience​(String... audience)

        The intended recipient of the web identity token. This value populates the aud claim in the JWT and should identify the service or application that will validate and use the token. The external service should verify this claim to ensure the token was intended for their use.

        Parameters:
        audience - The intended recipient of the web identity token. This value populates the aud claim in the JWT and should identify the service or application that will validate and use the token. The external service should verify this claim to ensure the token was intended for their use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • durationSeconds

        GetWebIdentityTokenRequest.Builder durationSeconds​(Integer durationSeconds)

        The duration, in seconds, for which the JSON Web Token (JWT) will remain valid. The value can range from 60 seconds (1 minute) to 3600 seconds (1 hour). If not specified, the default duration is 300 seconds (5 minutes). The token is designed to be short-lived and should be used for proof of identity, then exchanged for credentials or short-lived tokens in the external service.

        Parameters:
        durationSeconds - The duration, in seconds, for which the JSON Web Token (JWT) will remain valid. The value can range from 60 seconds (1 minute) to 3600 seconds (1 hour). If not specified, the default duration is 300 seconds (5 minutes). The token is designed to be short-lived and should be used for proof of identity, then exchanged for credentials or short-lived tokens in the external service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signingAlgorithm

        GetWebIdentityTokenRequest.Builder signingAlgorithm​(String signingAlgorithm)

        The cryptographic algorithm to use for signing the JSON Web Token (JWT). Valid values are RS256 (RSA with SHA-256) and ES384 (ECDSA using P-384 curve with SHA-384).

        Parameters:
        signingAlgorithm - The cryptographic algorithm to use for signing the JSON Web Token (JWT). Valid values are RS256 (RSA with SHA-256) and ES384 (ECDSA using P-384 curve with SHA-384).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        GetWebIdentityTokenRequest.Builder tags​(Collection<Tag> tags)

        An optional list of tags to include in the JSON Web Token (JWT). These tags are added as custom claims to the JWT and can be used by the downstream service for authorization decisions.

        Parameters:
        tags - An optional list of tags to include in the JSON Web Token (JWT). These tags are added as custom claims to the JWT and can be used by the downstream service for authorization decisions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        GetWebIdentityTokenRequest.Builder tags​(Tag... tags)

        An optional list of tags to include in the JSON Web Token (JWT). These tags are added as custom claims to the JWT and can be used by the downstream service for authorization decisions.

        Parameters:
        tags - An optional list of tags to include in the JSON Web Token (JWT). These tags are added as custom claims to the JWT and can be used by the downstream service for authorization decisions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        GetWebIdentityTokenRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        An optional list of tags to include in the JSON Web Token (JWT). These tags are added as custom claims to the JWT and can be used by the downstream service for authorization decisions.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)