Class: Aws::IAM::Types::CreateSAMLProviderRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IAM::Types::CreateSAMLProviderRequest
- 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
The private key generated 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.
-
#name ⇒ String
The name of the provider to create.
-
#saml_metadata_document ⇒ String
An XML document generated by an identity provider (IdP) that supports SAML 2.0.
-
#tags ⇒ Array<Types::Tag>
A list of tags that you want to attach to the new IAM SAML provider.
Instance Attribute Details
#add_private_key ⇒ String
The private key generated 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.
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1873 class CreateSAMLProviderRequest < Struct.new( :saml_metadata_document, :name, :tags, :assertion_encryption_mode, :add_private_key, :context_provider, :identity_center_instance_arn) SENSITIVE = [:add_private_key] include Aws::Structure end |
#assertion_encryption_mode ⇒ String
Specifies the encryption setting for the SAML provider.
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1873 class CreateSAMLProviderRequest < Struct.new( :saml_metadata_document, :name, :tags, :assertion_encryption_mode, :add_private_key, :context_provider, :identity_center_instance_arn) 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. The context provider defines how the subject is derived and how keys from the provider's SAML assertion are mapped into trusted context keys. Specifying a context provider enables trusted identity propagation for the provider. For more information, see ContextProvider.
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1873 class CreateSAMLProviderRequest < Struct.new( :saml_metadata_document, :name, :tags, :assertion_encryption_mode, :add_private_key, :context_provider, :identity_center_instance_arn) 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. If you specify this parameter,
you must also specify ContextProvider.
For the format, see InstanceMetadata in the IAM Identity Center API Reference.
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1873 class CreateSAMLProviderRequest < Struct.new( :saml_metadata_document, :name, :tags, :assertion_encryption_mode, :add_private_key, :context_provider, :identity_center_instance_arn) SENSITIVE = [:add_private_key] include Aws::Structure end |
#name ⇒ String
The name of the provider to create.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1873 class CreateSAMLProviderRequest < Struct.new( :saml_metadata_document, :name, :tags, :assertion_encryption_mode, :add_private_key, :context_provider, :identity_center_instance_arn) 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 organization's IdP.
For more information, see About SAML 2.0-based federation in the IAM User Guide
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1873 class CreateSAMLProviderRequest < Struct.new( :saml_metadata_document, :name, :tags, :assertion_encryption_mode, :add_private_key, :context_provider, :identity_center_instance_arn) SENSITIVE = [:add_private_key] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1873 class CreateSAMLProviderRequest < Struct.new( :saml_metadata_document, :name, :tags, :assertion_encryption_mode, :add_private_key, :context_provider, :identity_center_instance_arn) SENSITIVE = [:add_private_key] include Aws::Structure end |