SAMLProvider

This class encapsulates and extends the ROS resource type ALIYUN::RAM::SAMLProvider, which is used to create an identity provider (IdP) for role-based single sign-on (SSO).

Initializers

import com.aliyun.ros.cdk.ram.SAMLProvider;
SAMLProvider.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .samlProviderName(java.lang.String)
    .samlProviderName(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .encodedSamlMetadataDocument(java.lang.String)
//  .encodedSamlMetadataDocument(IResolvable)
//  .samlMetadataDocument(java.lang.String)
//  .samlMetadataDocument(IResolvable)
//  .samlMetadataDocumentUrl(java.lang.String)
//  .samlMetadataDocumentUrl(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.
samlProviderName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property samlProviderName: IdP Name.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: The description can contain a maximum of 256 characters.
encodedSamlMetadataDocument	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property encodedSamlMetadataDocument: SAML metadata document.Base64 encoded. Provided by an identity provider that supports the SAML2.0 protocol. Only one of the three properties SAMLMetadataDocument, SAMLMetadataDocumentURL, EncodedSAMLMetadataDocument can be set.
samlMetadataDocument	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property samlMetadataDocument: SAML metadata document.
samlMetadataDocumentUrl	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property samlMetadataDocumentUrl: The URL for the file that contains the SAML metadata document.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

samlProviderName^Required

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

Property samlProviderName: IdP Name.

The IdP name can contain a maximum of 128 characters and only letters, numbers, and the following special characters are accepted: hyphens (-), periods (.), and underscores (_). It cannot start or end with a special character.

---

description^Optional

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

Property description: The description can contain a maximum of 256 characters.

---

encodedSamlMetadataDocument^Optional

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

Property encodedSamlMetadataDocument: SAML metadata document.Base64 encoded. Provided by an identity provider that supports the SAML2.0 protocol. Only one of the three properties SAMLMetadataDocument, SAMLMetadataDocumentURL, EncodedSAMLMetadataDocument can be set.

---

samlMetadataDocument^Optional

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

Property samlMetadataDocument: SAML metadata document.

The content must be 1 to 102,400 bytes in length. Only one of the three properties SAMLMetadataDocument, SAMLMetadataDocumentURL, EncodedSAMLMetadataDocument can be set.

---

samlMetadataDocumentUrl^Optional

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

Property samlMetadataDocumentUrl: The URL for the file that contains the SAML metadata document.

The URL must point to a document located in an HTTP or HTTPS web server or an Alibaba Cloud OSS bucket. Examples: oss://ros/document/demo and oss://ros/document/demo?RegionId=cn-hangzhou. The URL can be up to 1,024 bytes in length. Only one of the three properties SAMLMetadataDocument, SAMLMetadataDocumentURL, EncodedSAMLMetadataDocument can be set.

---

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.

session^Required

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

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

---

addCount

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

count^Required

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

---

addDependency

public void addDependency(Resource resource)

resource^Required

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

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

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

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

import com.aliyun.ros.cdk.ram.SAMLProvider;
SAMLProvider.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• 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.
attrArn	com.aliyun.ros.cdk.core.IResolvable	Attribute Arn: ARN.
attrSamlProviderName	com.aliyun.ros.cdk.core.IResolvable	Attribute SAMLProviderName: IdP Name.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

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

---

attrArn^Required

public IResolvable getAttrArn();

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

Attribute Arn: ARN.

---

attrSamlProviderName^Required

public IResolvable getAttrSamlProviderName();

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

Attribute SAMLProviderName: IdP Name.

---