Skip to content

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 ros_cdk_ram
ros_cdk_ram.SAMLProvider(
  scope: Construct,
  id: str,
  saml_provider_name: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  encoded_saml_metadata_document: typing.Union[str, IResolvable] = None,
  saml_metadata_document: typing.Union[str, IResolvable] = None,
  saml_metadata_document_url: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
saml_provider_name typing.Union[str, ros_cdk_core.IResolvable] Property samlProviderName: IdP Name.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description can contain a maximum of 256 characters.
encoded_saml_metadata_document typing.Union[str, 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.
saml_metadata_document typing.Union[str, ros_cdk_core.IResolvable] Property samlMetadataDocument: SAML metadata document.
saml_metadata_document_url typing.Union[str, ros_cdk_core.IResolvable] Property samlMetadataDocumentUrl: The URL for the file that contains the SAML metadata document.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

saml_provider_nameRequired

  • Type: typing.Union[str, 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

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

encoded_saml_metadata_documentOptional

  • Type: typing.Union[str, 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.

saml_metadata_documentOptional

  • Type: typing.Union[str, 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.

saml_metadata_document_urlOptional

  • Type: typing.Union[str, 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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

import ros_cdk_ram
ros_cdk_ram.SAMLProvider.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_arn ros_cdk_core.IResolvable Attribute Arn: ARN.
attr_saml_provider_name ros_cdk_core.IResolvable Attribute SAMLProviderName: IdP Name.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_arnRequired 

attr_arn: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Arn: ARN.

attr_saml_provider_nameRequired 

attr_saml_provider_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SAMLProviderName: IdP Name.