Skip to content
v2.275.0

SamlPropertiesProperty Struct ​

Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspaces as workspaces } from 'aws-cdk-lib';
const samlPropertiesProperty: workspaces.CfnDirectory.SamlPropertiesProperty = {
  relayStateParameterName: 'relayStateParameterName',
  status: 'status',
  userAccessUrl: 'userAccessUrl',
};

Properties ​

relayStateParameterNameoptionalstringrelay_state_parameter_nameoptionalstrrelayStateParameterNameoptionalStringRelayStateParameterNameoptionalstringRelayStateParameterNameoptional*string#
The relay state parameter name supported by the SAML 2.0 identity provider (IdP).
statusoptionalstringstatusoptionalstrstatusoptionalStringStatusoptionalstringStatusoptional*string#
Indicates the status of SAML 2.0 authentication.
userAccessUrloptionalstringuser_access_urloptionalstruserAccessUrloptionalStringUserAccessUrloptionalstringUserAccessUrloptional*string#
The SAML 2.0 identity provider (IdP) user access URL.