SamlProvider class
Provides an IAM SAML provider.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";
const _default = new aws.iam.SamlProvider("default", {
name: "myprovider",
samlMetadataDocument: std.file({
input: "saml-metadata.xml",
}).then(invoke => invoke.result),
});
import pulumi
import pulumi_aws as aws
import pulumi_std as std
default = aws.iam.SamlProvider("default",
name="myprovider",
saml_metadata_document=std.file(input="saml-metadata.xml").result)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.Iam.SamlProvider("default", new()
{
Name = "myprovider",
SamlMetadataDocument = Std.File.Invoke(new()
{
Input = "saml-metadata.xml",
}).Apply(invoke => invoke.Result),
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
invokeFile, err := std.File(ctx, &std.FileArgs{
Input: "saml-metadata.xml",
}, nil)
if err != nil {
return err
}
_, err = iam.NewSamlProvider(ctx, "default", &iam.SamlProviderArgs{
Name: pulumi.String("myprovider"),
SamlMetadataDocument: pulumi.String(invokeFile.Result),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
std = {
source = "pulumi/std"
}
}
}
resource "aws_iam_samlprovider" "default" {
name = "myprovider"
saml_metadata_document = file("saml-metadata.xml")
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.SamlProvider;
import com.pulumi.aws.iam.SamlProviderArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var default_ = new SamlProvider("default", SamlProviderArgs.builder()
.name("myprovider")
.samlMetadataDocument(StdFunctions.file(FileArgs.builder()
.input("saml-metadata.xml")
.build()).result())
.build());
}
}
resources:
default:
type: aws:iam:SamlProvider
properties:
name: myprovider
samlMetadataDocument:
fn::invoke:
function: std:file
arguments:
input: saml-metadata.xml
return: result
Import
Identity Schema
Required
arn(String) ARN of the IAM SAML provider.
Using pulumi import, import IAM SAML Providers using the arn. For example:
$ pulumi import aws:iam/samlProvider:SamlProvider default arn:aws:iam::123456789012:saml-provider/SAMLADFS
Constructors
- SamlProvider(String name, {SamlProviderArgs? args, CustomResourceOptions? options})
-
Creates a new SamlProvider.
nameThe Pulumi resource name.argsArguments used to configure this SamlProvider. The set of arguments for SamlProvider.optionsResource options controlling this resource's behavior. - SamlProvider.reference(String urn)
- Creates a typed reference to an existing SamlProvider resource.
Properties
-
arn
↔ Output<
String> -
The ARN assigned by AWS for this provider.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
The name of the provider to create.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
samlMetadataDocument
↔ Output<
String> -
An XML document generated by an identity provider that supports SAML 2.0.
latefinal
-
samlProviderUuid
↔ Output<
String> -
Unique identifier assigned to the SAML provider.
latefinal
-
Map of resource tags for the IAM SAML provider. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
validUntil
↔ Output<
String> -
The expiration date and time for the SAML provider in RFC1123 format, e.g.,
Mon, 02 Jan 2006 15:04:05 MST.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {SamlProviderState? state, CustomResourceOptions? options}) → SamlProvider -
Gets an existing SamlProvider resource's state with the given
nameandid.