Skip to content

SAMLProviderProps

Properties for defining a SAMLProvider.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ram-samlprovider

Initializer 

import com.aliyun.ros.cdk.ram.SAMLProviderProps;
SAMLProviderProps.builder()
    .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();

Properties

Name Type 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.

samlProviderNameRequired 

public java.lang.Object getSamlProviderName();
  • 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.

descriptionOptional 

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

encodedSamlMetadataDocumentOptional 

public java.lang.Object getEncodedSamlMetadataDocument();
  • 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.

samlMetadataDocumentOptional 

public java.lang.Object getSamlMetadataDocument();
  • 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.

samlMetadataDocumentUrlOptional 

public java.lang.Object getSamlMetadataDocumentUrl();
  • 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.