Class: AWSCDK::AppStream::CfnDirectoryConfig::CertificateBasedAuthPropertiesProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::AppStream::CfnDirectoryConfig::CertificateBasedAuthPropertiesProperty

Defined in:

app_stream/cfn_directory_config.rb

Overview

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

See Also:

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

Instance Attribute Summary

• #certificate_authority_arn ⇒ String^? readonly

  The ARN of the AWS Certificate Manager Private CA resource.

• #status ⇒ String^? readonly

  The status of the certificate-based authentication properties.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(certificate_authority_arn: nil, status: nil) ⇒ CertificateBasedAuthPropertiesProperty constructor

  A new instance of CertificateBasedAuthPropertiesProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(certificate_authority_arn: nil, status: nil) ⇒ CertificateBasedAuthPropertiesProperty

Returns a new instance of CertificateBasedAuthPropertiesProperty.

Parameters:

• certificate_authority_arn (String, nil) (defaults to: nil) —

  The ARN of the AWS Certificate Manager Private CA resource.

• status (String, nil) (defaults to: nil) —

  The status of the certificate-based authentication properties.

# File 'app_stream/cfn_directory_config.rb', line 534

def initialize(certificate_authority_arn: nil, status: nil)
  @certificate_authority_arn = certificate_authority_arn
  Jsii::Type.check_type(@certificate_authority_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateAuthorityArn") unless @certificate_authority_arn.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
end

Instance Attribute Details

#certificate_authority_arn ⇒ String^? (readonly)

The ARN of the AWS Certificate Manager Private CA resource.

Returns:

• (String, nil)

See Also:

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

# File 'app_stream/cfn_directory_config.rb', line 545

def certificate_authority_arn
  @certificate_authority_arn
end

#status ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

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

# File 'app_stream/cfn_directory_config.rb', line 552

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object

# File 'app_stream/cfn_directory_config.rb', line 554

def self.jsii_properties
  {
    :certificate_authority_arn => "certificateAuthorityArn",
    :status => "status",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'app_stream/cfn_directory_config.rb', line 561

def to_jsii
  result = {}
  result.merge!({
    "certificateAuthorityArn" => @certificate_authority_arn,
    "status" => @status,
  })
  result.compact
end