Class: Aws::IoT::Types::RegisterCACertificateRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::RegisterCACertificateRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

The input to the RegisterCACertificate operation.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allow_auto_registration ⇒ Boolean

  Allows this CA certificate to be used for auto registration of device certificates.

• #ca_certificate ⇒ String

  The CA certificate.

• #certificate_mode ⇒ String

  Describes the certificate mode in which the Certificate Authority (CA) will be registered.

• #registration_config ⇒ Types::RegistrationConfig

  Information about the registration configuration.

• #set_as_active ⇒ Boolean

  A boolean value that specifies if the CA certificate is set to active.

• #tags ⇒ Array<Types::Tag>

  Metadata which can be used to manage the CA certificate.

• #verification_certificate ⇒ String

  The private key verification certificate.

Instance Attribute Details

#allow_auto_registration ⇒ Boolean

Allows this CA certificate to be used for auto registration of device certificates.

Returns:

• (Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 13425

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config,
  :tags,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#ca_certificate ⇒ String

The CA certificate.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 13425

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config,
  :tags,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_mode ⇒ String

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the ‘verificationCertificate` field is not provided, set `certificateMode` to be `SNI_ONLY`. If the `verificationCertificate` field is provided, set `certificateMode` to be `DEFAULT`. When `certificateMode` is not provided, it defaults to `DEFAULT`. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see [ certificate mode].

[1]: docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 13425

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config,
  :tags,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#registration_config ⇒ Types::RegistrationConfig

Information about the registration configuration.

Returns:

• (Types::RegistrationConfig)

# File 'lib/aws-sdk-iot/types.rb', line 13425

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config,
  :tags,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#set_as_active ⇒ Boolean

A boolean value that specifies if the CA certificate is set to active.

Valid values: ‘ACTIVE | INACTIVE`

Returns:

• (Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 13425

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config,
  :tags,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Metadata which can be used to manage the CA certificate.

<note markdown=“1”> For URI Request parameters use format: …key1=value1&amp;key2=value2…

For the CLI command-line parameter use format: &&tags

“key1=value1&amp;key2=value2…”

For the cli-input-json file use format: "tags":

“key1=value1&amp;key2=value2…”

</note>

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-iot/types.rb', line 13425

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config,
  :tags,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#verification_certificate ⇒ String

The private key verification certificate. If ‘certificateMode` is `SNI_ONLY`, the `verificationCertificate` field must be empty. If `certificateMode` is `DEFAULT` or not provided, the `verificationCertificate` field must not be empty.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 13425

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config,
  :tags,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end