Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. cloudsso
  5. Directory
Alibaba Cloud v3.45.1 published on Thursday, Dec 7, 2023 by Pulumi
pulumi/pulumi-alicloud

alicloud.cloudsso.Directory

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.45.1 published on Thursday, Dec 7, 2023 by Pulumi
pulumi/pulumi-alicloud

    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 And us-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:

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

    MfaAuthenticationStatus string

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    SamlIdentityProviderConfiguration Pulumi.AliCloud.CloudSso.Inputs.DirectorySamlIdentityProviderConfiguration

    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.

    ScimSynchronizationStatus string

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

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

    MfaAuthenticationStatus string

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    SamlIdentityProviderConfiguration DirectorySamlIdentityProviderConfigurationArgs

    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.

    ScimSynchronizationStatus string

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

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

    mfaAuthenticationStatus String

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    samlIdentityProviderConfiguration DirectorySamlIdentityProviderConfiguration

    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.

    scimSynchronizationStatus String

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

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

    mfaAuthenticationStatus string

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    samlIdentityProviderConfiguration DirectorySamlIdentityProviderConfiguration

    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.

    scimSynchronizationStatus string

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

    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_status str

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    saml_identity_provider_configuration DirectorySamlIdentityProviderConfigurationArgs

    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_status str

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

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

    mfaAuthenticationStatus String

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    samlIdentityProviderConfiguration Property Map

    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.

    scimSynchronizationStatus String

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

    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.
    The following state arguments are supported:
    DirectoryName 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-.

    MfaAuthenticationStatus string

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    SamlIdentityProviderConfiguration Pulumi.AliCloud.CloudSso.Inputs.DirectorySamlIdentityProviderConfiguration

    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.

    ScimSynchronizationStatus string

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

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

    MfaAuthenticationStatus string

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    SamlIdentityProviderConfiguration DirectorySamlIdentityProviderConfigurationArgs

    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.

    ScimSynchronizationStatus string

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

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

    mfaAuthenticationStatus String

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    samlIdentityProviderConfiguration DirectorySamlIdentityProviderConfiguration

    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.

    scimSynchronizationStatus String

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

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

    mfaAuthenticationStatus string

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    samlIdentityProviderConfiguration DirectorySamlIdentityProviderConfiguration

    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.

    scimSynchronizationStatus string

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

    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_status str

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    saml_identity_provider_configuration DirectorySamlIdentityProviderConfigurationArgs

    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_status str

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

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

    mfaAuthenticationStatus String

    The mfa authentication status. Valid values: Enabled or Disabled. Default to Enabled.

    samlIdentityProviderConfiguration Property Map

    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.

    scimSynchronizationStatus String

    The scim synchronization status. Valid values: Enabled or Disabled. Default to Disabled.

    Supporting Types

    DirectorySamlIdentityProviderConfiguration, DirectorySamlIdentityProviderConfigurationArgs

    EncodedMetadataDocument string

    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 is Enabled, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parameter sso_status is Disabled, this parameter can be omitted, and the IdP Metadata will remain empty.

    SsoStatus string

    SAML SSO login enabled status. Valid values: Enabled or Disabled. Default to Disabled.

    EncodedMetadataDocument string

    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 is Enabled, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parameter sso_status is Disabled, this parameter can be omitted, and the IdP Metadata will remain empty.

    SsoStatus string

    SAML SSO login enabled status. Valid values: Enabled or Disabled. Default to Disabled.

    encodedMetadataDocument String

    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 is Enabled, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parameter sso_status is Disabled, this parameter can be omitted, and the IdP Metadata will remain empty.

    ssoStatus String

    SAML SSO login enabled status. Valid values: Enabled or Disabled. Default to Disabled.

    encodedMetadataDocument string

    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 is Enabled, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parameter sso_status is Disabled, this parameter can be omitted, and the IdP Metadata will remain empty.

    ssoStatus string

    SAML SSO login enabled status. Valid values: Enabled or Disabled. Default to Disabled.

    encoded_metadata_document str

    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 is Enabled, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parameter sso_status is Disabled, this parameter can be omitted, and the IdP Metadata will remain empty.

    sso_status str

    SAML SSO login enabled status. Valid values: Enabled or Disabled. Default to Disabled.

    encodedMetadataDocument String

    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 is Enabled, this parameter must be provided. If the IdP Metadata has not been uploaded, and the parameter sso_status is Disabled, this parameter can be omitted, and the IdP Metadata will remain empty.

    ssoStatus String

    SAML SSO login enabled status. Valid values: Enabled or Disabled. Default to Disabled.

    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.

    alicloud logo
    Alibaba Cloud v3.45.1 published on Thursday, Dec 7, 2023 by Pulumi
    pulumi/pulumi-alicloud