Class: AWSCDK::Transfer::CfnCertificateProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
transfer/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:, usage:, active_date: nil, certificate_chain: nil, description: nil, inactive_date: nil, private_key: nil, tags: nil) ⇒ CfnCertificateProps

Returns a new instance of CfnCertificateProps.

Parameters:

  • certificate (String) —

    The file name for the certificate.

  • usage (String) —

    Specifies how this certificate is used. It can be used in the following ways:.

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

    An optional date that specifies when the certificate becomes active.

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

    The list of certificates that make up the chain for the certificate.

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

    The name or description that's used to identity the certificate.

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

    An optional date that specifies when the certificate becomes inactive.

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

    The file that contains the private key for the certificate that's being imported.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Key-value pairs that can be used to group and search for certificates.



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

def initialize(certificate:, usage:, active_date: nil, certificate_chain: nil, description: nil, inactive_date: nil, private_key: nil, tags: nil)
  @certificate = certificate
  Jsii::Type.check_type(@certificate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificate")
  @usage = usage
  Jsii::Type.check_type(@usage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "usage")
  @active_date = active_date
  Jsii::Type.check_type(@active_date, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "activeDate") unless @active_date.nil?
  @certificate_chain = certificate_chain
  Jsii::Type.check_type(@certificate_chain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateChain") unless @certificate_chain.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @inactive_date = inactive_date
  Jsii::Type.check_type(@inactive_date, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inactiveDate") unless @inactive_date.nil?
  @private_key = private_key
  Jsii::Type.check_type(@private_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateKey") unless @private_key.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#active_date ⇒ String? (readonly)

An optional date that specifies when the certificate becomes active.

If you do not specify a value, ActiveDate takes the same value as NotBeforeDate , which is specified by the CA.

Returns:

  • (String, nil)

See Also:



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

def active_date
  @active_date
end

#certificate ⇒ String (readonly)

The file name for the certificate.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'transfer/cfn_certificate_props.rb', line 40

def certificate
  @certificate
end

#certificate_chain ⇒ String? (readonly)

The list of certificates that make up the chain for the certificate.

Returns:

  • (String, nil)

See Also:



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

def certificate_chain
  @certificate_chain
end

#description ⇒ String? (readonly)

The name or description that's used to identity the certificate.

Returns:

  • (String, nil)

See Also:



66
67
68
 
# File 'transfer/cfn_certificate_props.rb', line 66

def description
  @description
end

#inactive_date ⇒ String? (readonly)

An optional date that specifies when the certificate becomes inactive.

If you do not specify a value, InactiveDate takes the same value as NotAfterDate , which is specified by the CA.

Returns:

  • (String, nil)

See Also:



73
74
75
 
# File 'transfer/cfn_certificate_props.rb', line 73

def inactive_date
  @inactive_date
end

#private_key ⇒ String? (readonly)

The file that contains the private key for the certificate that's being imported.

Returns:

  • (String, nil)

See Also:



78
79
80
 
# File 'transfer/cfn_certificate_props.rb', line 78

def private_key
  @private_key
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Key-value pairs that can be used to group and search for certificates.

Returns:

See Also:



83
84
85
 
# File 'transfer/cfn_certificate_props.rb', line 83

def tags
  @tags
end

#usage ⇒ String (readonly)

Specifies how this certificate is used. It can be used in the following ways:.

  • SIGNING : For signing AS2 messages
  • ENCRYPTION : For encrypting AS2 messages
  • TLS : For securing AS2 communications sent over HTTPS

Returns:

  • (String)

See Also:



49
50
51
 
# File 'transfer/cfn_certificate_props.rb', line 49

def usage
  @usage
end

Class Method Details

.jsii_properties ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'transfer/cfn_certificate_props.rb', line 85

def self.jsii_properties
  {
    :certificate => "certificate",
    :usage => "usage",
    :active_date => "activeDate",
    :certificate_chain => "certificateChain",
    :description => "description",
    :inactive_date => "inactiveDate",
    :private_key => "privateKey",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'transfer/cfn_certificate_props.rb', line 98

def to_jsii
  result = {}
  result.merge!({
    "certificate" => @certificate,
    "usage" => @usage,
    "activeDate" => @active_date,
    "certificateChain" => @certificate_chain,
    "description" => @description,
    "inactiveDate" => @inactive_date,
    "privateKey" => @private_key,
    "tags" => @tags,
  })
  result.compact
end