Class: Aws::IAM::Types::UpdateSAMLProviderRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IAM::Types::UpdateSAMLProviderRequest
- Defined in:
- gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:add_private_key]
Instance Attribute Summary collapse
-
#add_private_key ⇒ String
Specifies the new private key from your external identity provider.
-
#assertion_encryption_mode ⇒ String
Specifies the encryption setting for the SAML provider.
-
#context_provider ⇒ Types::ContextProvider
The trusted identity propagation context provider configuration to associate with the SAML provider.
-
#identity_center_instance_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the SAML provider.
-
#remove_context_provider ⇒ Boolean
Specifies whether to remove the existing trusted identity propagation context provider configuration from the SAML provider.
-
#remove_identity_center_instance ⇒ Boolean
Specifies whether to disassociate the IAM Identity Center instance from the SAML provider.
-
#remove_private_key ⇒ String
The Key ID of the private key to remove.
-
#saml_metadata_document ⇒ String
An XML document generated by an identity provider (IdP) that supports SAML 2.0.
-
#saml_provider_arn ⇒ String
The Amazon Resource Name (ARN) of the SAML provider to update.
Instance Attribute Details
#add_private_key ⇒ String
Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13929 class UpdateSAMLProviderRequest < Struct.new( :saml_metadata_document, :saml_provider_arn, :assertion_encryption_mode, :add_private_key, :remove_private_key, :context_provider, :identity_center_instance_arn, :remove_context_provider, :remove_identity_center_instance) SENSITIVE = [:add_private_key] include Aws::Structure end |
#assertion_encryption_mode ⇒ String
Specifies the encryption setting for the SAML provider.
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13929 class UpdateSAMLProviderRequest < Struct.new( :saml_metadata_document, :saml_provider_arn, :assertion_encryption_mode, :add_private_key, :remove_private_key, :context_provider, :identity_center_instance_arn, :remove_context_provider, :remove_identity_center_instance) SENSITIVE = [:add_private_key] include Aws::Structure end |
#context_provider ⇒ Types::ContextProvider
The trusted identity propagation context provider configuration to associate with the SAML provider. This replaces the existing context provider configuration. For more information, see ContextProvider.
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13929 class UpdateSAMLProviderRequest < Struct.new( :saml_metadata_document, :saml_provider_arn, :assertion_encryption_mode, :add_private_key, :remove_private_key, :context_provider, :identity_center_instance_arn, :remove_context_provider, :remove_identity_center_instance) SENSITIVE = [:add_private_key] include Aws::Structure end |
#identity_center_instance_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the SAML provider.
For the format, see InstanceMetadata in the IAM Identity Center API Reference.
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13929 class UpdateSAMLProviderRequest < Struct.new( :saml_metadata_document, :saml_provider_arn, :assertion_encryption_mode, :add_private_key, :remove_private_key, :context_provider, :identity_center_instance_arn, :remove_context_provider, :remove_identity_center_instance) SENSITIVE = [:add_private_key] include Aws::Structure end |
#remove_context_provider ⇒ Boolean
Specifies whether to remove the existing trusted identity
propagation context provider configuration from the SAML provider.
When set to true, the context provider is removed. This parameter
is mutually exclusive with ContextProvider.
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13929 class UpdateSAMLProviderRequest < Struct.new( :saml_metadata_document, :saml_provider_arn, :assertion_encryption_mode, :add_private_key, :remove_private_key, :context_provider, :identity_center_instance_arn, :remove_context_provider, :remove_identity_center_instance) SENSITIVE = [:add_private_key] include Aws::Structure end |
#remove_identity_center_instance ⇒ Boolean
Specifies whether to disassociate the IAM Identity Center instance
from the SAML provider. When set to true, the instance is
disassociated. This parameter is mutually exclusive with
IdentityCenterInstanceArn.
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13929 class UpdateSAMLProviderRequest < Struct.new( :saml_metadata_document, :saml_provider_arn, :assertion_encryption_mode, :add_private_key, :remove_private_key, :context_provider, :identity_center_instance_arn, :remove_context_provider, :remove_identity_center_instance) SENSITIVE = [:add_private_key] include Aws::Structure end |
#remove_private_key ⇒ String
The Key ID of the private key to remove.
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13929 class UpdateSAMLProviderRequest < Struct.new( :saml_metadata_document, :saml_provider_arn, :assertion_encryption_mode, :add_private_key, :remove_private_key, :context_provider, :identity_center_instance_arn, :remove_context_provider, :remove_identity_center_instance) SENSITIVE = [:add_private_key] include Aws::Structure end |
#saml_metadata_document ⇒ String
An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13929 class UpdateSAMLProviderRequest < Struct.new( :saml_metadata_document, :saml_provider_arn, :assertion_encryption_mode, :add_private_key, :remove_private_key, :context_provider, :identity_center_instance_arn, :remove_context_provider, :remove_identity_center_instance) SENSITIVE = [:add_private_key] include Aws::Structure end |
#saml_provider_arn ⇒ String
The Amazon Resource Name (ARN) of the SAML provider to update.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13929 class UpdateSAMLProviderRequest < Struct.new( :saml_metadata_document, :saml_provider_arn, :assertion_encryption_mode, :add_private_key, :remove_private_key, :context_provider, :identity_center_instance_arn, :remove_context_provider, :remove_identity_center_instance) SENSITIVE = [:add_private_key] include Aws::Structure end |