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 ros_cdk_cloudsso
ros_cdk_cloudsso.SAMLIdentityProvider(
  scope: Construct,
  id: str,
  directory_id: typing.Union[str, IResolvable],
  encoded_metadata_document: typing.Union[str, IResolvable] = None,
  entity_id: typing.Union[str, IResolvable] = None,
  login_url: typing.Union[str, IResolvable] = None,
  sso_status: typing.Union[str, IResolvable] = None,
  want_request_signed: typing.Union[bool, IResolvable] = None,
  x509_certificate: 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.
directory_id	typing.Union[str, ros_cdk_core.IResolvable]	Property directoryId: The ID of the directory.
encoded_metadata_document	typing.Union[str, ros_cdk_core.IResolvable]	Property encodedMetadataDocument: The metadata file of the IdP.
entity_id	typing.Union[str, ros_cdk_core.IResolvable]	Property entityId: The entity ID of the IdP.
login_url	typing.Union[str, ros_cdk_core.IResolvable]	Property loginUrl: The logon URL of the IdP.
sso_status	typing.Union[str, ros_cdk_core.IResolvable]	Property ssoStatus: The status of SSO logon.
want_request_signed	typing.Union[bool, ros_cdk_core.IResolvable]	Property wantRequestSigned: Specifies whether CloudSSO needs to sign SAML requests.
x509_certificate	typing.Union[str, ros_cdk_core.IResolvable]	Property x509Certificate: The X.509 certificate n the PEM format. If you specify this parameter, all existing certificates are replaced.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

directory_id^Required

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

Property directoryId: The ID of the directory.

---

encoded_metadata_document^Optional

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

---

entity_id^Optional

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

Property entityId: The entity ID of the IdP.

---

login_url^Optional

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

Property loginUrl: The logon URL of the IdP.

---

sso_status^Optional

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

Property ssoStatus: The status of SSO logon.

Valid values:

• Enabled
• Disabled (default)

---

want_request_signed^Optional

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

---

x509_certificate^Optional

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

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

---

enable_resource_property_constraint^Optional

• 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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

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

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

import ros_cdk_cloudsso
ros_cdk_cloudsso.SAMLIdentityProvider.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---