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

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

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iam.getSamlProvider

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IAM::SAMLProvider

    Using getSamlProvider

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSamlProvider(args: GetSamlProviderArgs, opts?: InvokeOptions): Promise<GetSamlProviderResult>
function getSamlProviderOutput(args: GetSamlProviderOutputArgs, opts?: InvokeOptions): Output<GetSamlProviderResult>
    def get_saml_provider(arn: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSamlProviderResult
def get_saml_provider_output(arn: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSamlProviderResult]
    func LookupSamlProvider(ctx *Context, args *LookupSamlProviderArgs, opts ...InvokeOption) (*LookupSamlProviderResult, error)
func LookupSamlProviderOutput(ctx *Context, args *LookupSamlProviderOutputArgs, opts ...InvokeOption) LookupSamlProviderResultOutput

    > Note: This function is named LookupSamlProvider in the Go SDK.

    public static class GetSamlProvider 
{
    public static Task<GetSamlProviderResult> InvokeAsync(GetSamlProviderArgs args, InvokeOptions? opts = null)
    public static Output<GetSamlProviderResult> Invoke(GetSamlProviderInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSamlProviderResult> getSamlProvider(GetSamlProviderArgs args, InvokeOptions options)
public static Output<GetSamlProviderResult> getSamlProvider(GetSamlProviderArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:iam:getSamlProvider
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Amazon Resource Name (ARN) of the SAML provider
    Arn string
    Amazon Resource Name (ARN) of the SAML provider
    arn String
    Amazon Resource Name (ARN) of the SAML provider
    arn string
    Amazon Resource Name (ARN) of the SAML provider
    arn str
    Amazon Resource Name (ARN) of the SAML provider
    arn String
    Amazon Resource Name (ARN) of the SAML provider

    getSamlProvider Result

    The following output properties are available:

    Arn string
    Amazon Resource Name (ARN) of the SAML provider
    AssertionEncryptionMode Pulumi.AwsNative.Iam.SamlProviderAssertionEncryptionMode
    The encryption setting for the SAML provider
    PrivateKeyList List<Pulumi.AwsNative.Iam.Outputs.SamlProviderSamlPrivateKey>
    The private key metadata for the SAML provider.
    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

    SamlProviderUuid string
    The unique identifier assigned to the SAML provider
    Tags List<Pulumi.AwsNative.Outputs.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.

    Arn string
    Amazon Resource Name (ARN) of the SAML provider
    AssertionEncryptionMode SamlProviderAssertionEncryptionMode
    The encryption setting for the SAML provider
    PrivateKeyList []SamlProviderSamlPrivateKey
    The private key metadata for the SAML provider.
    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

    SamlProviderUuid string
    The unique identifier assigned to the SAML provider
    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.

    arn String
    Amazon Resource Name (ARN) of the SAML provider
    assertionEncryptionMode SamlProviderAssertionEncryptionMode
    The encryption setting for the SAML provider
    privateKeyList List<SamlProviderSamlPrivateKey>
    The private key metadata for the SAML provider.
    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

    samlProviderUuid String
    The unique identifier assigned to the SAML provider
    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.

    arn string
    Amazon Resource Name (ARN) of the SAML provider
    assertionEncryptionMode SamlProviderAssertionEncryptionMode
    The encryption setting for the SAML provider
    privateKeyList SamlProviderSamlPrivateKey[]
    The private key metadata for the SAML provider.
    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

    samlProviderUuid string
    The unique identifier assigned to the SAML provider
    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.

    arn str
    Amazon Resource Name (ARN) of the SAML provider
    assertion_encryption_mode SamlProviderAssertionEncryptionMode
    The encryption setting for the SAML provider
    private_key_list Sequence[SamlProviderSamlPrivateKey]
    The private key metadata for the SAML provider.
    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

    saml_provider_uuid str
    The unique identifier assigned to the SAML provider
    tags Sequence[root_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.

    arn String
    Amazon Resource Name (ARN) of the SAML provider
    assertionEncryptionMode "Allowed" | "Required"
    The encryption setting for the SAML provider
    privateKeyList List<Property Map>
    The private key metadata for the SAML provider.
    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

    samlProviderUuid String
    The unique identifier assigned to the SAML provider
    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.

    Supporting Types

    SamlProviderAssertionEncryptionMode

    SamlProviderSamlPrivateKey

    KeyId string
    The unique identifier for the SAML private key.
    Timestamp 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 string
    The unique identifier for the SAML private key.
    Timestamp 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 String
    The unique identifier for the SAML private key.
    timestamp 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 string
    The unique identifier for the SAML private key.
    timestamp 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 str
    The unique identifier for the SAML private key.
    timestamp 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 String
    The unique identifier for the SAML private key.
    timestamp 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

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws-native