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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::UpdateCACertificateRequest

Includes:

Structure

Defined in:

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
  registration_config: {
    template_body: "TemplateBody",
    role_arn: "RoleArn",
  },
  remove_auto_registration: false,
}

The input to the UpdateCACertificate operation.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #certificate_id ⇒ String

  The CA certificate identifier.

• #new_auto_registration_status ⇒ String

  The new value for the auto registration status.

• #new_status ⇒ String

  The updated status of the CA certificate.

• #registration_config ⇒ Types::RegistrationConfig

  Information about the registration configuration.

• #remove_auto_registration ⇒ Boolean

  If true, removes auto registration.

Instance Attribute Details

#certificate_id ⇒ String

The CA certificate identifier.

Returns:

• (String)

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

class UpdateCACertificateRequest < Struct.new(
  :certificate_id,
  :new_status,
  :new_auto_registration_status,
  :registration_config,
  :remove_auto_registration)
  SENSITIVE = []
  include Aws::Structure
end

#new_auto_registration_status ⇒ String

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

Returns:

• (String)

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

class UpdateCACertificateRequest < Struct.new(
  :certificate_id,
  :new_status,
  :new_auto_registration_status,
  :registration_config,
  :remove_auto_registration)
  SENSITIVE = []
  include Aws::Structure
end

#new_status ⇒ String

The updated status of the CA certificate.

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

Returns:

• (String)

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

class UpdateCACertificateRequest < Struct.new(
  :certificate_id,
  :new_status,
  :new_auto_registration_status,
  :registration_config,
  :remove_auto_registration)
  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 19018

class UpdateCACertificateRequest < Struct.new(
  :certificate_id,
  :new_status,
  :new_auto_registration_status,
  :registration_config,
  :remove_auto_registration)
  SENSITIVE = []
  include Aws::Structure
end

#remove_auto_registration ⇒ Boolean

If true, removes auto registration.

Returns:

• (Boolean)

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

class UpdateCACertificateRequest < Struct.new(
  :certificate_id,
  :new_status,
  :new_auto_registration_status,
  :registration_config,
  :remove_auto_registration)
  SENSITIVE = []
  include Aws::Structure
end