CfnDirectoryConfigPropsMixin

class aws_cdk.mixins_preview.aws_appstream.mixins.CfnDirectoryConfigPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::AppStream::DirectoryConfig resource specifies the configuration information required to join Amazon AppStream 2.0 fleets and image builders to Microsoft Active Directory domains.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html
CloudformationResource:: AWS::AppStream::DirectoryConfig
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_appstream import mixins as appstream_mixins

cfn_directory_config_props_mixin = appstream_mixins.CfnDirectoryConfigPropsMixin(appstream_mixins.CfnDirectoryConfigMixinProps(
    certificate_based_auth_properties=appstream_mixins.CfnDirectoryConfigPropsMixin.CertificateBasedAuthPropertiesProperty(
        certificate_authority_arn="certificateAuthorityArn",
        status="status"
    ),
    directory_name="directoryName",
    organizational_unit_distinguished_names=["organizationalUnitDistinguishedNames"],
    service_account_credentials=appstream_mixins.CfnDirectoryConfigPropsMixin.ServiceAccountCredentialsProperty(
        account_name="accountName",
        account_password="accountPassword"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::AppStream::DirectoryConfig.

Parameters:

props (Union[CfnDirectoryConfigMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['certificateBasedAuthProperties', 'directoryName', 'organizationalUnitDistinguishedNames', 'serviceAccountCredentials']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CertificateBasedAuthPropertiesProperty

class CfnDirectoryConfigPropsMixin.CertificateBasedAuthPropertiesProperty(*, certificate_authority_arn=None, status=None)

Bases: object

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.

Parameters:

certificate_authority_arn (Optional[str]) – The ARN of the AWS Certificate Manager Private CA resource.
status (Optional[str]) – The status of the certificate-based authentication properties. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_appstream import mixins as appstream_mixins

certificate_based_auth_properties_property = appstream_mixins.CfnDirectoryConfigPropsMixin.CertificateBasedAuthPropertiesProperty(
    certificate_authority_arn="certificateAuthorityArn",
    status="status"
)

Attributes

certificate_authority_arn

The ARN of the AWS Certificate Manager Private CA resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html#cfn-appstream-directoryconfig-certificatebasedauthproperties-certificateauthorityarn

status

The status of the certificate-based authentication properties.

Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html#cfn-appstream-directoryconfig-certificatebasedauthproperties-status

ServiceAccountCredentialsProperty

class CfnDirectoryConfigPropsMixin.ServiceAccountCredentialsProperty(*, account_name=None, account_password=None)

Bases: object

The credentials for the service account used by the streaming instance to connect to the directory.

Parameters:

account_name (Optional[str]) – The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
account_password (Optional[str]) – The password for the account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_appstream import mixins as appstream_mixins

service_account_credentials_property = appstream_mixins.CfnDirectoryConfigPropsMixin.ServiceAccountCredentialsProperty(
    account_name="accountName",
    account_password="accountPassword"
)

Attributes

account_name

The user name of the account.

This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html#cfn-appstream-directoryconfig-serviceaccountcredentials-accountname

account_password

The password for the account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html#cfn-appstream-directoryconfig-serviceaccountcredentials-accountpassword