Class: AWSCDK::Amplify::CfnDomain::CertificateProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
amplify/cfn_domain.rb

Overview

Describes the SSL/TLS certificate for the domain association.

This can be your own custom certificate or the default certificate that Amplify provisions for you.

If you are updating your domain to use a different certificate, Certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, Certificate points to the current active certificate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(certificate_arn: nil, certificate_type: nil, certificate_verification_dns_record: nil) ⇒ CertificateProperty

Returns a new instance of CertificateProperty.

Parameters:

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

    The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate Manager in your AWS account .

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

    The type of SSL/TLS certificate that you want to use.

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

    The DNS record for certificate verification.



672
673
674
675
676
677
678
679
 
# File 'amplify/cfn_domain.rb', line 672

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

Instance Attribute Details

#certificate_arn ⇒ String? (readonly)

The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate Manager in your AWS account .

This field is required only when the certificate type is CUSTOM .

Returns:

  • (String, nil)

See Also:



687
688
689
 
# File 'amplify/cfn_domain.rb', line 687

def certificate_arn
  @certificate_arn
end

#certificate_type ⇒ String? (readonly)

The type of SSL/TLS certificate that you want to use.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide .

Returns:

  • (String, nil)

See Also:



696
697
698
 
# File 'amplify/cfn_domain.rb', line 696

def certificate_type
  @certificate_type
end

#certificate_verification_dns_record ⇒ String? (readonly)

The DNS record for certificate verification.

Returns:

  • (String, nil)

See Also:



701
702
703
 
# File 'amplify/cfn_domain.rb', line 701

def certificate_verification_dns_record
  @certificate_verification_dns_record
end

Class Method Details

.jsii_properties ⇒ Object 



703
704
705
706
707
708
709
 
# File 'amplify/cfn_domain.rb', line 703

def self.jsii_properties
  {
    :certificate_arn => "certificateArn",
    :certificate_type => "certificateType",
    :certificate_verification_dns_record => "certificateVerificationDnsRecord",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



711
712
713
714
715
716
717
718
719
 
# File 'amplify/cfn_domain.rb', line 711

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