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

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

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

Overview

Note:

When passing UpdateCACertificateRequest as input to an Aws::Client method, you can use a vanilla 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.

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_id ⇒ String

The CA certificate identifier.

Returns:

  • (String) —

    The CA certificate identifier.

#new_auto_registration_status ⇒ String

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

Possible values:

  • ENABLE
  • DISABLE

Returns:

  • (String) —

    The new value for the auto registration status.

#new_status ⇒ String

The updated status of the CA certificate.

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

Possible values:

  • ACTIVE
  • INACTIVE

Returns:

  • (String) —

    The updated status of the CA certificate.

#registration_config ⇒ Types::RegistrationConfig

Information about the registration configuration.

Returns:

#remove_auto_registration ⇒ Boolean

If true, removes auto registration.

Returns:

  • (Boolean) —

    If true, removes auto registration.