Struct aws_sdk_sts::operation::assume_role_with_saml::builders::AssumeRoleWithSamlInputBuilder
source · #[non_exhaustive]pub struct AssumeRoleWithSamlInputBuilder { /* private fields */ }
Expand description
A builder for AssumeRoleWithSamlInput
.
Implementations§
source§impl AssumeRoleWithSamlInputBuilder
impl AssumeRoleWithSamlInputBuilder
sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the role that the caller is assuming.
This field is required.sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the role that the caller is assuming.
sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the role that the caller is assuming.
sourcepub fn principal_arn(self, input: impl Into<String>) -> Self
pub fn principal_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
This field is required.sourcepub fn set_principal_arn(self, input: Option<String>) -> Self
pub fn set_principal_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
sourcepub fn get_principal_arn(&self) -> &Option<String>
pub fn get_principal_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
sourcepub fn saml_assertion(self, input: impl Into<String>) -> Self
pub fn saml_assertion(self, input: impl Into<String>) -> Self
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.
This field is required.sourcepub fn set_saml_assertion(self, input: Option<String>) -> Self
pub fn set_saml_assertion(self, input: Option<String>) -> Self
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.
sourcepub fn get_saml_assertion(&self) -> &Option<String>
pub fn get_saml_assertion(&self) -> &Option<String>
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.
sourcepub fn policy_arns(self, input: PolicyDescriptorType) -> Self
pub fn policy_arns(self, input: PolicyDescriptorType) -> Self
Appends an item to policy_arns
.
To override the contents of this collection use set_policy_arns
.
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.
sourcepub fn set_policy_arns(self, input: Option<Vec<PolicyDescriptorType>>) -> Self
pub fn set_policy_arns(self, input: Option<Vec<PolicyDescriptorType>>) -> Self
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.
sourcepub fn get_policy_arns(&self) -> &Option<Vec<PolicyDescriptorType>>
pub fn get_policy_arns(&self) -> &Option<Vec<PolicyDescriptorType>>
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.
sourcepub fn policy(self, input: impl Into<String>) -> Self
pub fn policy(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_policy(self, input: Option<String>) -> Self
pub fn set_policy(self, input: Option<String>) -> Self
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.
sourcepub fn get_policy(&self) -> &Option<String>
pub fn get_policy(&self) -> &Option<String>
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.
sourcepub fn duration_seconds(self, input: i32) -> Self
pub fn duration_seconds(self, input: i32) -> Self
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.
sourcepub fn set_duration_seconds(self, input: Option<i32>) -> Self
pub fn set_duration_seconds(self, input: Option<i32>) -> Self
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.
sourcepub fn get_duration_seconds(&self) -> &Option<i32>
pub fn get_duration_seconds(&self) -> &Option<i32>
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.
sourcepub fn build(self) -> Result<AssumeRoleWithSamlInput, BuildError>
pub fn build(self) -> Result<AssumeRoleWithSamlInput, BuildError>
Consumes the builder and constructs a AssumeRoleWithSamlInput
.
source§impl AssumeRoleWithSamlInputBuilder
impl AssumeRoleWithSamlInputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<AssumeRoleWithSamlOutput, SdkError<AssumeRoleWithSAMLError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<AssumeRoleWithSamlOutput, SdkError<AssumeRoleWithSAMLError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for AssumeRoleWithSamlInputBuilder
impl Clone for AssumeRoleWithSamlInputBuilder
source§fn clone(&self) -> AssumeRoleWithSamlInputBuilder
fn clone(&self) -> AssumeRoleWithSamlInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for AssumeRoleWithSamlInputBuilder
impl Default for AssumeRoleWithSamlInputBuilder
source§fn default() -> AssumeRoleWithSamlInputBuilder
fn default() -> AssumeRoleWithSamlInputBuilder
source§impl PartialEq for AssumeRoleWithSamlInputBuilder
impl PartialEq for AssumeRoleWithSamlInputBuilder
source§fn eq(&self, other: &AssumeRoleWithSamlInputBuilder) -> bool
fn eq(&self, other: &AssumeRoleWithSamlInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AssumeRoleWithSamlInputBuilder
Auto Trait Implementations§
impl Freeze for AssumeRoleWithSamlInputBuilder
impl RefUnwindSafe for AssumeRoleWithSamlInputBuilder
impl Send for AssumeRoleWithSamlInputBuilder
impl Sync for AssumeRoleWithSamlInputBuilder
impl Unpin for AssumeRoleWithSamlInputBuilder
impl UnwindSafe for AssumeRoleWithSamlInputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)