Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iam
  5. SamlProvider

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iam.SamlProvider

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::IAM::SAMLProvider

Create SamlProvider Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SamlProvider(name: string, args?: SamlProviderArgs, opts?: CustomResourceOptions);
@overload
def SamlProvider(resource_name: str,
                 args: Optional[SamlProviderArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def SamlProvider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 add_private_key: Optional[str] = None,
                 assertion_encryption_mode: Optional[SamlProviderAssertionEncryptionMode] = None,
                 name: Optional[str] = None,
                 private_key_list: Optional[Sequence[SamlProviderSamlPrivateKeyArgs]] = None,
                 remove_private_key: Optional[str] = None,
                 saml_metadata_document: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewSamlProvider(ctx *Context, name string, args *SamlProviderArgs, opts ...ResourceOption) (*SamlProvider, error)
public SamlProvider(string name, SamlProviderArgs? args = null, CustomResourceOptions? opts = null)
public SamlProvider(String name, SamlProviderArgs args)
public SamlProvider(String name, SamlProviderArgs args, CustomResourceOptions options)

type: aws-native:iam:SamlProvider
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args SamlProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args SamlProviderArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args SamlProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args SamlProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SamlProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

SamlProvider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SamlProvider resource accepts the following input properties:

AddPrivateKey string
The private key from your external identity provider
AssertionEncryptionMode Pulumi.AwsNative.Iam.SamlProviderAssertionEncryptionMode
The encryption setting for the SAML provider
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: _+=,.@-

PrivateKeyList List<Pulumi.AwsNative.Iam.Inputs.SamlProviderSamlPrivateKey>
The private key metadata for the SAML provider.
RemovePrivateKey string
The Key ID of the private key to remove
SamlMetadataDocument 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

Tags List<Pulumi.AwsNative.Inputs.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 .

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

AddPrivateKey string
The private key from your external identity provider
AssertionEncryptionMode SamlProviderAssertionEncryptionMode
The encryption setting for the SAML provider
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: _+=,.@-

PrivateKeyList []SamlProviderSamlPrivateKeyArgs
The private key metadata for the SAML provider.
RemovePrivateKey string
The Key ID of the private key to remove
SamlMetadataDocument 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

Tags TagArgs

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 .

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

addPrivateKey String
The private key from your external identity provider
assertionEncryptionMode SamlProviderAssertionEncryptionMode
The encryption setting for the SAML provider
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: _+=,.@-

privateKeyList List<SamlProviderSamlPrivateKey>
The private key metadata for the SAML provider.
removePrivateKey String
The Key ID of the private key to remove
samlMetadataDocument 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

tags List<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 .

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

addPrivateKey string
The private key from your external identity provider
assertionEncryptionMode SamlProviderAssertionEncryptionMode
The encryption setting for the SAML provider
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: _+=,.@-

privateKeyList SamlProviderSamlPrivateKey[]
The private key metadata for the SAML provider.
removePrivateKey string
The Key ID of the private key to remove
samlMetadataDocument 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

tags 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 .

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

add_private_key str
The private key from your external identity provider
assertion_encryption_mode SamlProviderAssertionEncryptionMode
The encryption setting for the SAML provider
name str

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: _+=,.@-

private_key_list Sequence[SamlProviderSamlPrivateKeyArgs]
The private key metadata for the SAML provider.
remove_private_key str
The Key ID of the private key to remove
saml_metadata_document str

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

tags Sequence[TagArgs]

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 .

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

addPrivateKey String
The private key from your external identity provider
assertionEncryptionMode "Allowed" | "Required"
The encryption setting for the SAML provider
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: _+=,.@-

privateKeyList List<Property Map>
The private key metadata for the SAML provider.
removePrivateKey String
The Key ID of the private key to remove
samlMetadataDocument 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

tags List<Property Map>

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 .

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Outputs

All input properties are implicitly available as output properties. Additionally, the SamlProvider resource produces the following output properties:

Arn string
Amazon Resource Name (ARN) of the SAML provider
Id string
The provider-assigned unique ID for this managed resource.
SamlProviderUuid string
The unique identifier assigned to the SAML provider
Arn string
Amazon Resource Name (ARN) of the SAML provider
Id string
The provider-assigned unique ID for this managed resource.
SamlProviderUuid string
The unique identifier assigned to the SAML provider
arn String
Amazon Resource Name (ARN) of the SAML provider
id String
The provider-assigned unique ID for this managed resource.
samlProviderUuid String
The unique identifier assigned to the SAML provider
arn string
Amazon Resource Name (ARN) of the SAML provider
id string
The provider-assigned unique ID for this managed resource.
samlProviderUuid string
The unique identifier assigned to the SAML provider
arn str
Amazon Resource Name (ARN) of the SAML provider
id str
The provider-assigned unique ID for this managed resource.
saml_provider_uuid str
The unique identifier assigned to the SAML provider
arn String
Amazon Resource Name (ARN) of the SAML provider
id String
The provider-assigned unique ID for this managed resource.
samlProviderUuid String
The unique identifier assigned to the SAML provider

Supporting Types

SamlProviderAssertionEncryptionMode
, SamlProviderAssertionEncryptionModeArgs

Allowed
Allowed
Required
Required
SamlProviderAssertionEncryptionModeAllowed
Allowed
SamlProviderAssertionEncryptionModeRequired
Required
Allowed
Allowed
Required
Required
Allowed
Allowed
Required
Required
ALLOWED
Allowed
REQUIRED
Required
"Allowed"
Allowed
"Required"
Required

SamlProviderSamlPrivateKey
, SamlProviderSamlPrivateKeyArgs

KeyId This property is required. string
The unique identifier for the SAML private key.
Timestamp This property is required. string
The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format, when the private key was uploaded.
KeyId This property is required. string
The unique identifier for the SAML private key.
Timestamp This property is required. string
The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format, when the private key was uploaded.
keyId This property is required. String
The unique identifier for the SAML private key.
timestamp This property is required. String
The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format, when the private key was uploaded.
keyId This property is required. string
The unique identifier for the SAML private key.
timestamp This property is required. string
The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format, when the private key was uploaded.
key_id This property is required. str
The unique identifier for the SAML private key.
timestamp This property is required. str
The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format, when the private key was uploaded.
keyId This property is required. String
The unique identifier for the SAML private key.
timestamp This property is required. String
The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format, when the private key was uploaded.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native