Class: AWSCDK::Amplify::CfnDomain::CertificateSettingsProperty

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

Overview

The type of SSL/TLS certificate to use for your custom domain.

If a certificate type isn't specified, Amplify uses the default AMPLIFY_MANAGED certificate.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(certificate_type: nil, custom_certificate_arn: nil) ⇒ CertificateSettingsProperty

Returns a new instance of CertificateSettingsProperty.

Parameters:

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

    The certificate type.

  • custom_certificate_arn (String, nil) (defaults to: nil)

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



732
733
734
735
736
737
# File 'amplify/cfn_domain.rb', line 732

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

Instance Attribute Details

#certificate_typeString? (readonly)

The certificate type.

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 .



747
748
749
# File 'amplify/cfn_domain.rb', line 747

def certificate_type
  @certificate_type
end

#custom_certificate_arnString? (readonly)

The Amazon resource name (ARN) for the 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 .



754
755
756
# File 'amplify/cfn_domain.rb', line 754

def custom_certificate_arn
  @custom_certificate_arn
end

Class Method Details

.jsii_propertiesObject



756
757
758
759
760
761
# File 'amplify/cfn_domain.rb', line 756

def self.jsii_properties
  {
    :certificate_type => "certificateType",
    :custom_certificate_arn => "customCertificateArn",
  }
end

Instance Method Details

#to_jsiiObject



763
764
765
766
767
768
769
770
# File 'amplify/cfn_domain.rb', line 763

def to_jsii
  result = {}
  result.merge!({
    "certificateType" => @certificate_type,
    "customCertificateArn" => @custom_certificate_arn,
  })
  result.compact
end