Class: AWSCDK::ACMPCA::CfnCertificateProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
acmpca/cfn_certificate_props.rb

Overview

Properties for defining a CfnCertificate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(certificate_authority_arn:, certificate_signing_request:, signing_algorithm:, validity:, api_passthrough: nil, template_arn: nil, validity_not_before: nil) ⇒ CfnCertificateProps

Returns a new instance of CfnCertificateProps.

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'acmpca/cfn_certificate_props.rb', line 16

def initialize(certificate_authority_arn:, certificate_signing_request:, signing_algorithm:, validity:, api_passthrough: nil, template_arn: nil, validity_not_before: nil)
  @certificate_authority_arn = certificate_authority_arn
  Jsii::Type.check_type(@certificate_authority_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hY21wY2EuSUNlcnRpZmljYXRlQXV0aG9yaXR5UmVmIn1dfX0=")), "certificateAuthorityArn")
  @certificate_signing_request = certificate_signing_request
  Jsii::Type.check_type(@certificate_signing_request, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateSigningRequest")
  @signing_algorithm = signing_algorithm
  Jsii::Type.check_type(@signing_algorithm, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "signingAlgorithm")
  @validity = validity.is_a?(Hash) ? ::AWSCDK::ACMPCA::CfnCertificate::ValidityProperty.new(**validity.transform_keys(&:to_sym)) : validity
  Jsii::Type.check_type(@validity, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hY21wY2EuQ2ZuQ2VydGlmaWNhdGUuVmFsaWRpdHlQcm9wZXJ0eSJ9XX19")), "validity")
  @api_passthrough = api_passthrough.is_a?(Hash) ? ::AWSCDK::ACMPCA::CfnCertificate::APIPassthroughProperty.new(**api_passthrough.transform_keys(&:to_sym)) : api_passthrough
  Jsii::Type.check_type(@api_passthrough, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hY21wY2EuQ2ZuQ2VydGlmaWNhdGUuQXBpUGFzc3Rocm91Z2hQcm9wZXJ0eSJ9XX19")), "apiPassthrough") unless @api_passthrough.nil?
  @template_arn = template_arn
  Jsii::Type.check_type(@template_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hY21wY2EuSUNlcnRpZmljYXRlQXV0aG9yaXR5UmVmIn1dfX0=")), "templateArn") unless @template_arn.nil?
  @validity_not_before = validity_not_before.is_a?(Hash) ? ::AWSCDK::ACMPCA::CfnCertificate::ValidityProperty.new(**validity_not_before.transform_keys(&:to_sym)) : validity_not_before
  Jsii::Type.check_type(@validity_not_before, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hY21wY2EuQ2ZuQ2VydGlmaWNhdGUuVmFsaWRpdHlQcm9wZXJ0eSJ9XX19")), "validityNotBefore") unless @validity_not_before.nil?
end

Instance Attribute Details

#api_passthrough ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored.

Returns:

See Also:



61
62
63
 
# File 'acmpca/cfn_certificate_props.rb', line 61

def api_passthrough
  @api_passthrough
end

#certificate_authority_arn ⇒ String, AWSCDK::Interfaces::AWSAcmpca::ICertificateAuthorityRef (readonly)

The Amazon Resource Name (ARN) for the private CA issues the certificate.

Returns:

See Also:



37
38
39
 
# File 'acmpca/cfn_certificate_props.rb', line 37

def certificate_authority_arn
  @certificate_authority_arn
end

#certificate_signing_request ⇒ String (readonly)

The certificate signing request (CSR) for the certificate.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'acmpca/cfn_certificate_props.rb', line 42

def certificate_signing_request
  @certificate_signing_request
end

#signing_algorithm ⇒ String (readonly)

The name of the algorithm that will be used to sign the certificate to be issued.

This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action.

The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

Returns:

  • (String)

See Also:



51
52
53
 
# File 'acmpca/cfn_certificate_props.rb', line 51

def signing_algorithm
  @signing_algorithm
end

#template_arn ⇒ String, ... (readonly)

Specifies a custom configuration template to use when issuing a certificate.

If this parameter is not provided, AWS Private CA defaults to the EndEntityCertificate/V1 template. For more information about AWS Private CA templates, see Using Templates .

Returns:

See Also:



68
69
70
 
# File 'acmpca/cfn_certificate_props.rb', line 68

def template_arn
  @template_arn
end

#validity ⇒ AWSCDK::IResolvable, AWSCDK::ACMPCA::CfnCertificate::ValidityProperty (readonly)

The period of time during which the certificate will be valid.

Returns:

See Also:



56
57
58
 
# File 'acmpca/cfn_certificate_props.rb', line 56

def validity
  @validity
end

#validity_not_before ⇒ AWSCDK::IResolvable, ... (readonly)

Information describing the start of the validity period of the certificate.

This parameter sets the “Not Before" date for the certificate.

By default, when issuing a certificate, AWS Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.

Unlike the Validity parameter, the ValidityNotBefore parameter is optional.

The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE .

Returns:

See Also:



81
82
83
 
# File 'acmpca/cfn_certificate_props.rb', line 81

def validity_not_before
  @validity_not_before
end

Class Method Details

.jsii_properties ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
 
# File 'acmpca/cfn_certificate_props.rb', line 83

def self.jsii_properties
  {
    :certificate_authority_arn => "certificateAuthorityArn",
    :certificate_signing_request => "certificateSigningRequest",
    :signing_algorithm => "signingAlgorithm",
    :validity => "validity",
    :api_passthrough => "apiPassthrough",
    :template_arn => "templateArn",
    :validity_not_before => "validityNotBefore",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'acmpca/cfn_certificate_props.rb', line 95

def to_jsii
  result = {}
  result.merge!({
    "certificateAuthorityArn" => @certificate_authority_arn,
    "certificateSigningRequest" => @certificate_signing_request,
    "signingAlgorithm" => @signing_algorithm,
    "validity" => @validity,
    "apiPassthrough" => @api_passthrough,
    "templateArn" => @template_arn,
    "validityNotBefore" => @validity_not_before,
  })
  result.compact
end