com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not
* use this file except in compliance with the License. A copy of the License is
* located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.securitytoken.model;
import java.io.Serializable;
/**
*
* Contains the response to a successful AssumeRoleWithWebIdentity
* request, including temporary AWS credentials that can be used to make AWS
* requests.
*
*/
public class AssumeRoleWithWebIdentityResult implements Serializable, Cloneable {
/**
*
* The temporary security credentials, which include an access key ID, a
* secret access key, and a security token.
*
*
* Note: The size of the security token that STS APIs return is not
* fixed. We strongly recommend that you make no assumptions about the
* maximum size. As of this writing, the typical size is less than 4096
* bytes, but that can vary. Also, future updates to AWS might require
* larger sizes.
*
*/
private Credentials credentials;
/**
*
* The unique user identifier that is returned by the identity provider.
* This identifier is associated with the WebIdentityToken that
* was submitted with the AssumeRoleWithWebIdentity call. The
* identifier is typically unique to the user and the application that
* acquired the WebIdentityToken (pairwise identifier). For
* OpenID Connect ID tokens, this field contains the value returned by the
* identity provider as the token's sub (Subject) claim.
*
*/
private String subjectFromWebIdentityToken;
/**
*
* The Amazon Resource Name (ARN) and the assumed role ID, which are
* identifiers that you can use to refer to the resulting temporary security
* credentials. For example, you can reference these credentials as a
* principal in a resource-based policy by using the ARN or assumed role ID.
* The ARN and ID include the RoleSessionName that you
* specified when you called AssumeRole.
*
*/
private AssumedRoleUser assumedRoleUser;
/**
*
* A percentage value that indicates the size of the policy in packed form.
* The service rejects any policy with a packed size greater than 100
* percent, which means the policy exceeded the allowed space.
*
*/
private Integer packedPolicySize;
/**
*
* The issuing authority of the web identity token presented. For OpenID
* Connect ID Tokens this contains the value of the iss field.
* For OAuth 2.0 access tokens, this contains the value of the
* ProviderId parameter that was passed in the
* AssumeRoleWithWebIdentity request.
*
*/
private String provider;
/**
*
* The intended audience (also known as client ID) of the web identity
* token. This is traditionally the client identifier issued to the
* application that requested the web identity token.
*
*/
private String audience;
/**
*
* The temporary security credentials, which include an access key ID, a
* secret access key, and a security token.
*
*
* Note: The size of the security token that STS APIs return is not
* fixed. We strongly recommend that you make no assumptions about the
* maximum size. As of this writing, the typical size is less than 4096
* bytes, but that can vary. Also, future updates to AWS might require
* larger sizes.
*
*
* @param credentials
* The temporary security credentials, which include an access key
* ID, a secret access key, and a security token.
*
* Note: The size of the security token that STS APIs return
* is not fixed. We strongly recommend that you make no assumptions
* about the maximum size. As of this writing, the typical size is
* less than 4096 bytes, but that can vary. Also, future updates to
* AWS might require larger sizes.
*/
public void setCredentials(Credentials credentials) {
this.credentials = credentials;
}
/**
*
* The temporary security credentials, which include an access key ID, a
* secret access key, and a security token.
*
*
* Note: The size of the security token that STS APIs return is not
* fixed. We strongly recommend that you make no assumptions about the
* maximum size. As of this writing, the typical size is less than 4096
* bytes, but that can vary. Also, future updates to AWS might require
* larger sizes.
*
*
* @return The temporary security credentials, which include an access key
* ID, a secret access key, and a security token.
*
* Note: The size of the security token that STS APIs return
* is not fixed. We strongly recommend that you make no assumptions
* about the maximum size. As of this writing, the typical size is
* less than 4096 bytes, but that can vary. Also, future updates to
* AWS might require larger sizes.
*/
public Credentials getCredentials() {
return this.credentials;
}
/**
*
* The temporary security credentials, which include an access key ID, a
* secret access key, and a security token.
*
*
* Note: The size of the security token that STS APIs return is not
* fixed. We strongly recommend that you make no assumptions about the
* maximum size. As of this writing, the typical size is less than 4096
* bytes, but that can vary. Also, future updates to AWS might require
* larger sizes.
*
*
* @param credentials
* The temporary security credentials, which include an access key
* ID, a secret access key, and a security token.
*
* Note: The size of the security token that STS APIs return
* is not fixed. We strongly recommend that you make no assumptions
* about the maximum size. As of this writing, the typical size is
* less than 4096 bytes, but that can vary. Also, future updates to
* AWS might require larger sizes.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public AssumeRoleWithWebIdentityResult withCredentials(
Credentials credentials) {
setCredentials(credentials);
return this;
}
/**
*
* The unique user identifier that is returned by the identity provider.
* This identifier is associated with the WebIdentityToken that
* was submitted with the AssumeRoleWithWebIdentity call. The
* identifier is typically unique to the user and the application that
* acquired the WebIdentityToken (pairwise identifier). For
* OpenID Connect ID tokens, this field contains the value returned by the
* identity provider as the token's sub (Subject) claim.
*
*
* @param subjectFromWebIdentityToken
* The unique user identifier that is returned by the identity
* provider. This identifier is associated with the
* WebIdentityToken that was submitted with the
* AssumeRoleWithWebIdentity call. The identifier is
* typically unique to the user and the application that acquired the
* WebIdentityToken (pairwise identifier). For OpenID
* Connect ID tokens, this field contains the value returned by the
* identity provider as the token's sub (Subject) claim.
*/
public void setSubjectFromWebIdentityToken(
String subjectFromWebIdentityToken) {
this.subjectFromWebIdentityToken = subjectFromWebIdentityToken;
}
/**
*
* The unique user identifier that is returned by the identity provider.
* This identifier is associated with the WebIdentityToken that
* was submitted with the AssumeRoleWithWebIdentity call. The
* identifier is typically unique to the user and the application that
* acquired the WebIdentityToken (pairwise identifier). For
* OpenID Connect ID tokens, this field contains the value returned by the
* identity provider as the token's sub (Subject) claim.
*
*
* @return The unique user identifier that is returned by the identity
* provider. This identifier is associated with the
* WebIdentityToken that was submitted with the
* AssumeRoleWithWebIdentity call. The identifier is
* typically unique to the user and the application that acquired
* the WebIdentityToken (pairwise identifier). For
* OpenID Connect ID tokens, this field contains the value returned
* by the identity provider as the token's sub
* (Subject) claim.
*/
public String getSubjectFromWebIdentityToken() {
return this.subjectFromWebIdentityToken;
}
/**
*
* The unique user identifier that is returned by the identity provider.
* This identifier is associated with the WebIdentityToken that
* was submitted with the AssumeRoleWithWebIdentity call. The
* identifier is typically unique to the user and the application that
* acquired the WebIdentityToken (pairwise identifier). For
* OpenID Connect ID tokens, this field contains the value returned by the
* identity provider as the token's sub (Subject) claim.
*
*
* @param subjectFromWebIdentityToken
* The unique user identifier that is returned by the identity
* provider. This identifier is associated with the
* WebIdentityToken that was submitted with the
* AssumeRoleWithWebIdentity call. The identifier is
* typically unique to the user and the application that acquired the
* WebIdentityToken (pairwise identifier). For OpenID
* Connect ID tokens, this field contains the value returned by the
* identity provider as the token's sub (Subject) claim.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public AssumeRoleWithWebIdentityResult withSubjectFromWebIdentityToken(
String subjectFromWebIdentityToken) {
setSubjectFromWebIdentityToken(subjectFromWebIdentityToken);
return this;
}
/**
*
* The Amazon Resource Name (ARN) and the assumed role ID, which are
* identifiers that you can use to refer to the resulting temporary security
* credentials. For example, you can reference these credentials as a
* principal in a resource-based policy by using the ARN or assumed role ID.
* The ARN and ID include the RoleSessionName that you
* specified when you called AssumeRole.
*
*
* @param assumedRoleUser
* The Amazon Resource Name (ARN) and the assumed role ID, which are
* identifiers that you can use to refer to the resulting temporary
* security credentials. For example, you can reference these
* credentials as a principal in a resource-based policy by using the
* ARN or assumed role ID. The ARN and ID include the
* RoleSessionName that you specified when you called
* AssumeRole.
*/
public void setAssumedRoleUser(AssumedRoleUser assumedRoleUser) {
this.assumedRoleUser = assumedRoleUser;
}
/**
*
* The Amazon Resource Name (ARN) and the assumed role ID, which are
* identifiers that you can use to refer to the resulting temporary security
* credentials. For example, you can reference these credentials as a
* principal in a resource-based policy by using the ARN or assumed role ID.
* The ARN and ID include the RoleSessionName that you
* specified when you called AssumeRole.
*
*
* @return The Amazon Resource Name (ARN) and the assumed role ID, which are
* identifiers that you can use to refer to the resulting temporary
* security credentials. For example, you can reference these
* credentials as a principal in a resource-based policy by using
* the ARN or assumed role ID. The ARN and ID include the
* RoleSessionName that you specified when you called
* AssumeRole.
*/
public AssumedRoleUser getAssumedRoleUser() {
return this.assumedRoleUser;
}
/**
*
* The Amazon Resource Name (ARN) and the assumed role ID, which are
* identifiers that you can use to refer to the resulting temporary security
* credentials. For example, you can reference these credentials as a
* principal in a resource-based policy by using the ARN or assumed role ID.
* The ARN and ID include the RoleSessionName that you
* specified when you called AssumeRole.
*
*
* @param assumedRoleUser
* The Amazon Resource Name (ARN) and the assumed role ID, which are
* identifiers that you can use to refer to the resulting temporary
* security credentials. For example, you can reference these
* credentials as a principal in a resource-based policy by using the
* ARN or assumed role ID. The ARN and ID include the
* RoleSessionName that you specified when you called
* AssumeRole.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public AssumeRoleWithWebIdentityResult withAssumedRoleUser(
AssumedRoleUser assumedRoleUser) {
setAssumedRoleUser(assumedRoleUser);
return this;
}
/**
*
* A percentage value that indicates the size of the policy in packed form.
* The service rejects any policy with a packed size greater than 100
* percent, which means the policy exceeded the allowed space.
*
*
* @param packedPolicySize
* A percentage value that indicates the size of the policy in packed
* form. The service rejects any policy with a packed size greater
* than 100 percent, which means the policy exceeded the allowed
* space.
*/
public void setPackedPolicySize(Integer packedPolicySize) {
this.packedPolicySize = packedPolicySize;
}
/**
*
* A percentage value that indicates the size of the policy in packed form.
* The service rejects any policy with a packed size greater than 100
* percent, which means the policy exceeded the allowed space.
*
*
* @return A percentage value that indicates the size of the policy in
* packed form. The service rejects any policy with a packed size
* greater than 100 percent, which means the policy exceeded the
* allowed space.
*/
public Integer getPackedPolicySize() {
return this.packedPolicySize;
}
/**
*
* A percentage value that indicates the size of the policy in packed form.
* The service rejects any policy with a packed size greater than 100
* percent, which means the policy exceeded the allowed space.
*
*
* @param packedPolicySize
* A percentage value that indicates the size of the policy in packed
* form. The service rejects any policy with a packed size greater
* than 100 percent, which means the policy exceeded the allowed
* space.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public AssumeRoleWithWebIdentityResult withPackedPolicySize(
Integer packedPolicySize) {
setPackedPolicySize(packedPolicySize);
return this;
}
/**
*
* The issuing authority of the web identity token presented. For OpenID
* Connect ID Tokens this contains the value of the iss field.
* For OAuth 2.0 access tokens, this contains the value of the
* ProviderId parameter that was passed in the
* AssumeRoleWithWebIdentity request.
*
*
* @param provider
* The issuing authority of the web identity token presented. For
* OpenID Connect ID Tokens this contains the value of the
* iss field. For OAuth 2.0 access tokens, this contains
* the value of the ProviderId parameter that was passed
* in the AssumeRoleWithWebIdentity request.
*/
public void setProvider(String provider) {
this.provider = provider;
}
/**
*
* The issuing authority of the web identity token presented. For OpenID
* Connect ID Tokens this contains the value of the iss field.
* For OAuth 2.0 access tokens, this contains the value of the
* ProviderId parameter that was passed in the
* AssumeRoleWithWebIdentity request.
*
*
* @return The issuing authority of the web identity token presented. For
* OpenID Connect ID Tokens this contains the value of the
* iss field. For OAuth 2.0 access tokens, this
* contains the value of the ProviderId parameter that
* was passed in the AssumeRoleWithWebIdentity request.
*/
public String getProvider() {
return this.provider;
}
/**
*
* The issuing authority of the web identity token presented. For OpenID
* Connect ID Tokens this contains the value of the iss field.
* For OAuth 2.0 access tokens, this contains the value of the
* ProviderId parameter that was passed in the
* AssumeRoleWithWebIdentity request.
*
*
* @param provider
* The issuing authority of the web identity token presented. For
* OpenID Connect ID Tokens this contains the value of the
* iss field. For OAuth 2.0 access tokens, this contains
* the value of the ProviderId parameter that was passed
* in the AssumeRoleWithWebIdentity request.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public AssumeRoleWithWebIdentityResult withProvider(String provider) {
setProvider(provider);
return this;
}
/**
*
* The intended audience (also known as client ID) of the web identity
* token. This is traditionally the client identifier issued to the
* application that requested the web identity token.
*
*
* @param audience
* The intended audience (also known as client ID) of the web
* identity token. This is traditionally the client identifier issued
* to the application that requested the web identity token.
*/
public void setAudience(String audience) {
this.audience = audience;
}
/**
*
* The intended audience (also known as client ID) of the web identity
* token. This is traditionally the client identifier issued to the
* application that requested the web identity token.
*
*
* @return The intended audience (also known as client ID) of the web
* identity token. This is traditionally the client identifier
* issued to the application that requested the web identity token.
*/
public String getAudience() {
return this.audience;
}
/**
*
* The intended audience (also known as client ID) of the web identity
* token. This is traditionally the client identifier issued to the
* application that requested the web identity token.
*
*
* @param audience
* The intended audience (also known as client ID) of the web
* identity token. This is traditionally the client identifier issued
* to the application that requested the web identity token.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public AssumeRoleWithWebIdentityResult withAudience(String audience) {
setAudience(audience);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCredentials() != null)
sb.append("Credentials: " + getCredentials() + ",");
if (getSubjectFromWebIdentityToken() != null)
sb.append("SubjectFromWebIdentityToken: "
+ getSubjectFromWebIdentityToken() + ",");
if (getAssumedRoleUser() != null)
sb.append("AssumedRoleUser: " + getAssumedRoleUser() + ",");
if (getPackedPolicySize() != null)
sb.append("PackedPolicySize: " + getPackedPolicySize() + ",");
if (getProvider() != null)
sb.append("Provider: " + getProvider() + ",");
if (getAudience() != null)
sb.append("Audience: " + getAudience());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AssumeRoleWithWebIdentityResult == false)
return false;
AssumeRoleWithWebIdentityResult other = (AssumeRoleWithWebIdentityResult) obj;
if (other.getCredentials() == null ^ this.getCredentials() == null)
return false;
if (other.getCredentials() != null
&& other.getCredentials().equals(this.getCredentials()) == false)
return false;
if (other.getSubjectFromWebIdentityToken() == null
^ this.getSubjectFromWebIdentityToken() == null)
return false;
if (other.getSubjectFromWebIdentityToken() != null
&& other.getSubjectFromWebIdentityToken().equals(
this.getSubjectFromWebIdentityToken()) == false)
return false;
if (other.getAssumedRoleUser() == null
^ this.getAssumedRoleUser() == null)
return false;
if (other.getAssumedRoleUser() != null
&& other.getAssumedRoleUser().equals(this.getAssumedRoleUser()) == false)
return false;
if (other.getPackedPolicySize() == null
^ this.getPackedPolicySize() == null)
return false;
if (other.getPackedPolicySize() != null
&& other.getPackedPolicySize().equals(
this.getPackedPolicySize()) == false)
return false;
if (other.getProvider() == null ^ this.getProvider() == null)
return false;
if (other.getProvider() != null
&& other.getProvider().equals(this.getProvider()) == false)
return false;
if (other.getAudience() == null ^ this.getAudience() == null)
return false;
if (other.getAudience() != null
&& other.getAudience().equals(this.getAudience()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getCredentials() == null) ? 0 : getCredentials().hashCode());
hashCode = prime
* hashCode
+ ((getSubjectFromWebIdentityToken() == null) ? 0
: getSubjectFromWebIdentityToken().hashCode());
hashCode = prime
* hashCode
+ ((getAssumedRoleUser() == null) ? 0 : getAssumedRoleUser()
.hashCode());
hashCode = prime
* hashCode
+ ((getPackedPolicySize() == null) ? 0 : getPackedPolicySize()
.hashCode());
hashCode = prime * hashCode
+ ((getProvider() == null) ? 0 : getProvider().hashCode());
hashCode = prime * hashCode
+ ((getAudience() == null) ? 0 : getAudience().hashCode());
return hashCode;
}
@Override
public AssumeRoleWithWebIdentityResult clone() {
try {
return (AssumeRoleWithWebIdentityResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}