/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace STS { namespace Model { /** */ class AssumeRoleWithSAMLRequest : public STSRequest { public: AWS_STS_API 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_STS_API Aws::String SerializePayload() const override; protected: AWS_STS_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The Amazon Resource Name (ARN) of the role that the caller is assuming.

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

The Amazon Resource Name (ARN) of the role that the caller is assuming.

*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the role that the caller is assuming.

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *

The Amazon Resource Name (ARN) of the role that the caller is assuming.

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the role that the caller is assuming.

*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the role that the caller is assuming.

*/ inline AssumeRoleWithSAMLRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the role that the caller is assuming.

*/ inline AssumeRoleWithSAMLRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the role that the caller is assuming.

*/ inline AssumeRoleWithSAMLRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the * IdP.

*/ inline const Aws::String& GetPrincipalArn() const{ return m_principalArn; } /** *

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the * IdP.

*/ inline bool PrincipalArnHasBeenSet() const { return m_principalArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the * IdP.

*/ inline void SetPrincipalArn(const Aws::String& value) { m_principalArnHasBeenSet = true; m_principalArn = value; } /** *

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the * IdP.

*/ inline void SetPrincipalArn(Aws::String&& value) { m_principalArnHasBeenSet = true; m_principalArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the * IdP.

*/ inline void SetPrincipalArn(const char* value) { m_principalArnHasBeenSet = true; m_principalArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the * IdP.

*/ inline AssumeRoleWithSAMLRequest& WithPrincipalArn(const Aws::String& value) { SetPrincipalArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the * IdP.

*/ inline AssumeRoleWithSAMLRequest& WithPrincipalArn(Aws::String&& value) { SetPrincipalArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the * IdP.

*/ inline AssumeRoleWithSAMLRequest& WithPrincipalArn(const char* value) { SetPrincipalArn(value); return *this;} /** *

The base64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring * a Relying Party and Adding Claims in the IAM User Guide.

*/ inline const Aws::String& GetSAMLAssertion() const{ return m_sAMLAssertion; } /** *

The base64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring * a Relying Party and Adding Claims in the IAM User Guide.

*/ inline bool SAMLAssertionHasBeenSet() const { return m_sAMLAssertionHasBeenSet; } /** *

The base64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring * a Relying Party and Adding Claims in the IAM User Guide.

*/ inline void SetSAMLAssertion(const Aws::String& value) { m_sAMLAssertionHasBeenSet = true; m_sAMLAssertion = value; } /** *

The base64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring * a Relying Party and Adding Claims in the IAM User Guide.

*/ inline void SetSAMLAssertion(Aws::String&& value) { m_sAMLAssertionHasBeenSet = true; m_sAMLAssertion = std::move(value); } /** *

The base64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring * a Relying Party and Adding Claims in the IAM User Guide.

*/ inline void SetSAMLAssertion(const char* value) { m_sAMLAssertionHasBeenSet = true; m_sAMLAssertion.assign(value); } /** *

The base64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring * a Relying Party and Adding Claims in the IAM User Guide.

*/ inline AssumeRoleWithSAMLRequest& WithSAMLAssertion(const Aws::String& value) { SetSAMLAssertion(value); return *this;} /** *

The base64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring * a Relying Party and Adding Claims in the IAM User Guide.

*/ inline AssumeRoleWithSAMLRequest& WithSAMLAssertion(Aws::String&& value) { SetSAMLAssertion(std::move(value)); return *this;} /** *

The base64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring * a Relying Party and Adding Claims in the IAM User Guide.

*/ inline AssumeRoleWithSAMLRequest& WithSAMLAssertion(const char* value) { SetSAMLAssertion(value); return *this;} /** *

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.

This parameter is optional. You can provide up to 10 managed * policy ARNs. However, the plaintext that you use for both inline and managed * session policies can't exceed 2,048 characters. For more information about ARNs, * see Amazon * Resource Names (ARNs) and Amazon Web Services Service Namespaces in the * Amazon Web Services General Reference.

An Amazon Web Services * conversion compresses the passed inline session policy, managed policy ARNs, and * session tags into a packed binary format that has a separate limit. Your request * can fail for this limit even if your plaintext meets the other requirements. The * PackedPolicySize response element indicates by percentage how close * the policies and tags for your request are to the upper size limit.

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 Amazon Web Services 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 Session * Policies in the IAM User Guide.

*/ inline const Aws::Vector& GetPolicyArns() const{ return m_policyArns; } /** *

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.

*/ inline bool PolicyArnsHasBeenSet() const { return m_policyArnsHasBeenSet; } /** *

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.

*/ inline void SetPolicyArns(const Aws::Vector& value) { m_policyArnsHasBeenSet = true; m_policyArns = value; } /** *

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.

*/ inline void SetPolicyArns(Aws::Vector&& value) { m_policyArnsHasBeenSet = true; m_policyArns = std::move(value); } /** *

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.

*/ inline AssumeRoleWithSAMLRequest& WithPolicyArns(const Aws::Vector& value) { SetPolicyArns(value); return *this;} /** *

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.

*/ inline AssumeRoleWithSAMLRequest& WithPolicyArns(Aws::Vector&& value) { SetPolicyArns(std::move(value)); return *this;} /** *

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.

*/ inline AssumeRoleWithSAMLRequest& AddPolicyArns(const PolicyDescriptorType& value) { m_policyArnsHasBeenSet = true; m_policyArns.push_back(value); return *this; } /** *

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.

*/ inline AssumeRoleWithSAMLRequest& AddPolicyArns(PolicyDescriptorType&& value) { m_policyArnsHasBeenSet = true; m_policyArns.push_back(std::move(value)); return *this; } /** *

An IAM policy in JSON format that you want to use as an inline session * policy.

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 Amazon Web Services 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 Session * Policies in the IAM User Guide.

The plaintext 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.

An Amazon Web Services conversion compresses the * passed inline session policy, managed policy ARNs, and session tags into a * packed binary format that has a separate limit. Your request can fail for this * limit even if your plaintext meets the other requirements. The * PackedPolicySize response element indicates by percentage how close * the policies and tags for your request are to the upper size limit.

*/ inline const Aws::String& GetPolicy() const{ return m_policy; } /** *

An IAM policy in JSON format that you want to use as an inline session * policy.

*/ inline bool PolicyHasBeenSet() const { return m_policyHasBeenSet; } /** *

An IAM policy in JSON format that you want to use as an inline session * policy.

*/ inline void SetPolicy(const Aws::String& value) { m_policyHasBeenSet = true; m_policy = value; } /** *

An IAM policy in JSON format that you want to use as an inline session * policy.

*/ inline void SetPolicy(Aws::String&& value) { m_policyHasBeenSet = true; m_policy = std::move(value); } /** *

An IAM policy in JSON format that you want to use as an inline session * policy.

*/ inline void SetPolicy(const char* value) { m_policyHasBeenSet = true; m_policy.assign(value); } /** *

An IAM policy in JSON format that you want to use as an inline session * policy.

*/ inline AssumeRoleWithSAMLRequest& WithPolicy(const Aws::String& value) { SetPolicy(value); return *this;} /** *

An IAM policy in JSON format that you want to use as an inline session * policy.

*/ inline AssumeRoleWithSAMLRequest& WithPolicy(Aws::String&& value) { SetPolicy(std::move(value)); return *this;} /** *

An IAM policy in JSON format that you want to use as an inline session * policy.

*/ inline AssumeRoleWithSAMLRequest& WithPolicy(const char* value) { SetPolicy(value); return *this;} /** *

The duration, in seconds, of the role session. Your role session lasts for * the duration that you specify for the DurationSeconds parameter, or * until the time specified in the SAML authentication response's * SessionNotOnOrAfter value, whichever is shorter. You can provide a * DurationSeconds 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 View * the Maximum Session Duration Setting for a Role in the IAM User * Guide.

By default, the value is set to 3600 seconds. *

The DurationSeconds 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 SessionDuration parameter that specifies the maximum length * of the console session. For more information, see Creating * a URL that Enables Federated Users to Access the Amazon Web Services Management * Console in the IAM User Guide.

*/ inline int GetDurationSeconds() const{ return m_durationSeconds; } /** *

By default, the value is set to 3600 seconds. *

*/ inline bool DurationSecondsHasBeenSet() const { return m_durationSecondsHasBeenSet; } /** *

By default, the value is set to 3600 seconds. *

*/ inline void SetDurationSeconds(int value) { m_durationSecondsHasBeenSet = true; m_durationSeconds = value; } /** *

By default, the value is set to 3600 seconds. *

*/ inline AssumeRoleWithSAMLRequest& WithDurationSeconds(int value) { SetDurationSeconds(value); return *this;} private: Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; Aws::String m_principalArn; bool m_principalArnHasBeenSet = false; Aws::String m_sAMLAssertion; bool m_sAMLAssertionHasBeenSet = false; Aws::Vector m_policyArns; bool m_policyArnsHasBeenSet = false; Aws::String m_policy; bool m_policyHasBeenSet = false; int m_durationSeconds; bool m_durationSecondsHasBeenSet = false; }; } // namespace Model } // namespace STS } // namespace Aws