Class: AWSCDK::IoT::CfnCACertificateProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t/cfn_ca_certificate_props.rb

Overview

Properties for defining a CfnCACertificate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ca_certificate_pem:, status:, auto_registration_status: nil, certificate_mode: nil, registration_config: nil, remove_auto_registration: nil, tags: nil, verification_certificate_pem: nil) ⇒ CfnCACertificateProps

Returns a new instance of CfnCACertificateProps.

Parameters:

  • ca_certificate_pem (String) —

    The certificate data in PEM format.

  • status (String) —

    The status of the CA certificate.

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

    Whether the CA certificate is configured for auto registration of device certificates.

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

    The mode of the CA.

  • registration_config (AWSCDK::IResolvable, AWSCDK::IoT::CfnCACertificate::RegistrationConfigProperty, nil) (defaults to: nil) —

    Information about the registration configuration.

  • remove_auto_registration (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    If true, removes auto registration.

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

    An array of key-value pairs to apply to this resource.

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

    The private key verification certificate.



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

def initialize(ca_certificate_pem:, status:, auto_registration_status: nil, certificate_mode: nil, registration_config: nil, remove_auto_registration: nil, tags: nil, verification_certificate_pem: nil)
  @ca_certificate_pem = ca_certificate_pem
  Jsii::Type.check_type(@ca_certificate_pem, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "caCertificatePem")
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status")
  @auto_registration_status = auto_registration_status
  Jsii::Type.check_type(@auto_registration_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "autoRegistrationStatus") unless @auto_registration_status.nil?
  @certificate_mode = certificate_mode
  Jsii::Type.check_type(@certificate_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateMode") unless @certificate_mode.nil?
  @registration_config = registration_config.is_a?(Hash) ? ::AWSCDK::IoT::CfnCACertificate::RegistrationConfigProperty.new(**registration_config.transform_keys(&:to_sym)) : registration_config
  Jsii::Type.check_type(@registration_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuQ0FDZXJ0aWZpY2F0ZS5SZWdpc3RyYXRpb25Db25maWdQcm9wZXJ0eSJ9XX19")), "registrationConfig") unless @registration_config.nil?
  @remove_auto_registration = remove_auto_registration
  Jsii::Type.check_type(@remove_auto_registration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "removeAutoRegistration") unless @remove_auto_registration.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?
  @verification_certificate_pem = verification_certificate_pem
  Jsii::Type.check_type(@verification_certificate_pem, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "verificationCertificatePem") unless @verification_certificate_pem.nil?
end

Instance Attribute Details

#auto_registration_status ⇒ String? (readonly)

Whether the CA certificate is configured for auto registration of device certificates.

Valid values are "ENABLE" and "DISABLE".

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'io_t/cfn_ca_certificate_props.rb', line 54

def auto_registration_status
  @auto_registration_status
end

#ca_certificate_pem ⇒ String (readonly)

The certificate data in PEM format.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'io_t/cfn_ca_certificate_props.rb', line 40

def ca_certificate_pem
  @ca_certificate_pem
end

#certificate_mode ⇒ String? (readonly)

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .

Valid values are "DEFAULT" and "SNI_ONLY".

Returns:

  • (String, nil)

See Also:



63
64
65
 
# File 'io_t/cfn_ca_certificate_props.rb', line 63

def certificate_mode
  @certificate_mode
end

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

Information about the registration configuration.

Returns:

See Also:



68
69
70
 
# File 'io_t/cfn_ca_certificate_props.rb', line 68

def registration_config
  @registration_config
end

#remove_auto_registration ⇒ Boolean, ... (readonly)

If true, removes auto registration.

Returns:

See Also:



73
74
75
 
# File 'io_t/cfn_ca_certificate_props.rb', line 73

def remove_auto_registration
  @remove_auto_registration
end

#status ⇒ String (readonly)

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".

Returns:

  • (String)

See Also:



47
48
49
 
# File 'io_t/cfn_ca_certificate_props.rb', line 47

def status
  @status
end

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

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Returns:

See Also:



80
81
82
 
# File 'io_t/cfn_ca_certificate_props.rb', line 80

def tags
  @tags
end

#verification_certificate_pem ⇒ String? (readonly)

The private key verification certificate.

Returns:

  • (String, nil)

See Also:



85
86
87
 
# File 'io_t/cfn_ca_certificate_props.rb', line 85

def verification_certificate_pem
  @verification_certificate_pem
end

Class Method Details

.jsii_properties ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'io_t/cfn_ca_certificate_props.rb', line 87

def self.jsii_properties
  {
    :ca_certificate_pem => "caCertificatePem",
    :status => "status",
    :auto_registration_status => "autoRegistrationStatus",
    :certificate_mode => "certificateMode",
    :registration_config => "registrationConfig",
    :remove_auto_registration => "removeAutoRegistration",
    :tags => "tags",
    :verification_certificate_pem => "verificationCertificatePem",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'io_t/cfn_ca_certificate_props.rb', line 100

def to_jsii
  result = {}
  result.merge!({
    "caCertificatePem" => @ca_certificate_pem,
    "status" => @status,
    "autoRegistrationStatus" => @auto_registration_status,
    "certificateMode" => @certificate_mode,
    "registrationConfig" => @registration_config,
    "removeAutoRegistration" => @remove_auto_registration,
    "tags" => @tags,
    "verificationCertificatePem" => @verification_certificate_pem,
  })
  result.compact
end