com.amazonaws.services.securitytoken.model

## クラス AssumeRoleRequest

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

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

      public class AssumeRoleRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `AssumeRole operation`.

  Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use `AssumeRole` for cross-account access or federation.

  For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see Roles in Using IAM .

  For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call `AssumeRole` (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see Scenarios for Granting Temporary Access in AWS Security Token Service .

  The temporary security credentials are valid for the duration that you specified when calling `AssumeRole` , which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). The default is 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 and any policies that are associated with the AWS resource being accessed. 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.

  To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the IAM role is created. You must also have a policy that allows you to call `sts:AssumeRole` .

  Important: You cannot call `Assumerole` by using AWS account credentials; access will be denied. You must use IAM user credentials or temporary security credentials to call `AssumeRole` .

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

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.Integer` | `getDurationSeconds()` The duration, in seconds, of the role session.
    `java.lang.String` | `getExternalId()` A unique identifier that is used by third parties to assume a role in their customers' accounts.
    `java.lang.String` | `getPolicy()` A supplemental policy that is associated with the temporary security credentials from the `AssumeRole` call.
    `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.
    `int` | `hashCode()`
    `void` | `setDurationSeconds(java.lang.Integer durationSeconds)` The duration, in seconds, of the role session.
    `void` | `setExternalId(java.lang.String externalId)` A unique identifier that is used by third parties to assume a role in their customers' accounts.
    `void` | `setPolicy(java.lang.String policy)` A supplemental policy that is associated with the temporary security credentials from the `AssumeRole` call.
    `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.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `AssumeRoleRequest` | `withDurationSeconds(java.lang.Integer durationSeconds)` The duration, in seconds, of the role session.
    `AssumeRoleRequest` | `withExternalId(java.lang.String externalId)` A unique identifier that is used by third parties to assume a role in their customers' accounts.
    `AssumeRoleRequest` | `withPolicy(java.lang.String policy)` A supplemental policy that is associated with the temporary security credentials from the `AssumeRole` call.
    `AssumeRoleRequest` | `withRoleArn(java.lang.String roleArn)` The Amazon Resource Name (ARN) of the role that the caller is assuming.
    `AssumeRoleRequest` | `withRoleSessionName(java.lang.String roleSessionName)` An identifier for the assumed role session.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### AssumeRoleRequest

          public AssumeRoleRequest()

  - ### メソッドの詳細

    - #### 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 AssumeRoleRequest 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. The session name is included as part of the `AssumedRoleUser`.

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

      戻り値:
        An identifier for the assumed role session. The session name is included as part of the `AssumedRoleUser`.

    - #### setRoleSessionName

          public void setRoleSessionName(java.lang.String roleSessionName)

      An identifier for the assumed role session. The session name is included as part of the `AssumedRoleUser`.

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

      パラメータ:
        `roleSessionName` - An identifier for the assumed role session. The session name is included as part of the `AssumedRoleUser`.

    - #### withRoleSessionName

          public AssumeRoleRequest withRoleSessionName(java.lang.String roleSessionName)

      An identifier for the assumed role session. The session name is included as part of the `AssumedRoleUser`.

      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. The session name is included as part of the `AssumedRoleUser`.

    - #### getPolicy

          public java.lang.String getPolicy()

      A supplemental policy that is associated with the temporary security credentials from the `AssumeRole` 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 `AssumeRole` 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 `AssumeRole` 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 `AssumeRole` 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 AssumeRoleRequest withPolicy(java.lang.String policy)

      A supplemental policy that is associated with the temporary security credentials from the `AssumeRole` 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 `AssumeRole` 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 - 3600

      戻り値:
        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 - 3600

      パラメータ:
        `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 AssumeRoleRequest 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 - 3600

      パラメータ:
        `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.

    - #### getExternalId

          public java.lang.String getExternalId()

      A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see About the External ID in Using Temporary Security Credentials.

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

      戻り値:
        A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see About the External ID in Using Temporary Security Credentials.

    - #### setExternalId

          public void setExternalId(java.lang.String externalId)

      A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see About the External ID in Using Temporary Security Credentials.

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

      パラメータ:
        `externalId` - A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see About the External ID in Using Temporary Security Credentials.

    - #### withExternalId

          public AssumeRoleRequest withExternalId(java.lang.String externalId)

      A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see About the External ID in Using Temporary Security Credentials.

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

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

      パラメータ:
        `externalId` - A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see About the External ID in Using Temporary Security Credentials.

    - #### 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`