Class: AWSCDK::Cognito::CfnUserPoolDomain::CustomDomainConfigTypeProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Cognito::CfnUserPoolDomain::CustomDomainConfigTypeProperty

Defined in:

cognito/cfn_user_pool_domain.rb

Overview

The configuration for a hosted UI custom domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html

Instance Attribute Summary

• #certificate_arn ⇒ String^? readonly

  The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(certificate_arn: nil) ⇒ CustomDomainConfigTypeProperty constructor

  A new instance of CustomDomainConfigTypeProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(certificate_arn: nil) ⇒ CustomDomainConfigTypeProperty

Returns a new instance of CustomDomainConfigTypeProperty.

Parameters:

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

  The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate.

# File 'cognito/cfn_user_pool_domain.rb', line 552

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

Instance Attribute Details

#certificate_arn ⇒ String^? (readonly)

The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate.

You use this certificate for the subdomain of your custom domain.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html#cfn-cognito-userpooldomain-customdomainconfigtype-certificatearn

# File 'cognito/cfn_user_pool_domain.rb', line 563

def certificate_arn
  @certificate_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cognito/cfn_user_pool_domain.rb', line 565

def self.jsii_properties
  {
    :certificate_arn => "certificateArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cognito/cfn_user_pool_domain.rb', line 571

def to_jsii
  result = {}
  result.merge!({
    "certificateArn" => @certificate_arn,
  })
  result.compact
end