722 lines
44 KiB
C++
722 lines
44 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/STSRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/sts/model/PolicyDescriptorType.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace STS
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_STS_API AssumeRoleWithSAMLRequest : public STSRequest
|
|
{
|
|
public:
|
|
AssumeRoleWithSAMLRequest();
|
|
|
|
// Service request name is the Operation name which will send this request out,
|
|
// each operation should has unique request name, so that we can get operation's name from this request.
|
|
// Note: this is not true for response, multiple operations may have the same response name,
|
|
// so we can not get operation's name from response.
|
|
inline virtual const char* GetServiceRequestName() const override { return "AssumeRoleWithSAML"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
protected:
|
|
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
|
|
|
|
public:
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
|
|
*/
|
|
inline const Aws::String& GetRoleArn() const{ return m_roleArn; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
|
|
*/
|
|
inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
|
|
*/
|
|
inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
|
|
*/
|
|
inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
|
|
*/
|
|
inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;}
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
|
|
* IdP.</p>
|
|
*/
|
|
inline const Aws::String& GetPrincipalArn() const{ return m_principalArn; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
|
|
* IdP.</p>
|
|
*/
|
|
inline bool PrincipalArnHasBeenSet() const { return m_principalArnHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
|
|
* IdP.</p>
|
|
*/
|
|
inline void SetPrincipalArn(const Aws::String& value) { m_principalArnHasBeenSet = true; m_principalArn = value; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
|
|
* IdP.</p>
|
|
*/
|
|
inline void SetPrincipalArn(Aws::String&& value) { m_principalArnHasBeenSet = true; m_principalArn = std::move(value); }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
|
|
* IdP.</p>
|
|
*/
|
|
inline void SetPrincipalArn(const char* value) { m_principalArnHasBeenSet = true; m_principalArn.assign(value); }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
|
|
* IdP.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithPrincipalArn(const Aws::String& value) { SetPrincipalArn(value); return *this;}
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
|
|
* IdP.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithPrincipalArn(Aws::String&& value) { SetPrincipalArn(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
|
|
* IdP.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithPrincipalArn(const char* value) { SetPrincipalArn(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The base-64 encoded SAML authentication response provided by the IdP.</p>
|
|
* <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring
|
|
* a Relying Party and Adding Claims</a> in the <i>IAM User Guide</i>. </p>
|
|
*/
|
|
inline const Aws::String& GetSAMLAssertion() const{ return m_sAMLAssertion; }
|
|
|
|
/**
|
|
* <p>The base-64 encoded SAML authentication response provided by the IdP.</p>
|
|
* <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring
|
|
* a Relying Party and Adding Claims</a> in the <i>IAM User Guide</i>. </p>
|
|
*/
|
|
inline bool SAMLAssertionHasBeenSet() const { return m_sAMLAssertionHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The base-64 encoded SAML authentication response provided by the IdP.</p>
|
|
* <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring
|
|
* a Relying Party and Adding Claims</a> in the <i>IAM User Guide</i>. </p>
|
|
*/
|
|
inline void SetSAMLAssertion(const Aws::String& value) { m_sAMLAssertionHasBeenSet = true; m_sAMLAssertion = value; }
|
|
|
|
/**
|
|
* <p>The base-64 encoded SAML authentication response provided by the IdP.</p>
|
|
* <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring
|
|
* a Relying Party and Adding Claims</a> in the <i>IAM User Guide</i>. </p>
|
|
*/
|
|
inline void SetSAMLAssertion(Aws::String&& value) { m_sAMLAssertionHasBeenSet = true; m_sAMLAssertion = std::move(value); }
|
|
|
|
/**
|
|
* <p>The base-64 encoded SAML authentication response provided by the IdP.</p>
|
|
* <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring
|
|
* a Relying Party and Adding Claims</a> in the <i>IAM User Guide</i>. </p>
|
|
*/
|
|
inline void SetSAMLAssertion(const char* value) { m_sAMLAssertionHasBeenSet = true; m_sAMLAssertion.assign(value); }
|
|
|
|
/**
|
|
* <p>The base-64 encoded SAML authentication response provided by the IdP.</p>
|
|
* <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring
|
|
* a Relying Party and Adding Claims</a> in the <i>IAM User Guide</i>. </p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithSAMLAssertion(const Aws::String& value) { SetSAMLAssertion(value); return *this;}
|
|
|
|
/**
|
|
* <p>The base-64 encoded SAML authentication response provided by the IdP.</p>
|
|
* <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring
|
|
* a Relying Party and Adding Claims</a> in the <i>IAM User Guide</i>. </p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithSAMLAssertion(Aws::String&& value) { SetSAMLAssertion(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The base-64 encoded SAML authentication response provided by the IdP.</p>
|
|
* <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring
|
|
* a Relying Party and Adding Claims</a> in the <i>IAM User Guide</i>. </p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithSAMLAssertion(const char* value) { SetSAMLAssertion(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to
|
|
* use as managed session policies. The policies must exist in the same account as
|
|
* the role.</p> <p>This parameter is optional. You can provide up to 10 managed
|
|
* policy ARNs. However, the plain text that you use for both inline and managed
|
|
* session policies can't exceed 2,048 characters. For more information about ARNs,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General
|
|
* Reference.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p> <p>Passing policies to this operation returns new
|
|
* temporary credentials. The resulting session's permissions are the intersection
|
|
* of the role's identity-based policy and the session policies. You can use the
|
|
* role's temporary credentials in subsequent AWS API calls to access resources in
|
|
* the account that owns the role. You cannot use session policies to grant more
|
|
* permissions than those allowed by the identity-based policy of the role that is
|
|
* being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline const Aws::Vector<PolicyDescriptorType>& GetPolicyArns() const{ return m_policyArns; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to
|
|
* use as managed session policies. The policies must exist in the same account as
|
|
* the role.</p> <p>This parameter is optional. You can provide up to 10 managed
|
|
* policy ARNs. However, the plain text that you use for both inline and managed
|
|
* session policies can't exceed 2,048 characters. For more information about ARNs,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General
|
|
* Reference.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p> <p>Passing policies to this operation returns new
|
|
* temporary credentials. The resulting session's permissions are the intersection
|
|
* of the role's identity-based policy and the session policies. You can use the
|
|
* role's temporary credentials in subsequent AWS API calls to access resources in
|
|
* the account that owns the role. You cannot use session policies to grant more
|
|
* permissions than those allowed by the identity-based policy of the role that is
|
|
* being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline bool PolicyArnsHasBeenSet() const { return m_policyArnsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to
|
|
* use as managed session policies. The policies must exist in the same account as
|
|
* the role.</p> <p>This parameter is optional. You can provide up to 10 managed
|
|
* policy ARNs. However, the plain text that you use for both inline and managed
|
|
* session policies can't exceed 2,048 characters. For more information about ARNs,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General
|
|
* Reference.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p> <p>Passing policies to this operation returns new
|
|
* temporary credentials. The resulting session's permissions are the intersection
|
|
* of the role's identity-based policy and the session policies. You can use the
|
|
* role's temporary credentials in subsequent AWS API calls to access resources in
|
|
* the account that owns the role. You cannot use session policies to grant more
|
|
* permissions than those allowed by the identity-based policy of the role that is
|
|
* being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline void SetPolicyArns(const Aws::Vector<PolicyDescriptorType>& value) { m_policyArnsHasBeenSet = true; m_policyArns = value; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to
|
|
* use as managed session policies. The policies must exist in the same account as
|
|
* the role.</p> <p>This parameter is optional. You can provide up to 10 managed
|
|
* policy ARNs. However, the plain text that you use for both inline and managed
|
|
* session policies can't exceed 2,048 characters. For more information about ARNs,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General
|
|
* Reference.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p> <p>Passing policies to this operation returns new
|
|
* temporary credentials. The resulting session's permissions are the intersection
|
|
* of the role's identity-based policy and the session policies. You can use the
|
|
* role's temporary credentials in subsequent AWS API calls to access resources in
|
|
* the account that owns the role. You cannot use session policies to grant more
|
|
* permissions than those allowed by the identity-based policy of the role that is
|
|
* being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline void SetPolicyArns(Aws::Vector<PolicyDescriptorType>&& value) { m_policyArnsHasBeenSet = true; m_policyArns = std::move(value); }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to
|
|
* use as managed session policies. The policies must exist in the same account as
|
|
* the role.</p> <p>This parameter is optional. You can provide up to 10 managed
|
|
* policy ARNs. However, the plain text that you use for both inline and managed
|
|
* session policies can't exceed 2,048 characters. For more information about ARNs,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General
|
|
* Reference.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p> <p>Passing policies to this operation returns new
|
|
* temporary credentials. The resulting session's permissions are the intersection
|
|
* of the role's identity-based policy and the session policies. You can use the
|
|
* role's temporary credentials in subsequent AWS API calls to access resources in
|
|
* the account that owns the role. You cannot use session policies to grant more
|
|
* permissions than those allowed by the identity-based policy of the role that is
|
|
* being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithPolicyArns(const Aws::Vector<PolicyDescriptorType>& value) { SetPolicyArns(value); return *this;}
|
|
|
|
/**
|
|
* <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to
|
|
* use as managed session policies. The policies must exist in the same account as
|
|
* the role.</p> <p>This parameter is optional. You can provide up to 10 managed
|
|
* policy ARNs. However, the plain text that you use for both inline and managed
|
|
* session policies can't exceed 2,048 characters. For more information about ARNs,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General
|
|
* Reference.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p> <p>Passing policies to this operation returns new
|
|
* temporary credentials. The resulting session's permissions are the intersection
|
|
* of the role's identity-based policy and the session policies. You can use the
|
|
* role's temporary credentials in subsequent AWS API calls to access resources in
|
|
* the account that owns the role. You cannot use session policies to grant more
|
|
* permissions than those allowed by the identity-based policy of the role that is
|
|
* being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithPolicyArns(Aws::Vector<PolicyDescriptorType>&& value) { SetPolicyArns(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to
|
|
* use as managed session policies. The policies must exist in the same account as
|
|
* the role.</p> <p>This parameter is optional. You can provide up to 10 managed
|
|
* policy ARNs. However, the plain text that you use for both inline and managed
|
|
* session policies can't exceed 2,048 characters. For more information about ARNs,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General
|
|
* Reference.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p> <p>Passing policies to this operation returns new
|
|
* temporary credentials. The resulting session's permissions are the intersection
|
|
* of the role's identity-based policy and the session policies. You can use the
|
|
* role's temporary credentials in subsequent AWS API calls to access resources in
|
|
* the account that owns the role. You cannot use session policies to grant more
|
|
* permissions than those allowed by the identity-based policy of the role that is
|
|
* being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& AddPolicyArns(const PolicyDescriptorType& value) { m_policyArnsHasBeenSet = true; m_policyArns.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to
|
|
* use as managed session policies. The policies must exist in the same account as
|
|
* the role.</p> <p>This parameter is optional. You can provide up to 10 managed
|
|
* policy ARNs. However, the plain text that you use for both inline and managed
|
|
* session policies can't exceed 2,048 characters. For more information about ARNs,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General
|
|
* Reference.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p> <p>Passing policies to this operation returns new
|
|
* temporary credentials. The resulting session's permissions are the intersection
|
|
* of the role's identity-based policy and the session policies. You can use the
|
|
* role's temporary credentials in subsequent AWS API calls to access resources in
|
|
* the account that owns the role. You cannot use session policies to grant more
|
|
* permissions than those allowed by the identity-based policy of the role that is
|
|
* being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& AddPolicyArns(PolicyDescriptorType&& value) { m_policyArnsHasBeenSet = true; m_policyArns.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>An IAM policy in JSON format that you want to use as an inline session
|
|
* policy.</p> <p>This parameter is optional. Passing policies to this operation
|
|
* returns new temporary credentials. The resulting session's permissions are the
|
|
* intersection of the role's identity-based policy and the session policies. You
|
|
* can use the role's temporary credentials in subsequent AWS API calls to access
|
|
* resources in the account that owns the role. You cannot use session policies to
|
|
* grant more permissions than those allowed by the identity-based policy of the
|
|
* role that is being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>. </p> <p>The plain text that you use
|
|
* for both inline and managed session policies can't exceed 2,048 characters. The
|
|
* JSON policy characters can be any ASCII character from the space character to
|
|
* the end of the valid character list (\u0020 through \u00FF). It can also include
|
|
* the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
|
|
* characters.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p>
|
|
*/
|
|
inline const Aws::String& GetPolicy() const{ return m_policy; }
|
|
|
|
/**
|
|
* <p>An IAM policy in JSON format that you want to use as an inline session
|
|
* policy.</p> <p>This parameter is optional. Passing policies to this operation
|
|
* returns new temporary credentials. The resulting session's permissions are the
|
|
* intersection of the role's identity-based policy and the session policies. You
|
|
* can use the role's temporary credentials in subsequent AWS API calls to access
|
|
* resources in the account that owns the role. You cannot use session policies to
|
|
* grant more permissions than those allowed by the identity-based policy of the
|
|
* role that is being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>. </p> <p>The plain text that you use
|
|
* for both inline and managed session policies can't exceed 2,048 characters. The
|
|
* JSON policy characters can be any ASCII character from the space character to
|
|
* the end of the valid character list (\u0020 through \u00FF). It can also include
|
|
* the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
|
|
* characters.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p>
|
|
*/
|
|
inline bool PolicyHasBeenSet() const { return m_policyHasBeenSet; }
|
|
|
|
/**
|
|
* <p>An IAM policy in JSON format that you want to use as an inline session
|
|
* policy.</p> <p>This parameter is optional. Passing policies to this operation
|
|
* returns new temporary credentials. The resulting session's permissions are the
|
|
* intersection of the role's identity-based policy and the session policies. You
|
|
* can use the role's temporary credentials in subsequent AWS API calls to access
|
|
* resources in the account that owns the role. You cannot use session policies to
|
|
* grant more permissions than those allowed by the identity-based policy of the
|
|
* role that is being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>. </p> <p>The plain text that you use
|
|
* for both inline and managed session policies can't exceed 2,048 characters. The
|
|
* JSON policy characters can be any ASCII character from the space character to
|
|
* the end of the valid character list (\u0020 through \u00FF). It can also include
|
|
* the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
|
|
* characters.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p>
|
|
*/
|
|
inline void SetPolicy(const Aws::String& value) { m_policyHasBeenSet = true; m_policy = value; }
|
|
|
|
/**
|
|
* <p>An IAM policy in JSON format that you want to use as an inline session
|
|
* policy.</p> <p>This parameter is optional. Passing policies to this operation
|
|
* returns new temporary credentials. The resulting session's permissions are the
|
|
* intersection of the role's identity-based policy and the session policies. You
|
|
* can use the role's temporary credentials in subsequent AWS API calls to access
|
|
* resources in the account that owns the role. You cannot use session policies to
|
|
* grant more permissions than those allowed by the identity-based policy of the
|
|
* role that is being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>. </p> <p>The plain text that you use
|
|
* for both inline and managed session policies can't exceed 2,048 characters. The
|
|
* JSON policy characters can be any ASCII character from the space character to
|
|
* the end of the valid character list (\u0020 through \u00FF). It can also include
|
|
* the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
|
|
* characters.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p>
|
|
*/
|
|
inline void SetPolicy(Aws::String&& value) { m_policyHasBeenSet = true; m_policy = std::move(value); }
|
|
|
|
/**
|
|
* <p>An IAM policy in JSON format that you want to use as an inline session
|
|
* policy.</p> <p>This parameter is optional. Passing policies to this operation
|
|
* returns new temporary credentials. The resulting session's permissions are the
|
|
* intersection of the role's identity-based policy and the session policies. You
|
|
* can use the role's temporary credentials in subsequent AWS API calls to access
|
|
* resources in the account that owns the role. You cannot use session policies to
|
|
* grant more permissions than those allowed by the identity-based policy of the
|
|
* role that is being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>. </p> <p>The plain text that you use
|
|
* for both inline and managed session policies can't exceed 2,048 characters. The
|
|
* JSON policy characters can be any ASCII character from the space character to
|
|
* the end of the valid character list (\u0020 through \u00FF). It can also include
|
|
* the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
|
|
* characters.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p>
|
|
*/
|
|
inline void SetPolicy(const char* value) { m_policyHasBeenSet = true; m_policy.assign(value); }
|
|
|
|
/**
|
|
* <p>An IAM policy in JSON format that you want to use as an inline session
|
|
* policy.</p> <p>This parameter is optional. Passing policies to this operation
|
|
* returns new temporary credentials. The resulting session's permissions are the
|
|
* intersection of the role's identity-based policy and the session policies. You
|
|
* can use the role's temporary credentials in subsequent AWS API calls to access
|
|
* resources in the account that owns the role. You cannot use session policies to
|
|
* grant more permissions than those allowed by the identity-based policy of the
|
|
* role that is being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>. </p> <p>The plain text that you use
|
|
* for both inline and managed session policies can't exceed 2,048 characters. The
|
|
* JSON policy characters can be any ASCII character from the space character to
|
|
* the end of the valid character list (\u0020 through \u00FF). It can also include
|
|
* the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
|
|
* characters.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithPolicy(const Aws::String& value) { SetPolicy(value); return *this;}
|
|
|
|
/**
|
|
* <p>An IAM policy in JSON format that you want to use as an inline session
|
|
* policy.</p> <p>This parameter is optional. Passing policies to this operation
|
|
* returns new temporary credentials. The resulting session's permissions are the
|
|
* intersection of the role's identity-based policy and the session policies. You
|
|
* can use the role's temporary credentials in subsequent AWS API calls to access
|
|
* resources in the account that owns the role. You cannot use session policies to
|
|
* grant more permissions than those allowed by the identity-based policy of the
|
|
* role that is being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>. </p> <p>The plain text that you use
|
|
* for both inline and managed session policies can't exceed 2,048 characters. The
|
|
* JSON policy characters can be any ASCII character from the space character to
|
|
* the end of the valid character list (\u0020 through \u00FF). It can also include
|
|
* the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
|
|
* characters.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithPolicy(Aws::String&& value) { SetPolicy(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>An IAM policy in JSON format that you want to use as an inline session
|
|
* policy.</p> <p>This parameter is optional. Passing policies to this operation
|
|
* returns new temporary credentials. The resulting session's permissions are the
|
|
* intersection of the role's identity-based policy and the session policies. You
|
|
* can use the role's temporary credentials in subsequent AWS API calls to access
|
|
* resources in the account that owns the role. You cannot use session policies to
|
|
* grant more permissions than those allowed by the identity-based policy of the
|
|
* role that is being assumed. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
* Policies</a> in the <i>IAM User Guide</i>. </p> <p>The plain text that you use
|
|
* for both inline and managed session policies can't exceed 2,048 characters. The
|
|
* JSON policy characters can be any ASCII character from the space character to
|
|
* the end of the valid character list (\u0020 through \u00FF). It can also include
|
|
* the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
|
|
* characters.</p> <p>An AWS conversion compresses the passed session
|
|
* policies and session tags into a packed binary format that has a separate limit.
|
|
* Your request can fail for this limit even if your plain text meets the other
|
|
* requirements. The <code>PackedPolicySize</code> response element indicates by
|
|
* percentage how close the policies and tags for your request are to the upper
|
|
* size limit. </p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithPolicy(const char* value) { SetPolicy(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The duration, in seconds, of the role session. Your role session lasts for
|
|
* the duration that you specify for the <code>DurationSeconds</code> parameter, or
|
|
* until the time specified in the SAML authentication response's
|
|
* <code>SessionNotOnOrAfter</code> value, whichever is shorter. You can provide a
|
|
* <code>DurationSeconds</code> value from 900 seconds (15 minutes) up to the
|
|
* maximum session duration setting for the role. This setting can have a value
|
|
* from 1 hour to 12 hours. If you specify a value higher than this setting, the
|
|
* operation fails. For example, if you specify a session duration of 12 hours, but
|
|
* your administrator set the maximum session duration to 6 hours, your operation
|
|
* fails. To learn how to view the maximum value for your role, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View
|
|
* the Maximum Session Duration Setting for a Role</a> in the <i>IAM User
|
|
* Guide</i>.</p> <p>By default, the value is set to <code>3600</code> seconds.
|
|
* </p> <p>The <code>DurationSeconds</code> parameter is separate from the
|
|
* duration of a console session that you might request using the returned
|
|
* credentials. The request to the federation endpoint for a console sign-in token
|
|
* takes a <code>SessionDuration</code> parameter that specifies the maximum length
|
|
* of the console session. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating
|
|
* a URL that Enables Federated Users to Access the AWS Management Console</a> in
|
|
* the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline int GetDurationSeconds() const{ return m_durationSeconds; }
|
|
|
|
/**
|
|
* <p>The duration, in seconds, of the role session. Your role session lasts for
|
|
* the duration that you specify for the <code>DurationSeconds</code> parameter, or
|
|
* until the time specified in the SAML authentication response's
|
|
* <code>SessionNotOnOrAfter</code> value, whichever is shorter. You can provide a
|
|
* <code>DurationSeconds</code> value from 900 seconds (15 minutes) up to the
|
|
* maximum session duration setting for the role. This setting can have a value
|
|
* from 1 hour to 12 hours. If you specify a value higher than this setting, the
|
|
* operation fails. For example, if you specify a session duration of 12 hours, but
|
|
* your administrator set the maximum session duration to 6 hours, your operation
|
|
* fails. To learn how to view the maximum value for your role, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View
|
|
* the Maximum Session Duration Setting for a Role</a> in the <i>IAM User
|
|
* Guide</i>.</p> <p>By default, the value is set to <code>3600</code> seconds.
|
|
* </p> <p>The <code>DurationSeconds</code> parameter is separate from the
|
|
* duration of a console session that you might request using the returned
|
|
* credentials. The request to the federation endpoint for a console sign-in token
|
|
* takes a <code>SessionDuration</code> parameter that specifies the maximum length
|
|
* of the console session. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating
|
|
* a URL that Enables Federated Users to Access the AWS Management Console</a> in
|
|
* the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline bool DurationSecondsHasBeenSet() const { return m_durationSecondsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The duration, in seconds, of the role session. Your role session lasts for
|
|
* the duration that you specify for the <code>DurationSeconds</code> parameter, or
|
|
* until the time specified in the SAML authentication response's
|
|
* <code>SessionNotOnOrAfter</code> value, whichever is shorter. You can provide a
|
|
* <code>DurationSeconds</code> value from 900 seconds (15 minutes) up to the
|
|
* maximum session duration setting for the role. This setting can have a value
|
|
* from 1 hour to 12 hours. If you specify a value higher than this setting, the
|
|
* operation fails. For example, if you specify a session duration of 12 hours, but
|
|
* your administrator set the maximum session duration to 6 hours, your operation
|
|
* fails. To learn how to view the maximum value for your role, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View
|
|
* the Maximum Session Duration Setting for a Role</a> in the <i>IAM User
|
|
* Guide</i>.</p> <p>By default, the value is set to <code>3600</code> seconds.
|
|
* </p> <p>The <code>DurationSeconds</code> parameter is separate from the
|
|
* duration of a console session that you might request using the returned
|
|
* credentials. The request to the federation endpoint for a console sign-in token
|
|
* takes a <code>SessionDuration</code> parameter that specifies the maximum length
|
|
* of the console session. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating
|
|
* a URL that Enables Federated Users to Access the AWS Management Console</a> in
|
|
* the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline void SetDurationSeconds(int value) { m_durationSecondsHasBeenSet = true; m_durationSeconds = value; }
|
|
|
|
/**
|
|
* <p>The duration, in seconds, of the role session. Your role session lasts for
|
|
* the duration that you specify for the <code>DurationSeconds</code> parameter, or
|
|
* until the time specified in the SAML authentication response's
|
|
* <code>SessionNotOnOrAfter</code> value, whichever is shorter. You can provide a
|
|
* <code>DurationSeconds</code> value from 900 seconds (15 minutes) up to the
|
|
* maximum session duration setting for the role. This setting can have a value
|
|
* from 1 hour to 12 hours. If you specify a value higher than this setting, the
|
|
* operation fails. For example, if you specify a session duration of 12 hours, but
|
|
* your administrator set the maximum session duration to 6 hours, your operation
|
|
* fails. To learn how to view the maximum value for your role, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View
|
|
* the Maximum Session Duration Setting for a Role</a> in the <i>IAM User
|
|
* Guide</i>.</p> <p>By default, the value is set to <code>3600</code> seconds.
|
|
* </p> <p>The <code>DurationSeconds</code> parameter is separate from the
|
|
* duration of a console session that you might request using the returned
|
|
* credentials. The request to the federation endpoint for a console sign-in token
|
|
* takes a <code>SessionDuration</code> parameter that specifies the maximum length
|
|
* of the console session. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating
|
|
* a URL that Enables Federated Users to Access the AWS Management Console</a> in
|
|
* the <i>IAM User Guide</i>.</p>
|
|
*/
|
|
inline AssumeRoleWithSAMLRequest& WithDurationSeconds(int value) { SetDurationSeconds(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_roleArn;
|
|
bool m_roleArnHasBeenSet;
|
|
|
|
Aws::String m_principalArn;
|
|
bool m_principalArnHasBeenSet;
|
|
|
|
Aws::String m_sAMLAssertion;
|
|
bool m_sAMLAssertionHasBeenSet;
|
|
|
|
Aws::Vector<PolicyDescriptorType> m_policyArns;
|
|
bool m_policyArnsHasBeenSet;
|
|
|
|
Aws::String m_policy;
|
|
bool m_policyHasBeenSet;
|
|
|
|
int m_durationSeconds;
|
|
bool m_durationSecondsHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace STS
|
|
} // namespace Aws
|