You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass RegisterCACertificateRequest data as a hash:

{
  ca_certificate: "CertificatePem", # required
  verification_certificate: "CertificatePem", # required
  set_as_active: false,
  allow_auto_registration: false,
  registration_config: {
    template_body: "TemplateBody",
    role_arn: "RoleArn",
  },
}

The input to the RegisterCACertificate operation.

Instance Attribute Summary collapse

Instance Attribute Details

#allow_auto_registrationBoolean

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

Returns:

  • (Boolean)


5026
5027
5028
5029
5030
5031
5032
5033
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5026

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config)
  include Aws::Structure
end

#ca_certificateString

The CA certificate.

Returns:

  • (String)


5026
5027
5028
5029
5030
5031
5032
5033
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5026

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config)
  include Aws::Structure
end

#registration_configTypes::RegistrationConfig

Information about the registration configuration.



5026
5027
5028
5029
5030
5031
5032
5033
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5026

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config)
  include Aws::Structure
end

#set_as_activeBoolean

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

Returns:

  • (Boolean)


5026
5027
5028
5029
5030
5031
5032
5033
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5026

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config)
  include Aws::Structure
end

#verification_certificateString

The private key verification certificate.

Returns:

  • (String)


5026
5027
5028
5029
5030
5031
5032
5033
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5026

class RegisterCACertificateRequest < Struct.new(
  :ca_certificate,
  :verification_certificate,
  :set_as_active,
  :allow_auto_registration,
  :registration_config)
  include Aws::Structure
end