180 lines
7.3 KiB
C++
180 lines
7.3 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/sts/model/FederatedUser.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>GetFederationToken</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/GetFederationTokenResponse">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_STS_API GetFederationTokenResult
|
|
{
|
|
public:
|
|
GetFederationTokenResult();
|
|
GetFederationTokenResult(const Aws::AmazonWebServiceResult<Aws::Utils::Xml::XmlDocument>& result);
|
|
GetFederationTokenResult& 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 (or session) 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 (or session) 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 (or session) 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 (or session) 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 GetFederationTokenResult& 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 (or session) 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 GetFederationTokenResult& WithCredentials(Credentials&& value) { SetCredentials(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Identifiers for the federated user associated with the credentials (such as
|
|
* <code>arn:aws:sts::123456789012:federated-user/Bob</code> or
|
|
* <code>123456789012:Bob</code>). You can use the federated user's ARN in your
|
|
* resource-based policies, such as an Amazon S3 bucket policy. </p>
|
|
*/
|
|
inline const FederatedUser& GetFederatedUser() const{ return m_federatedUser; }
|
|
|
|
/**
|
|
* <p>Identifiers for the federated user associated with the credentials (such as
|
|
* <code>arn:aws:sts::123456789012:federated-user/Bob</code> or
|
|
* <code>123456789012:Bob</code>). You can use the federated user's ARN in your
|
|
* resource-based policies, such as an Amazon S3 bucket policy. </p>
|
|
*/
|
|
inline void SetFederatedUser(const FederatedUser& value) { m_federatedUser = value; }
|
|
|
|
/**
|
|
* <p>Identifiers for the federated user associated with the credentials (such as
|
|
* <code>arn:aws:sts::123456789012:federated-user/Bob</code> or
|
|
* <code>123456789012:Bob</code>). You can use the federated user's ARN in your
|
|
* resource-based policies, such as an Amazon S3 bucket policy. </p>
|
|
*/
|
|
inline void SetFederatedUser(FederatedUser&& value) { m_federatedUser = std::move(value); }
|
|
|
|
/**
|
|
* <p>Identifiers for the federated user associated with the credentials (such as
|
|
* <code>arn:aws:sts::123456789012:federated-user/Bob</code> or
|
|
* <code>123456789012:Bob</code>). You can use the federated user's ARN in your
|
|
* resource-based policies, such as an Amazon S3 bucket policy. </p>
|
|
*/
|
|
inline GetFederationTokenResult& WithFederatedUser(const FederatedUser& value) { SetFederatedUser(value); return *this;}
|
|
|
|
/**
|
|
* <p>Identifiers for the federated user associated with the credentials (such as
|
|
* <code>arn:aws:sts::123456789012:federated-user/Bob</code> or
|
|
* <code>123456789012:Bob</code>). You can use the federated user's ARN in your
|
|
* resource-based policies, such as an Amazon S3 bucket policy. </p>
|
|
*/
|
|
inline GetFederationTokenResult& WithFederatedUser(FederatedUser&& value) { SetFederatedUser(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 GetFederationTokenResult& WithPackedPolicySize(int value) { SetPackedPolicySize(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 GetFederationTokenResult& WithResponseMetadata(const ResponseMetadata& value) { SetResponseMetadata(value); return *this;}
|
|
|
|
|
|
inline GetFederationTokenResult& WithResponseMetadata(ResponseMetadata&& value) { SetResponseMetadata(std::move(value)); return *this;}
|
|
|
|
private:
|
|
|
|
Credentials m_credentials;
|
|
|
|
FederatedUser m_federatedUser;
|
|
|
|
int m_packedPolicySize;
|
|
|
|
ResponseMetadata m_responseMetadata;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace STS
|
|
} // namespace Aws
|