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",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

The input to the RegisterCACertificate operation.

Constant Summary collapse

SENSITIVE =
[]

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)


14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 14692

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

#ca_certificateString

The CA certificate.

Returns:

  • (String)


14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 14692

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

#registration_configTypes::RegistrationConfig

Information about the registration configuration.



14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 14692

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

#set_as_activeBoolean

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

Returns:

  • (Boolean)


14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 14692

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

#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:



14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 14692

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

#verification_certificateString

The private key verification certificate.

Returns:

  • (String)


14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 14692

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