Class: AWSCDK::CertificateManager::CertificateValidation

Inherits:
Jsii::Object
  • Object
show all
Defined in:
certificate_manager/certificate_validation.rb

Overview

How to validate a certificate.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ CertificateValidation

Returns a new instance of CertificateValidation.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'certificate_manager/certificate_validation.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_certificatemanager.CertificateValidation does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.from_dns(hosted_zone = nil) ⇒ AWSCDK::CertificateManager::CertificateValidation

Validate the certificate with DNS.

IMPORTANT: If hosted_zone is not specified, DNS records must be added manually and the stack will not complete creating until the records are added.

Parameters:

Returns:

  • (AWSCDK::CertificateManager::CertificateValidation) 


27
28
29
30
 
# File 'certificate_manager/certificate_validation.rb', line 27

def self.from_dns(hosted_zone = nil)
  Jsii::Type.check_type(hosted_zone, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5JSG9zdGVkWm9uZSJ9")), "hostedZone") unless hosted_zone.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_certificatemanager.CertificateValidation", "fromDns", [hosted_zone])
end

.from_dns_multi_zone(hosted_zones) ⇒ AWSCDK::CertificateManager::CertificateValidation

Validate the certificate with automatically created DNS records in multiple Amazon Route 53 hosted zones.

Parameters:

  • hosted_zones (Hash{String => AWSCDK::Route53::IHostedZone}) —

    a map of hosted zones where DNS records must be created for the domains in the certificate.

Returns:

  • (AWSCDK::CertificateManager::CertificateValidation) 


36
37
38
39
 
# File 'certificate_manager/certificate_validation.rb', line 36

def self.from_dns_multi_zone(hosted_zones)
  Jsii::Type.check_type(hosted_zones, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzLklIb3N0ZWRab25lIn0sImtpbmQiOiJtYXAifX0=")), "hostedZones")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_certificatemanager.CertificateValidation", "fromDnsMultiZone", [hosted_zones])
end

.from_email(validation_domains = nil) ⇒ AWSCDK::CertificateManager::CertificateValidation

Validate the certificate with Email.

IMPORTANT: if you are creating a certificate as part of your stack, the stack will not complete creating until you read and follow the instructions in the email that you will receive.

ACM will send validation emails to the following addresses:

admin@domain.com administrator@domain.com hostmaster@domain.com postmaster@domain.com webmaster@domain.com

For every domain that you register.

Parameters:

  • validation_domains (Hash{String => String}, nil) (defaults to: nil) —

    a map of validation domains to use for domains in the certificate.

Returns:

  • (AWSCDK::CertificateManager::CertificateValidation) 


59
60
61
62
 
# File 'certificate_manager/certificate_validation.rb', line 59

def self.from_email(validation_domains = nil)
  Jsii::Type.check_type(validation_domains, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "validationDomains") unless validation_domains.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_certificatemanager.CertificateValidation", "fromEmail", [validation_domains])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
 
# File 'certificate_manager/certificate_validation.rb', line 12

def self.jsii_overridable_methods
  {
    :method => { kind: :property, name: "method", is_optional: false },
    :props => { kind: :property, name: "props", is_optional: false },
  }
end

Instance Method Details

#method ⇒ AWSCDK::CertificateManager::ValidationMethod

The validation method.

Returns:



67
68
69
 
# File 'certificate_manager/certificate_validation.rb', line 67

def method()
  jsii_get_property("method")
end

#props ⇒ AWSCDK::CertificateManager::CertificationValidationProps

Certification validation properties.

Returns:



74
75
76
 
# File 'certificate_manager/certificate_validation.rb', line 74

def props()
  jsii_get_property("props")
end