AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RegisterCACertificateRequest as input to an Aws::Client method, you can use a vanilla 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",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

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)

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

#ca_certificateString

The CA certificate.

Returns:

  • (String)

    The CA certificate.

#registration_configTypes::RegistrationConfig

Information about the registration configuration.

Returns:

#set_as_activeBoolean

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

Returns:

  • (Boolean)

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

#tagsArray<Types::Tag>

Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags \"key1=value1&key2=value2...\"

For the cli-input-json file use format: \"tags\": \"key1=value1&key2=value2...\"

Returns:

  • (Array<Types::Tag>)

    Metadata which can be used to manage the CA certificate.

#verification_certificateString

The private key verification certificate.

Returns:

  • (String)

    The private key verification certificate.