com.amazonaws.services.securitytoken.model

## クラス AssumeRoleWithWebIdentityRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class AssumeRoleWithWebIdentityRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `AssumeRoleWithWebIdentity operation`.

  Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Login with Amazon, Facebook, or Google. `AssumeRoleWithWebIdentity` is an API call that does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application or by deploying server-based proxy services that use long-term AWS credentials. For more information, see Creating a Mobile Application with Third-Party Sign-In in AWS Security Token Service .

  The temporary security credentials consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. The credentials are valid for the duration that you specified when calling `AssumeRoleWithWebIdentity` , which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the temporary security credentials are valid for 1 hour.

  The temporary security credentials that are returned from the `AssumeRoleWithWebIdentity` response have the permissions that are associated with the access policy of the role being assumed. You can further restrict the permissions of the temporary security credentials by passing a policy in the request. The resulting permissions are an intersection of the role's access policy and the policy that you passed. These policies and any applicable resource-based policies are evaluated when calls to AWS service APIs are made using the temporary security credentials.

  Before your application can call `AssumeRoleWithWebIdentity` , you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. For more information, see Creating Temporary Security Credentials for Mobile Apps Using Third-Party Identity Providers .

  関連項目:
    `AWSSecurityTokenService.assumeRoleWithWebIdentity(AssumeRoleWithWebIdentityRequest)`, 直列化された形式

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

    コンストラクタ
    コンストラクタと説明
    `AssumeRoleWithWebIdentityRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.Integer` | `getDurationSeconds()` The duration, in seconds, of the role session.
    `java.lang.String` | `getPolicy()` A supplemental policy that is associated with the temporary security credentials from the `AssumeRoleWithWebIdentity` call.
    `java.lang.String` | `getProviderId()` The fully-qualified host component of the domain name of the identity provider.
    `java.lang.String` | `getRoleArn()` The Amazon Resource Name (ARN) of the role that the caller is assuming.
    `java.lang.String` | `getRoleSessionName()` An identifier for the assumed role session.
    `java.lang.String` | `getWebIdentityToken()` The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider.
    `int` | `hashCode()`
    `void` | `setDurationSeconds(java.lang.Integer durationSeconds)` The duration, in seconds, of the role session.
    `void` | `setPolicy(java.lang.String policy)` A supplemental policy that is associated with the temporary security credentials from the `AssumeRoleWithWebIdentity` call.
    `void` | `setProviderId(java.lang.String providerId)` The fully-qualified host component of the domain name of the identity provider.
    `void` | `setRoleArn(java.lang.String roleArn)` The Amazon Resource Name (ARN) of the role that the caller is assuming.
    `void` | `setRoleSessionName(java.lang.String roleSessionName)` An identifier for the assumed role session.
    `void` | `setWebIdentityToken(java.lang.String webIdentityToken)` The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `AssumeRoleWithWebIdentityRequest` | `withDurationSeconds(java.lang.Integer durationSeconds)` The duration, in seconds, of the role session.
    `AssumeRoleWithWebIdentityRequest` | `withPolicy(java.lang.String policy)` A supplemental policy that is associated with the temporary security credentials from the `AssumeRoleWithWebIdentity` call.
    `AssumeRoleWithWebIdentityRequest` | `withProviderId(java.lang.String providerId)` The fully-qualified host component of the domain name of the identity provider.
    `AssumeRoleWithWebIdentityRequest` | `withRoleArn(java.lang.String roleArn)` The Amazon Resource Name (ARN) of the role that the caller is assuming.
    `AssumeRoleWithWebIdentityRequest` | `withRoleSessionName(java.lang.String roleSessionName)` An identifier for the assumed role session.
    `AssumeRoleWithWebIdentityRequest` | `withWebIdentityToken(java.lang.String webIdentityToken)` The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

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

    - #### AssumeRoleWithWebIdentityRequest

          public AssumeRoleWithWebIdentityRequest()

  - ### メソッドの詳細

    - #### getRoleArn

          public java.lang.String getRoleArn()

      The Amazon Resource Name (ARN) of the role that the caller is assuming.

      Constraints:
      Length: 20 - 2048

      戻り値:
        The Amazon Resource Name (ARN) of the role that the caller is assuming.

    - #### setRoleArn

          public void setRoleArn(java.lang.String roleArn)

      The Amazon Resource Name (ARN) of the role that the caller is assuming.

      Constraints:
      Length: 20 - 2048

      パラメータ:
        `roleArn` - The Amazon Resource Name (ARN) of the role that the caller is assuming.

    - #### withRoleArn

          public AssumeRoleWithWebIdentityRequest withRoleArn(java.lang.String roleArn)

      The Amazon Resource Name (ARN) of the role that the caller is assuming.

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

      Constraints:
      Length: 20 - 2048

      パラメータ:
        `roleArn` - The Amazon Resource Name (ARN) of the role that the caller is assuming.

    - #### getRoleSessionName

          public java.lang.String getRoleSessionName()

      An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the `AssumedRoleUser` response element.

      Constraints:
      Length: 2 - 32
      Pattern: [\w+=,.@-]*

      戻り値:
        An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the `AssumedRoleUser` response element.

    - #### setRoleSessionName

          public void setRoleSessionName(java.lang.String roleSessionName)

      An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the `AssumedRoleUser` response element.

      Constraints:
      Length: 2 - 32
      Pattern: [\w+=,.@-]*

      パラメータ:
        `roleSessionName` - An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the `AssumedRoleUser` response element.

    - #### withRoleSessionName

          public AssumeRoleWithWebIdentityRequest withRoleSessionName(java.lang.String roleSessionName)

      An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the `AssumedRoleUser` response element.

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

      Constraints:
      Length: 2 - 32
      Pattern: [\w+=,.@-]*

      パラメータ:
        `roleSessionName` - An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the `AssumedRoleUser` response element.

    - #### getWebIdentityToken

          public java.lang.String getWebIdentityToken()

      The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an `AssumeRoleWithWebIdentity` call.

      Constraints:
      Length: 4 - 2048

      戻り値:
        The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an `AssumeRoleWithWebIdentity` call.

    - #### setWebIdentityToken

          public void setWebIdentityToken(java.lang.String webIdentityToken)

      The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an `AssumeRoleWithWebIdentity` call.

      Constraints:
      Length: 4 - 2048

      パラメータ:
        `webIdentityToken` - The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an `AssumeRoleWithWebIdentity` call.

    - #### withWebIdentityToken

          public AssumeRoleWithWebIdentityRequest withWebIdentityToken(java.lang.String webIdentityToken)

      The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an `AssumeRoleWithWebIdentity` call.

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

      Constraints:
      Length: 4 - 2048

      パラメータ:
        `webIdentityToken` - The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an `AssumeRoleWithWebIdentity` call.

    - #### getProviderId

          public java.lang.String getProviderId()

      The fully-qualified host component of the domain name of the identity provider. Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect ID tokens, such as `accounts.google.com`. Do not include URL schemes and port numbers. Currently, `www.amazon.com` and `graph.facebook.com` are supported.

      Constraints:
      Length: 4 - 2048

      戻り値:
        The fully-qualified host component of the domain name of the identity provider. Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect ID tokens, such as `accounts.google.com`. Do not include URL schemes and port numbers. Currently, `www.amazon.com` and `graph.facebook.com` are supported.

    - #### setProviderId

          public void setProviderId(java.lang.String providerId)

      The fully-qualified host component of the domain name of the identity provider. Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect ID tokens, such as `accounts.google.com`. Do not include URL schemes and port numbers. Currently, `www.amazon.com` and `graph.facebook.com` are supported.

      Constraints:
      Length: 4 - 2048

      パラメータ:
        `providerId` - The fully-qualified host component of the domain name of the identity provider. Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect ID tokens, such as `accounts.google.com`. Do not include URL schemes and port numbers. Currently, `www.amazon.com` and `graph.facebook.com` are supported.

    - #### withProviderId

          public AssumeRoleWithWebIdentityRequest withProviderId(java.lang.String providerId)

      The fully-qualified host component of the domain name of the identity provider. Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect ID tokens, such as `accounts.google.com`. Do not include URL schemes and port numbers. Currently, `www.amazon.com` and `graph.facebook.com` are supported.

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

      Constraints:
      Length: 4 - 2048

      パラメータ:
        `providerId` - The fully-qualified host component of the domain name of the identity provider. Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect ID tokens, such as `accounts.google.com`. Do not include URL schemes and port numbers. Currently, `www.amazon.com` and `graph.facebook.com` are supported.

    - #### getPolicy

          public java.lang.String getPolicy()

      A supplemental policy that is associated with the temporary security credentials from the `AssumeRoleWithWebIdentity` call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials.

      Constraints:
      Length: 1 - 2048
      Pattern: [ -ÿ]+

      戻り値:
        A supplemental policy that is associated with the temporary security credentials from the `AssumeRoleWithWebIdentity` call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials.

    - #### setPolicy

          public void setPolicy(java.lang.String policy)

      A supplemental policy that is associated with the temporary security credentials from the `AssumeRoleWithWebIdentity` call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials.

      Constraints:
      Length: 1 - 2048
      Pattern: [ -ÿ]+

      パラメータ:
        `policy` - A supplemental policy that is associated with the temporary security credentials from the `AssumeRoleWithWebIdentity` call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials.

    - #### withPolicy

          public AssumeRoleWithWebIdentityRequest withPolicy(java.lang.String policy)

      A supplemental policy that is associated with the temporary security credentials from the `AssumeRoleWithWebIdentity` call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials.

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

      Constraints:
      Length: 1 - 2048
      Pattern: [ -ÿ]+

      パラメータ:
        `policy` - A supplemental policy that is associated with the temporary security credentials from the `AssumeRoleWithWebIdentity` call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials.

    - #### getDurationSeconds

          public java.lang.Integer getDurationSeconds()

      The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

      Constraints:
      Range: 900 - 129600

      戻り値:
        The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

    - #### setDurationSeconds

          public void setDurationSeconds(java.lang.Integer durationSeconds)

      The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

      Constraints:
      Range: 900 - 129600

      パラメータ:
        `durationSeconds` - The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

    - #### withDurationSeconds

          public AssumeRoleWithWebIdentityRequest withDurationSeconds(java.lang.Integer durationSeconds)

      The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

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

      Constraints:
      Range: 900 - 129600

      パラメータ:
        `durationSeconds` - The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`