AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Creates or updates an endpoint settings definition for use with SAML role profiles.

Syntax

Set-AWSSamlEndpoint
-Endpoint <Uri>
-StoreAs <String>
-AuthenticationType <String>

Description

Creates or updates an endpoint settings definition for use with SAML role profiles. The name of the endpoint settings is used with the Set-AWSSamlRoleProfile and Set-AWSCredentials cmdlets to associate one or more role profiles to a shared endpoint definition.

Parameters

-AuthenticationType <String>
The authentication type (or protocol type) used when communicating with the endpoint. If not configured for an endpoint 'Kerberos' is assumed.
Required?False
Position?Named
Accept pipeline input?False
-Endpoint <Uri>
The endpoint to be used when authenticating users prior to requesting temporary role- based AWS credentials. The full endpoint of the identity provider must be specified and it must be a HTTPS-scheme URL.
Required?True
Position?Named
Accept pipeline input?True (ByValue, )
-StoreAs <String>
The user-defined name to assign to the endpoint settings. This name will be used when creating or accessing role profiles with the Set-AWSSamlRoleProfile cmdlet to set up and use role-based credential profiles that use the endpoint to authenticate the user.
Required?True
Position?Named
Accept pipeline input?False

Inputs

System.Uri
You can pipe a Uri object to this cmdlet for the Endpoint parameter.

Outputs

The cmdlet returns the name assigned to the endpoint settings to the pipeline.

Examples

Example 1

PS C:\> $endpoint = "https://adfs.example.com/adfs/ls/IdpInitiatedSignOn.aspx?loginToRp=urn:amazon:webservices"
PS C:\> Set-AWSSamlEndpoint -StoreAs MyADFSEndpoint -Endpoint $endpoint
Creates or updates a profile name MyADFSEndpoint for use with Set-AWSSamlRoleProfile. Kerberos will be used as the authentication protocol when authenticating users against the endoint.

Example 2

PS C:\> $endpoint = "https://adfs.example.com/adfs/ls/IdpInitiatedSignOn.aspx?loginToRp=urn:amazon:webservices"
PS C:\> Set-AWSSamlEndpoint -StoreAs MyADFSEndpoint -Endpoint $endpoint -AuthenticationType NTLM
Creates or updates a profile name MyADFSEndpoint for use with Set-AWSSamlRoleProfile. The endpoint is configured to use the NTLM protocol during authentication (other options are Digest, Basic, Kerberos and Negotiate).

Supported Version

AWS Tools for PowerShell: 2.x.y.z