CfnDirectoryProps Struct Added in v2.274.0
Properties for defining a CfnDirectory.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspaces as workspaces } from 'aws-cdk-lib';
const cfnDirectoryProps: workspaces.CfnDirectoryProps = {
activeDirectoryConfig: {
domainName: 'domainName',
serviceAccountSecretArn: 'serviceAccountSecretArn',
},
certificateBasedAuthProperties: {
certificateAuthorityArn: 'certificateAuthorityArn',
status: 'status',
},
enableSelfService: false,
endpointEncryptionMode: 'endpointEncryptionMode',
idcInstanceArn: 'idcInstanceArn',
ipGroupIds: ['ipGroupIds'],
microsoftEntraConfig: {
applicationConfigSecretArn: 'applicationConfigSecretArn',
tenantId: 'tenantId',
},
samlProperties: {
relayStateParameterName: 'relayStateParameterName',
status: 'status',
userAccessUrl: 'userAccessUrl',
},
selfservicePermissions: {
changeComputeType: 'changeComputeType',
increaseVolumeSize: 'increaseVolumeSize',
rebuildWorkspace: 'rebuildWorkspace',
restartWorkspace: 'restartWorkspace',
switchRunningMode: 'switchRunningMode',
},
streamingProperties: {
globalAccelerator: {
mode: 'mode',
// the properties below are optional
preferredProtocol: 'preferredProtocol',
},
storageConnectors: [{
connectorType: 'connectorType',
status: 'status',
}],
streamingExperiencePreferredProtocol: 'streamingExperiencePreferredProtocol',
userSettings: [{
action: 'action',
permission: 'permission',
// the properties below are optional
maximumLength: 123,
}],
},
subnetIds: ['subnetIds'],
tags: [{
key: 'key',
value: 'value',
}],
tenancy: 'tenancy',
userIdentityType: 'userIdentityType',
workspaceAccessProperties: {
accessEndpointConfig: {
accessEndpoints: [{
accessEndpointType: 'accessEndpointType',
vpcEndpointId: 'vpcEndpointId',
}],
// the properties below are optional
internetFallbackProtocols: ['internetFallbackProtocols'],
},
deviceTypeAndroid: 'deviceTypeAndroid',
deviceTypeChromeOs: 'deviceTypeChromeOs',
deviceTypeIos: 'deviceTypeIos',
deviceTypeLinux: 'deviceTypeLinux',
deviceTypeOsx: 'deviceTypeOsx',
deviceTypeWeb: 'deviceTypeWeb',
deviceTypeWindows: 'deviceTypeWindows',
deviceTypeWorkSpacesThinClient: 'deviceTypeWorkSpacesThinClient',
deviceTypeZeroClient: 'deviceTypeZeroClient',
},
workspaceCreationProperties: {
customSecurityGroupId: 'customSecurityGroupId',
defaultOu: 'defaultOu',
enableInternetAccess: false,
enableMaintenanceMode: false,
instanceIamRoleArn: 'instanceIamRoleArn',
userEnabledAsLocalAdministrator: false,
},
workspaceDirectoryDescription: 'workspaceDirectoryDescription',
workspaceDirectoryName: 'workspaceDirectoryName',
workspaceType: 'workspaceType',
};
Properties
activeDirectoryConfigIResolvable | CfnDirectory.ActiveDirectoryConfigPropertyactive_directory_configtyping.Union[IResolvable, ActiveDirectoryConfigProperty]activeDirectoryConfigIResolvableActiveDirectoryConfigIResolvableActiveDirectoryConfiginterface{}#Information about the Active Directory config.
certificateBasedAuthPropertiesIResolvable | CfnDirectory.CertificateBasedAuthPropertiesPropertycertificate_based_auth_propertiestyping.Union[IResolvable, CertificateBasedAuthPropertiesProperty]certificateBasedAuthPropertiesIResolvableCertificateBasedAuthPropertiesIResolvableCertificateBasedAuthPropertiesinterface{}#Describes the properties of the certificate-based authentication you want to use with your WorkSpaces.
enableSelfServiceboolean | IResolvableenable_self_servicetyping.Union[bool, IResolvable]enableSelfServiceBooleanEnableSelfServiceboolEnableSelfServiceinterface{}#Indicates whether self-service capabilities are enabled or disabled.
endpointEncryptionModestringendpoint_encryption_modestrendpointEncryptionModeStringEndpointEncryptionModestringEndpointEncryptionMode*string#Endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.
idcInstanceArnstringidc_instance_arnstridcInstanceArnStringIdcInstanceArnstringIdcInstanceArn*string#The Amazon Resource Name (ARN) of the identity center instance.
ipGroupIdsstring[]ip_group_idstyping.List[str]ipGroupIdsList<String>IpGroupIdsstring[]IpGroupIds*[]*string#The identifiers of the IP access control groups associated with the directory.
microsoftEntraConfigIResolvable | CfnDirectory.MicrosoftEntraConfigPropertymicrosoft_entra_configtyping.Union[IResolvable, MicrosoftEntraConfigProperty]microsoftEntraConfigIResolvableMicrosoftEntraConfigIResolvableMicrosoftEntraConfiginterface{}#Specifies the configurations of the Microsoft Entra.
samlPropertiesIResolvable | CfnDirectory.SamlPropertiesPropertysaml_propertiestyping.Union[IResolvable, SamlPropertiesProperty]samlPropertiesIResolvableSamlPropertiesIResolvableSamlPropertiesinterface{}#Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
selfservicePermissionsIResolvable | CfnDirectory.SelfservicePermissionsPropertyselfservice_permissionstyping.Union[IResolvable, SelfservicePermissionsProperty]selfservicePermissionsIResolvableSelfservicePermissionsIResolvableSelfservicePermissionsinterface{}#Describes the self-service permissions for a directory.
streamingPropertiesIResolvable | CfnDirectory.StreamingPropertiesPropertystreaming_propertiestyping.Union[IResolvable, StreamingPropertiesProperty]streamingPropertiesIResolvableStreamingPropertiesIResolvableStreamingPropertiesinterface{}#Describes the streaming properties.
subnetIdsstring[]subnet_idstyping.List[str]subnetIdsList<String>SubnetIdsstring[]SubnetIds*[]*string#The identifiers of the subnets for your virtual private cloud (VPC).
The tags associated with the directory.
Indicates whether your WorkSpace directory is dedicated or shared.
userIdentityTypestringuser_identity_typestruserIdentityTypeStringUserIdentityTypestringUserIdentityType*string#The type of identity management the user is using.
workspaceAccessPropertiesIResolvable | CfnDirectory.WorkspaceAccessPropertiesPropertyworkspace_access_propertiestyping.Union[IResolvable, WorkspaceAccessPropertiesProperty]workspaceAccessPropertiesIResolvableWorkspaceAccessPropertiesIResolvableWorkspaceAccessPropertiesinterface{}#The device types and operating systems that can be used to access a WorkSpace.
workspaceCreationPropertiesIResolvable | CfnDirectory.DefaultWorkspaceCreationPropertiesPropertyworkspace_creation_propertiestyping.Union[IResolvable, DefaultWorkspaceCreationPropertiesProperty]workspaceCreationPropertiesIResolvableWorkspaceCreationPropertiesIResolvableWorkspaceCreationPropertiesinterface{}#The default values that are used to create WorkSpaces.
workspaceDirectoryDescriptionstringworkspace_directory_descriptionstrworkspaceDirectoryDescriptionStringWorkspaceDirectoryDescriptionstringWorkspaceDirectoryDescription*string#Description of the directory to register.
workspaceDirectoryNamestringworkspace_directory_namestrworkspaceDirectoryNameStringWorkspaceDirectoryNamestringWorkspaceDirectoryName*string#The name of the directory to register.
Indicates whether the directory's WorkSpace type is personal or pools.