SAMLProvider

• Implements: ISAMLProvider

This class encapsulates and extends the ROS resource type ALIYUN::RAM::SAMLProvider.

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();

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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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 java.lang.Object getAttrArn();

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

Attribute Arn: ARN.

attrSamlProviderName^Required

public java.lang.Object getAttrSamlProviderName();

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

Attribute SAMLProviderName: IdP Name.

props^Required

public SAMLProviderProps getProps();

• Type: SAMLProviderProps