com.amazonaws.auth

## クラス WebIdentityFederationSessionCredentialsProvider

- java.lang.Object
- - com.amazonaws.auth.WebIdentityFederationSessionCredentialsProvider

- すべての実装されたインタフェース:
    AWSCredentialsProvider

      public class WebIdentityFederationSessionCredentialsProvider
      extends java.lang.Object
      implements AWSCredentialsProvider

  AWSCredentialsProvider implementation that uses the AWS Security Token Service to create temporary, short-lived sessions to use for authentication.

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `static int` | `DEFAULT_DURATION_SECONDS` Default duration for started sessions
    `static int` | `DEFAULT_THRESHOLD_SECONDS` Default threshold for refreshing session credentials

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `WebIdentityFederationSessionCredentialsProvider(java.lang.String wifToken, java.lang.String wifProvider, java.lang.String roleArn)` Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's `getCredentials()` method.
    `WebIdentityFederationSessionCredentialsProvider(java.lang.String wifToken, java.lang.String wifProvider, java.lang.String roleArn, AWSSecurityTokenService stsClient)` Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider to make a request to the AWS Security Token Service (STS) using the provided client to request short lived session credentials, which will then be returned by this class's `getCredentials()` method.
    `WebIdentityFederationSessionCredentialsProvider(java.lang.String wifToken, java.lang.String wifProvider, java.lang.String roleArn, ClientConfiguration clientConfiguration)` Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's `getCredentials()` method.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `AWSCredentials` | `getCredentials()` Returns AWSCredentials which the caller can use to authorize an AWS request.
    `int` | `getRefreshThreshold()` Get the refresh threshold for the session credentials created by this client in seconds.
    `int` | `getSessionDuration()` Get the duration of the session credentials created by this client in seconds.
    `java.lang.String` | `getSubjectFromWIF()` Get the identifier returned from the Identity Provider for the authenticated user.
    `void` | `refresh()` Forces this credentials provider to refresh its credentials.
    `void` | `setRefreshThreshold(int refreshThreshold)` Set the refresh threshold for the session credentials created by this client in seconds.
    `void` | `setSessionDuration(int sessionDuration)` Set the duration of the session credentials created by this client in seconds.
    `WebIdentityFederationSessionCredentialsProvider` | `withRefreshThreshold(int refreshThreshold)` Set the refresh threshold for the session credentials created by this client in seconds.
    `WebIdentityFederationSessionCredentialsProvider` | `withSessionDuration(int sessionDuration)` Set the duration of the session credentials created by this client in seconds.

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### フィールドの詳細

    - #### DEFAULT_DURATION_SECONDS

          public static final int DEFAULT_DURATION_SECONDS

      Default duration for started sessions
      関連項目:
        定数フィールド値

    - #### DEFAULT_THRESHOLD_SECONDS

          public static final int DEFAULT_THRESHOLD_SECONDS

      Default threshold for refreshing session credentials
      関連項目:
        定数フィールド値

  - ### コンストラクタの詳細

    - #### WebIdentityFederationSessionCredentialsProvider

          public WebIdentityFederationSessionCredentialsProvider(java.lang.String wifToken,
                                                         java.lang.String wifProvider,
                                                         java.lang.String roleArn)

      Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's `getCredentials()` method.
      パラメータ:
        `wifToken` - The OAuth/OpenID token from the the Identity Provider
        `wifProvider` - The name of the Identity Provider (null for OpenID providers)
        `roleArn` - The ARN of the IAM Role that will be assumed

    - #### WebIdentityFederationSessionCredentialsProvider

          public WebIdentityFederationSessionCredentialsProvider(java.lang.String wifToken,
                                                         java.lang.String wifProvider,
                                                         java.lang.String roleArn,
                                                         ClientConfiguration clientConfiguration)

      Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's `getCredentials()` method.
      パラメータ:
        `wifToken` - The OAuth/OpenID token from the the Identity Provider
        `wifProvider` - The name of the Identity Provider (null for OpenID providers)
        `roleArn` - The ARN of the IAM Role that will be assumed
        `clientConfiguation` - Configuration to apply to STS client created

    - #### WebIdentityFederationSessionCredentialsProvider

          public WebIdentityFederationSessionCredentialsProvider(java.lang.String wifToken,
                                                         java.lang.String wifProvider,
                                                         java.lang.String roleArn,
                                                         AWSSecurityTokenService stsClient)

      Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider to make a request to the AWS Security Token Service (STS) using the provided client to request short lived session credentials, which will then be returned by this class's `getCredentials()` method.
      パラメータ:
        `wifToken` - The OAuth/OpenID token from the the Identity Provider
        `wifProvider` - The name of the Identity Provider (null for OpenID providers)
        `roleArn` - The ARN of the IAM Role that will be assumed
        `stsClient` - Preconfigured STS client to make requests with

  - ### メソッドの詳細

    - #### getCredentials

          public AWSCredentials getCredentials()

      インタフェースからコピーされた説明: `AWSCredentialsProvider`
      Returns AWSCredentials which the caller can use to authorize an AWS request. Each implementation of AWSCredentialsProvider can chose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated.
      定義:
        `getCredentials` インタフェース内 `AWSCredentialsProvider`
      戻り値:
        AWSCredentials which the caller can use to authorize an AWS request.

    - #### refresh

          public void refresh()

      インタフェースからコピーされた説明: `AWSCredentialsProvider`
      Forces this credentials provider to refresh its credentials. For many implementations of credentials provider, this method may simply be a no-op, such as any credentials provider implementation that vends static/non-changing credentials. For other implementations that vend different credentials through out their lifetime, this method should force the credentials provider to refresh its credentials.
      定義:
        `refresh` インタフェース内 `AWSCredentialsProvider`

    - #### setSessionDuration

          public void setSessionDuration(int sessionDuration)

      Set the duration of the session credentials created by this client in seconds. Values must be supported by AssumeRoleWithWebIdentityRequest.
      パラメータ:
        `sessionDuration` - The new duration for session credentials created by this provider
      関連項目:
        `AssumeRoleWithWebIdentityRequest`

    - #### withSessionDuration

          public WebIdentityFederationSessionCredentialsProvider withSessionDuration(int sessionDuration)

      Set the duration of the session credentials created by this client in seconds. Values must be supported by AssumeRoleWithWebIdentityRequest. Returns refreence to object so methods can be chained together.
      パラメータ:
        `sessionDuration` - The new duration for session credentials created by this provider
      戻り値:
        A reference to this updated object so that method calls can be chained together.
      関連項目:
        `AssumeRoleWithWebIdentityRequest`

    - #### getSessionDuration

          public int getSessionDuration()

      Get the duration of the session credentials created by this client in seconds. Values must be supported by AssumeRoleWithWebIdentityRequest.
      戻り値:
        The duration for session credentials created by this provider
      関連項目:
        `AssumeRoleWithWebIdentityRequest`

    - #### setRefreshThreshold

          public void setRefreshThreshold(int refreshThreshold)

      Set the refresh threshold for the session credentials created by this client in seconds. This value will be used internally to determine if new credentials should be fetched from STS.
      パラメータ:
        `refreshThreshold` - The new refresh threshold for session credentials created by this provider
      関連項目:
        `AssumeRoleWithWebIdentityRequest`

    - #### withRefreshThreshold

          public WebIdentityFederationSessionCredentialsProvider withRefreshThreshold(int refreshThreshold)

      Set the refresh threshold for the session credentials created by this client in seconds. This value will be used internally to determine if new credentials should be fetched from STS. Returns a refrence to the object so methods can be chained.
      パラメータ:
        `refreshThreshold` - The new refresh threshold for session credentials created by this provider
      戻り値:
        A reference to this updated object so that method calls can be chained together.
      関連項目:
        `AssumeRoleWithWebIdentityRequest`

    - #### getRefreshThreshold

          public int getRefreshThreshold()

      Get the refresh threshold for the session credentials created by this client in seconds. This value will be used internally to determine if new credentials should be fetched from STS.
      戻り値:
        The refresh threshold for session credentials created by this provider
      関連項目:
        `AssumeRoleWithWebIdentityRequest`

    - #### getSubjectFromWIF

          public java.lang.String getSubjectFromWIF()

      Get the identifier returned from the Identity Provider for the authenticated user. This value is returned as part of the AssumeRoleWithIdentityResult
      戻り値:
        The identifier returned from Identity Provider
      関連項目:
        `AssumeRoleWithWebIdentityResult`