Skip to content

SAMLIdentityProvider

This class encapsulates and extends the ROS resource type ALIYUN::CloudSSO::SAMLIdentityProvider, which is used to configure the information about a Security Assertion Markup Language (SAML) identity provider (IdP).

Initializers 

import com.aliyun.ros.cdk.cloudsso.SAMLIdentityProvider;
SAMLIdentityProvider.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .directoryId(java.lang.String)
    .directoryId(IResolvable)
//  .encodedMetadataDocument(java.lang.String)
//  .encodedMetadataDocument(IResolvable)
//  .entityId(java.lang.String)
//  .entityId(IResolvable)
//  .loginUrl(java.lang.String)
//  .loginUrl(IResolvable)
//  .ssoStatus(java.lang.String)
//  .ssoStatus(IResolvable)
//  .wantRequestSigned(java.lang.Boolean)
//  .wantRequestSigned(IResolvable)
//  .x509Certificate(java.lang.String)
//  .x509Certificate(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
directoryId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property directoryId: The ID of the directory.
encodedMetadataDocument java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property encodedMetadataDocument: The metadata file of the IdP.
entityId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property entityId: The entity ID of the IdP.
loginUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loginUrl: The logon URL of the IdP.
ssoStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ssoStatus: The status of SSO logon.
wantRequestSigned java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property wantRequestSigned: Specifies whether CloudSSO needs to sign SAML requests.
x509Certificate java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property x509Certificate: The X.509 certificate n the PEM format. If you specify this parameter, all existing certificates are replaced.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

directoryIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property directoryId: The ID of the directory.

encodedMetadataDocumentOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property encodedMetadataDocument: The metadata file of the IdP.

The value of this parameter is Base64-encoded. The file is provided by the IdP that supports SAML 2.0.

entityIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property entityId: The entity ID of the IdP.

loginUrlOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property loginUrl: The logon URL of the IdP.

ssoStatusOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ssoStatus: The status of SSO logon.

Valid values:

  • Enabled
  • Disabled (default)

wantRequestSignedOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property wantRequestSigned: Specifies whether CloudSSO needs to sign SAML requests.

The requests are sent when users log on to the CloudSSO user portal to initiate SAML-based SSO. Valid values:

  • true: yes
  • false: no (default)

x509CertificateOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property x509Certificate: The X.509 certificate n the PEM format. If you specify this parameter, all existing certificates are replaced.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.cloudsso.SAMLIdentityProvider;
SAMLIdentityProvider.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource