alicloud.cloudsso.Directory
Explore with Pulumi AI
Provides a Cloud SSO Directory resource.
For information about Cloud SSO Directory and how to use it, see What is Directory.
NOTE: Available since v1.135.0.
NOTE: Cloud SSO Only Support
cn-shanghai
Andus-west-1
Region
Create Directory Resource
new Directory(name: string, args?: DirectoryArgs, opts?: CustomResourceOptions);
@overload
def Directory(resource_name: str,
opts: Optional[ResourceOptions] = None,
directory_name: Optional[str] = None,
mfa_authentication_status: Optional[str] = None,
saml_identity_provider_configuration: Optional[DirectorySamlIdentityProviderConfigurationArgs] = None,
scim_synchronization_status: Optional[str] = None)
@overload
def Directory(resource_name: str,
args: Optional[DirectoryArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewDirectory(ctx *Context, name string, args *DirectoryArgs, opts ...ResourceOption) (*Directory, error)
public Directory(string name, DirectoryArgs? args = null, CustomResourceOptions? opts = null)
public Directory(String name, DirectoryArgs args)
public Directory(String name, DirectoryArgs args, CustomResourceOptions options)
type: alicloud:cloudsso:Directory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DirectoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DirectoryArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DirectoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DirectoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DirectoryArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Directory Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Directory resource accepts the following input properties:
- Directory
Name string The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- Mfa
Authentication stringStatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- Saml
Identity Pulumi.Provider Configuration Ali Cloud. Cloud Sso. Inputs. Directory Saml Identity Provider Configuration The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- Scim
Synchronization stringStatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- Directory
Name string The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- Mfa
Authentication stringStatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- Saml
Identity DirectoryProvider Configuration Saml Identity Provider Configuration Args The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- Scim
Synchronization stringStatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- directory
Name String The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- mfa
Authentication StringStatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- saml
Identity DirectoryProvider Configuration Saml Identity Provider Configuration The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- scim
Synchronization StringStatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- directory
Name string The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- mfa
Authentication stringStatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- saml
Identity DirectoryProvider Configuration Saml Identity Provider Configuration The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- scim
Synchronization stringStatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- directory_
name str The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- mfa_
authentication_ strstatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- saml_
identity_ Directoryprovider_ configuration Saml Identity Provider Configuration Args The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- scim_
synchronization_ strstatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- directory
Name String The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- mfa
Authentication StringStatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- saml
Identity Property MapProvider Configuration The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- scim
Synchronization StringStatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
Outputs
All input properties are implicitly available as output properties. Additionally, the Directory resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing Directory Resource
Get an existing Directory resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DirectoryState, opts?: CustomResourceOptions): Directory
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
directory_name: Optional[str] = None,
mfa_authentication_status: Optional[str] = None,
saml_identity_provider_configuration: Optional[DirectorySamlIdentityProviderConfigurationArgs] = None,
scim_synchronization_status: Optional[str] = None) -> Directory
func GetDirectory(ctx *Context, name string, id IDInput, state *DirectoryState, opts ...ResourceOption) (*Directory, error)
public static Directory Get(string name, Input<string> id, DirectoryState? state, CustomResourceOptions? opts = null)
public static Directory get(String name, Output<String> id, DirectoryState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Directory
Name string The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- Mfa
Authentication stringStatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- Saml
Identity Pulumi.Provider Configuration Ali Cloud. Cloud Sso. Inputs. Directory Saml Identity Provider Configuration The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- Scim
Synchronization stringStatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- Directory
Name string The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- Mfa
Authentication stringStatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- Saml
Identity DirectoryProvider Configuration Saml Identity Provider Configuration Args The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- Scim
Synchronization stringStatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- directory
Name String The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- mfa
Authentication StringStatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- saml
Identity DirectoryProvider Configuration Saml Identity Provider Configuration The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- scim
Synchronization StringStatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- directory
Name string The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- mfa
Authentication stringStatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- saml
Identity DirectoryProvider Configuration Saml Identity Provider Configuration The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- scim
Synchronization stringStatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- directory_
name str The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- mfa_
authentication_ strstatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- saml_
identity_ Directoryprovider_ configuration Saml Identity Provider Configuration Args The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- scim_
synchronization_ strstatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- directory
Name String The name of the CloudSSO directory. The length is 2-64 characters, and it can contain lowercase letters, numbers, and dashes (-). It cannot start or end with a dash and cannot have two consecutive dashes. Need to be globally unique, and capitalization is not supported. Cannot start with
d-
.- mfa
Authentication StringStatus The mfa authentication status. Valid values:
Enabled
orDisabled
. Default toEnabled
.- saml
Identity Property MapProvider Configuration The saml identity provider configuration. See
saml_identity_provider_configuration
below.NOTE: The
saml_identity_provider_configuration
will be removed automatically when the resource is deleted, please operate with caution. If there are left more configuration in the directory, please remove them before deleting the directory.- scim
Synchronization StringStatus The scim synchronization status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
Supporting Types
DirectorySamlIdentityProviderConfiguration, DirectorySamlIdentityProviderConfigurationArgs
- Encoded
Metadata stringDocument Base64 encoded IdP metadata document. NOTE: If the IdP Metadata has been uploaded, no update will be made if this parameter is not specified, otherwise the update will be made according to the parameter content. If IdP Metadata has not been uploaded, and the parameter
sso_status
isEnabled
, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parametersso_status
isDisabled
, this parameter can be omitted, and the IdP Metadata will remain empty.- Sso
Status string SAML SSO login enabled status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- Encoded
Metadata stringDocument Base64 encoded IdP metadata document. NOTE: If the IdP Metadata has been uploaded, no update will be made if this parameter is not specified, otherwise the update will be made according to the parameter content. If IdP Metadata has not been uploaded, and the parameter
sso_status
isEnabled
, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parametersso_status
isDisabled
, this parameter can be omitted, and the IdP Metadata will remain empty.- Sso
Status string SAML SSO login enabled status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- encoded
Metadata StringDocument Base64 encoded IdP metadata document. NOTE: If the IdP Metadata has been uploaded, no update will be made if this parameter is not specified, otherwise the update will be made according to the parameter content. If IdP Metadata has not been uploaded, and the parameter
sso_status
isEnabled
, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parametersso_status
isDisabled
, this parameter can be omitted, and the IdP Metadata will remain empty.- sso
Status String SAML SSO login enabled status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- encoded
Metadata stringDocument Base64 encoded IdP metadata document. NOTE: If the IdP Metadata has been uploaded, no update will be made if this parameter is not specified, otherwise the update will be made according to the parameter content. If IdP Metadata has not been uploaded, and the parameter
sso_status
isEnabled
, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parametersso_status
isDisabled
, this parameter can be omitted, and the IdP Metadata will remain empty.- sso
Status string SAML SSO login enabled status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- encoded_
metadata_ strdocument Base64 encoded IdP metadata document. NOTE: If the IdP Metadata has been uploaded, no update will be made if this parameter is not specified, otherwise the update will be made according to the parameter content. If IdP Metadata has not been uploaded, and the parameter
sso_status
isEnabled
, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parametersso_status
isDisabled
, this parameter can be omitted, and the IdP Metadata will remain empty.- sso_
status str SAML SSO login enabled status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
- encoded
Metadata StringDocument Base64 encoded IdP metadata document. NOTE: If the IdP Metadata has been uploaded, no update will be made if this parameter is not specified, otherwise the update will be made according to the parameter content. If IdP Metadata has not been uploaded, and the parameter
sso_status
isEnabled
, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parametersso_status
isDisabled
, this parameter can be omitted, and the IdP Metadata will remain empty.- sso
Status String SAML SSO login enabled status. Valid values:
Enabled
orDisabled
. Default toDisabled
.
Import
Cloud SSO Directory can be imported using the id, e.g.
$ pulumi import alicloud:cloudsso/directory:Directory example <id>
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.