389 lines
18 KiB
C++
389 lines
18 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/sts/STS_EXPORTS.h>
|
|
#include <aws/sts/model/Credentials.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/sts/model/AssumedRoleUser.h>
|
|
#include <aws/sts/model/ResponseMetadata.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
template<typename RESULT_TYPE>
|
|
class AmazonWebServiceResult;
|
|
|
|
namespace Utils
|
|
{
|
|
namespace Xml
|
|
{
|
|
class XmlDocument;
|
|
} // namespace Xml
|
|
} // namespace Utils
|
|
namespace STS
|
|
{
|
|
namespace Model
|
|
{
|
|
/**
|
|
* <p>Contains the response to a successful <a>AssumeRoleWithWebIdentity</a>
|
|
* request, including temporary AWS credentials that can be used to make AWS
|
|
* requests. </p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentityResponse">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_STS_API AssumeRoleWithWebIdentityResult
|
|
{
|
|
public:
|
|
AssumeRoleWithWebIdentityResult();
|
|
AssumeRoleWithWebIdentityResult(const Aws::AmazonWebServiceResult<Aws::Utils::Xml::XmlDocument>& result);
|
|
AssumeRoleWithWebIdentityResult& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Xml::XmlDocument>& result);
|
|
|
|
|
|
/**
|
|
* <p>The temporary security credentials, which include an access key ID, a secret
|
|
* access key, and a security token.</p> <p>The size of the security token
|
|
* that STS API operations return is not fixed. We strongly recommend that you make
|
|
* no assumptions about the maximum size.</p>
|
|
*/
|
|
inline const Credentials& GetCredentials() const{ return m_credentials; }
|
|
|
|
/**
|
|
* <p>The temporary security credentials, which include an access key ID, a secret
|
|
* access key, and a security token.</p> <p>The size of the security token
|
|
* that STS API operations return is not fixed. We strongly recommend that you make
|
|
* no assumptions about the maximum size.</p>
|
|
*/
|
|
inline void SetCredentials(const Credentials& value) { m_credentials = value; }
|
|
|
|
/**
|
|
* <p>The temporary security credentials, which include an access key ID, a secret
|
|
* access key, and a security token.</p> <p>The size of the security token
|
|
* that STS API operations return is not fixed. We strongly recommend that you make
|
|
* no assumptions about the maximum size.</p>
|
|
*/
|
|
inline void SetCredentials(Credentials&& value) { m_credentials = std::move(value); }
|
|
|
|
/**
|
|
* <p>The temporary security credentials, which include an access key ID, a secret
|
|
* access key, and a security token.</p> <p>The size of the security token
|
|
* that STS API operations return is not fixed. We strongly recommend that you make
|
|
* no assumptions about the maximum size.</p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithCredentials(const Credentials& value) { SetCredentials(value); return *this;}
|
|
|
|
/**
|
|
* <p>The temporary security credentials, which include an access key ID, a secret
|
|
* access key, and a security token.</p> <p>The size of the security token
|
|
* that STS API operations return is not fixed. We strongly recommend that you make
|
|
* no assumptions about the maximum size.</p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithCredentials(Credentials&& value) { SetCredentials(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The unique user identifier that is returned by the identity provider. This
|
|
* identifier is associated with the <code>WebIdentityToken</code> that was
|
|
* submitted with the <code>AssumeRoleWithWebIdentity</code> call. The identifier
|
|
* is typically unique to the user and the application that acquired the
|
|
* <code>WebIdentityToken</code> (pairwise identifier). For OpenID Connect ID
|
|
* tokens, this field contains the value returned by the identity provider as the
|
|
* token's <code>sub</code> (Subject) claim. </p>
|
|
*/
|
|
inline const Aws::String& GetSubjectFromWebIdentityToken() const{ return m_subjectFromWebIdentityToken; }
|
|
|
|
/**
|
|
* <p>The unique user identifier that is returned by the identity provider. This
|
|
* identifier is associated with the <code>WebIdentityToken</code> that was
|
|
* submitted with the <code>AssumeRoleWithWebIdentity</code> call. The identifier
|
|
* is typically unique to the user and the application that acquired the
|
|
* <code>WebIdentityToken</code> (pairwise identifier). For OpenID Connect ID
|
|
* tokens, this field contains the value returned by the identity provider as the
|
|
* token's <code>sub</code> (Subject) claim. </p>
|
|
*/
|
|
inline void SetSubjectFromWebIdentityToken(const Aws::String& value) { m_subjectFromWebIdentityToken = value; }
|
|
|
|
/**
|
|
* <p>The unique user identifier that is returned by the identity provider. This
|
|
* identifier is associated with the <code>WebIdentityToken</code> that was
|
|
* submitted with the <code>AssumeRoleWithWebIdentity</code> call. The identifier
|
|
* is typically unique to the user and the application that acquired the
|
|
* <code>WebIdentityToken</code> (pairwise identifier). For OpenID Connect ID
|
|
* tokens, this field contains the value returned by the identity provider as the
|
|
* token's <code>sub</code> (Subject) claim. </p>
|
|
*/
|
|
inline void SetSubjectFromWebIdentityToken(Aws::String&& value) { m_subjectFromWebIdentityToken = std::move(value); }
|
|
|
|
/**
|
|
* <p>The unique user identifier that is returned by the identity provider. This
|
|
* identifier is associated with the <code>WebIdentityToken</code> that was
|
|
* submitted with the <code>AssumeRoleWithWebIdentity</code> call. The identifier
|
|
* is typically unique to the user and the application that acquired the
|
|
* <code>WebIdentityToken</code> (pairwise identifier). For OpenID Connect ID
|
|
* tokens, this field contains the value returned by the identity provider as the
|
|
* token's <code>sub</code> (Subject) claim. </p>
|
|
*/
|
|
inline void SetSubjectFromWebIdentityToken(const char* value) { m_subjectFromWebIdentityToken.assign(value); }
|
|
|
|
/**
|
|
* <p>The unique user identifier that is returned by the identity provider. This
|
|
* identifier is associated with the <code>WebIdentityToken</code> that was
|
|
* submitted with the <code>AssumeRoleWithWebIdentity</code> call. The identifier
|
|
* is typically unique to the user and the application that acquired the
|
|
* <code>WebIdentityToken</code> (pairwise identifier). For OpenID Connect ID
|
|
* tokens, this field contains the value returned by the identity provider as the
|
|
* token's <code>sub</code> (Subject) claim. </p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithSubjectFromWebIdentityToken(const Aws::String& value) { SetSubjectFromWebIdentityToken(value); return *this;}
|
|
|
|
/**
|
|
* <p>The unique user identifier that is returned by the identity provider. This
|
|
* identifier is associated with the <code>WebIdentityToken</code> that was
|
|
* submitted with the <code>AssumeRoleWithWebIdentity</code> call. The identifier
|
|
* is typically unique to the user and the application that acquired the
|
|
* <code>WebIdentityToken</code> (pairwise identifier). For OpenID Connect ID
|
|
* tokens, this field contains the value returned by the identity provider as the
|
|
* token's <code>sub</code> (Subject) claim. </p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithSubjectFromWebIdentityToken(Aws::String&& value) { SetSubjectFromWebIdentityToken(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The unique user identifier that is returned by the identity provider. This
|
|
* identifier is associated with the <code>WebIdentityToken</code> that was
|
|
* submitted with the <code>AssumeRoleWithWebIdentity</code> call. The identifier
|
|
* is typically unique to the user and the application that acquired the
|
|
* <code>WebIdentityToken</code> (pairwise identifier). For OpenID Connect ID
|
|
* tokens, this field contains the value returned by the identity provider as the
|
|
* token's <code>sub</code> (Subject) claim. </p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithSubjectFromWebIdentityToken(const char* value) { SetSubjectFromWebIdentityToken(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>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
|
|
* <code>RoleSessionName</code> that you specified when you called
|
|
* <code>AssumeRole</code>. </p>
|
|
*/
|
|
inline const AssumedRoleUser& GetAssumedRoleUser() const{ return m_assumedRoleUser; }
|
|
|
|
/**
|
|
* <p>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
|
|
* <code>RoleSessionName</code> that you specified when you called
|
|
* <code>AssumeRole</code>. </p>
|
|
*/
|
|
inline void SetAssumedRoleUser(const AssumedRoleUser& value) { m_assumedRoleUser = value; }
|
|
|
|
/**
|
|
* <p>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
|
|
* <code>RoleSessionName</code> that you specified when you called
|
|
* <code>AssumeRole</code>. </p>
|
|
*/
|
|
inline void SetAssumedRoleUser(AssumedRoleUser&& value) { m_assumedRoleUser = std::move(value); }
|
|
|
|
/**
|
|
* <p>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
|
|
* <code>RoleSessionName</code> that you specified when you called
|
|
* <code>AssumeRole</code>. </p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithAssumedRoleUser(const AssumedRoleUser& value) { SetAssumedRoleUser(value); return *this;}
|
|
|
|
/**
|
|
* <p>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
|
|
* <code>RoleSessionName</code> that you specified when you called
|
|
* <code>AssumeRole</code>. </p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithAssumedRoleUser(AssumedRoleUser&& value) { SetAssumedRoleUser(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A percentage value that indicates the packed size of the session policies and
|
|
* session tags combined passed in the request. The request fails if the packed
|
|
* size is greater than 100 percent, which means the policies and tags exceeded the
|
|
* allowed space.</p>
|
|
*/
|
|
inline int GetPackedPolicySize() const{ return m_packedPolicySize; }
|
|
|
|
/**
|
|
* <p>A percentage value that indicates the packed size of the session policies and
|
|
* session tags combined passed in the request. The request fails if the packed
|
|
* size is greater than 100 percent, which means the policies and tags exceeded the
|
|
* allowed space.</p>
|
|
*/
|
|
inline void SetPackedPolicySize(int value) { m_packedPolicySize = value; }
|
|
|
|
/**
|
|
* <p>A percentage value that indicates the packed size of the session policies and
|
|
* session tags combined passed in the request. The request fails if the packed
|
|
* size is greater than 100 percent, which means the policies and tags exceeded the
|
|
* allowed space.</p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithPackedPolicySize(int value) { SetPackedPolicySize(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p> The issuing authority of the web identity token presented. For OpenID
|
|
* Connect ID tokens, this contains the value of the <code>iss</code> field. For
|
|
* OAuth 2.0 access tokens, this contains the value of the <code>ProviderId</code>
|
|
* parameter that was passed in the <code>AssumeRoleWithWebIdentity</code>
|
|
* request.</p>
|
|
*/
|
|
inline const Aws::String& GetProvider() const{ return m_provider; }
|
|
|
|
/**
|
|
* <p> The issuing authority of the web identity token presented. For OpenID
|
|
* Connect ID tokens, this contains the value of the <code>iss</code> field. For
|
|
* OAuth 2.0 access tokens, this contains the value of the <code>ProviderId</code>
|
|
* parameter that was passed in the <code>AssumeRoleWithWebIdentity</code>
|
|
* request.</p>
|
|
*/
|
|
inline void SetProvider(const Aws::String& value) { m_provider = value; }
|
|
|
|
/**
|
|
* <p> The issuing authority of the web identity token presented. For OpenID
|
|
* Connect ID tokens, this contains the value of the <code>iss</code> field. For
|
|
* OAuth 2.0 access tokens, this contains the value of the <code>ProviderId</code>
|
|
* parameter that was passed in the <code>AssumeRoleWithWebIdentity</code>
|
|
* request.</p>
|
|
*/
|
|
inline void SetProvider(Aws::String&& value) { m_provider = std::move(value); }
|
|
|
|
/**
|
|
* <p> The issuing authority of the web identity token presented. For OpenID
|
|
* Connect ID tokens, this contains the value of the <code>iss</code> field. For
|
|
* OAuth 2.0 access tokens, this contains the value of the <code>ProviderId</code>
|
|
* parameter that was passed in the <code>AssumeRoleWithWebIdentity</code>
|
|
* request.</p>
|
|
*/
|
|
inline void SetProvider(const char* value) { m_provider.assign(value); }
|
|
|
|
/**
|
|
* <p> The issuing authority of the web identity token presented. For OpenID
|
|
* Connect ID tokens, this contains the value of the <code>iss</code> field. For
|
|
* OAuth 2.0 access tokens, this contains the value of the <code>ProviderId</code>
|
|
* parameter that was passed in the <code>AssumeRoleWithWebIdentity</code>
|
|
* request.</p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithProvider(const Aws::String& value) { SetProvider(value); return *this;}
|
|
|
|
/**
|
|
* <p> The issuing authority of the web identity token presented. For OpenID
|
|
* Connect ID tokens, this contains the value of the <code>iss</code> field. For
|
|
* OAuth 2.0 access tokens, this contains the value of the <code>ProviderId</code>
|
|
* parameter that was passed in the <code>AssumeRoleWithWebIdentity</code>
|
|
* request.</p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithProvider(Aws::String&& value) { SetProvider(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p> The issuing authority of the web identity token presented. For OpenID
|
|
* Connect ID tokens, this contains the value of the <code>iss</code> field. For
|
|
* OAuth 2.0 access tokens, this contains the value of the <code>ProviderId</code>
|
|
* parameter that was passed in the <code>AssumeRoleWithWebIdentity</code>
|
|
* request.</p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithProvider(const char* value) { SetProvider(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline const Aws::String& GetAudience() const{ return m_audience; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline void SetAudience(const Aws::String& value) { m_audience = value; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline void SetAudience(Aws::String&& value) { m_audience = std::move(value); }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline void SetAudience(const char* value) { m_audience.assign(value); }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithAudience(const Aws::String& value) { SetAudience(value); return *this;}
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithAudience(Aws::String&& value) { SetAudience(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AssumeRoleWithWebIdentityResult& WithAudience(const char* value) { SetAudience(value); return *this;}
|
|
|
|
|
|
|
|
inline const ResponseMetadata& GetResponseMetadata() const{ return m_responseMetadata; }
|
|
|
|
|
|
inline void SetResponseMetadata(const ResponseMetadata& value) { m_responseMetadata = value; }
|
|
|
|
|
|
inline void SetResponseMetadata(ResponseMetadata&& value) { m_responseMetadata = std::move(value); }
|
|
|
|
|
|
inline AssumeRoleWithWebIdentityResult& WithResponseMetadata(const ResponseMetadata& value) { SetResponseMetadata(value); return *this;}
|
|
|
|
|
|
inline AssumeRoleWithWebIdentityResult& WithResponseMetadata(ResponseMetadata&& value) { SetResponseMetadata(std::move(value)); return *this;}
|
|
|
|
private:
|
|
|
|
Credentials m_credentials;
|
|
|
|
Aws::String m_subjectFromWebIdentityToken;
|
|
|
|
AssumedRoleUser m_assumedRoleUser;
|
|
|
|
int m_packedPolicySize;
|
|
|
|
Aws::String m_provider;
|
|
|
|
Aws::String m_audience;
|
|
|
|
ResponseMetadata m_responseMetadata;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace STS
|
|
} // namespace Aws
|