aws.iam.getSamlProvider

Explore with Pulumi AI

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.iam.getSamlProvider({
    arn: "arn:aws:iam::123456789:saml-provider/myprovider",
});

import pulumi
import pulumi_aws as aws

example = aws.iam.get_saml_provider(arn="arn:aws:iam::123456789:saml-provider/myprovider")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.LookupSamlProvider(ctx, &iam.LookupSamlProviderArgs{
			Arn: "arn:aws:iam::123456789:saml-provider/myprovider",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Iam.GetSamlProvider.Invoke(new()
    {
        Arn = "arn:aws:iam::123456789:saml-provider/myprovider",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetSamlProviderArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = IamFunctions.getSamlProvider(GetSamlProviderArgs.builder()
            .arn("arn:aws:iam::123456789:saml-provider/myprovider")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:iam:getSamlProvider
      arguments:
        arn: arn:aws:iam::123456789:saml-provider/myprovider

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,
                      tags: Optional[Mapping[str, str]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSamlProviderResult
def get_saml_provider_output(arn: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Mapping[str, 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:iam/getSamlProvider:getSamlProvider
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string: ARN assigned by AWS for the provider.
Tags Dictionary<string, string>: Tags attached to the SAML provider.

Arn string: ARN assigned by AWS for the provider.
Tags map[string]string: Tags attached to the SAML provider.

arn String: ARN assigned by AWS for the provider.
tags Map<String,String>: Tags attached to the SAML provider.

arn string: ARN assigned by AWS for the provider.
tags {[key: string]: string}: Tags attached to the SAML provider.

arn str: ARN assigned by AWS for the provider.
tags Mapping[str, str]: Tags attached to the SAML provider.

arn String: ARN assigned by AWS for the provider.
tags Map<String>: Tags attached to the SAML provider.

getSamlProvider Result

The following output properties are available:

Arn string
CreateDate string: Creation date of the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2006 15:04:05 MST.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of the provider.
SamlMetadataDocument string: The XML document generated by an identity provider that supports SAML 2.0.
Tags Dictionary<string, string>: Tags attached to the SAML provider.
ValidUntil string: Expiration date and time for the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2007 15:04:05 MST.

Arn string
CreateDate string: Creation date of the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2006 15:04:05 MST.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of the provider.
SamlMetadataDocument string: The XML document generated by an identity provider that supports SAML 2.0.
Tags map[string]string: Tags attached to the SAML provider.
ValidUntil string: Expiration date and time for the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2007 15:04:05 MST.

arn String
createDate String: Creation date of the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2006 15:04:05 MST.
id String: The provider-assigned unique ID for this managed resource.
name String: Name of the provider.
samlMetadataDocument String: The XML document generated by an identity provider that supports SAML 2.0.
tags Map<String,String>: Tags attached to the SAML provider.
validUntil String: Expiration date and time for the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2007 15:04:05 MST.

arn string
createDate string: Creation date of the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2006 15:04:05 MST.
id string: The provider-assigned unique ID for this managed resource.
name string: Name of the provider.
samlMetadataDocument string: The XML document generated by an identity provider that supports SAML 2.0.
tags {[key: string]: string}: Tags attached to the SAML provider.
validUntil string: Expiration date and time for the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2007 15:04:05 MST.

arn str
create_date str: Creation date of the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2006 15:04:05 MST.
id str: The provider-assigned unique ID for this managed resource.
name str: Name of the provider.
saml_metadata_document str: The XML document generated by an identity provider that supports SAML 2.0.
tags Mapping[str, str]: Tags attached to the SAML provider.
valid_until str: Expiration date and time for the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2007 15:04:05 MST.

arn String
createDate String: Creation date of the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2006 15:04:05 MST.
id String: The provider-assigned unique ID for this managed resource.
name String: Name of the provider.
samlMetadataDocument String: The XML document generated by an identity provider that supports SAML 2.0.
tags Map<String>: Tags attached to the SAML provider.
validUntil String: Expiration date and time for the SAML provider in RFC1123 format, e.g. Mon, 02 Jan 2007 15:04:05 MST.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-aws

aws.iam.getSamlProvider

On this page

On this page

Example Usage

Using getSamlProvider

getSamlProvider Result

Package Details

On this page

On this page