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

Class: Aws::IoT::Types::UpdateCACertificateRequest

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 UpdateCACertificateRequest data as a hash:

{
  certificate_id: "CertificateId", # required
  new_status: "ACTIVE", # accepts ACTIVE, INACTIVE
  new_auto_registration_status: "ENABLE", # accepts ENABLE, DISABLE
}

The input to the UpdateCACertificate operation.

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_idString

The CA certificate identifier.

Returns:

  • (String)


3452
3453
3454
3455
3456
3457
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3452

class UpdateCACertificateRequest < Struct.new(
  :certificate_id,
  :new_status,
  :new_auto_registration_status)
  include Aws::Structure
end

#new_auto_registration_statusString

The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".

Returns:

  • (String)


3452
3453
3454
3455
3456
3457
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3452

class UpdateCACertificateRequest < Struct.new(
  :certificate_id,
  :new_status,
  :new_auto_registration_status)
  include Aws::Structure
end

#new_statusString

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

Returns:

  • (String)


3452
3453
3454
3455
3456
3457
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3452

class UpdateCACertificateRequest < Struct.new(
  :certificate_id,
  :new_status,
  :new_auto_registration_status)
  include Aws::Structure
end