Class: Aws::IoT::Types::CACertificateDescription

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iot/types.rb

Overview

Describes a CA certificate.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_registration_statusString

Whether the CA certificate configured for auto registration of device certificates. Valid values are “ENABLE” and “DISABLE”

Returns:

  • (String)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_arnString

The CA certificate ARN.

Returns:

  • (String)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_idString

The CA certificate ID.

Returns:

  • (String)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_modeString

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see [certificate mode].

[1]: docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode

Returns:

  • (String)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_pemString

The CA certificate data, in PEM format.

Returns:

  • (String)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateTime

The date the CA certificate was created.

Returns:

  • (Time)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#customer_versionInteger

The customer version of the CA certificate.

Returns:

  • (Integer)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#generation_idString

The generation ID of the CA certificate.

Returns:

  • (String)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_dateTime

The date the CA certificate was last modified.

Returns:

  • (Time)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#owned_byString

The owner of the CA certificate.

Returns:

  • (String)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of a CA certificate.

Returns:

  • (String)


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end

#validityTypes::CertificateValidity

When the CA certificate is valid.



2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
# File 'lib/aws-sdk-iot/types.rb', line 2112

class CACertificateDescription < Struct.new(
  :certificate_arn,
  :certificate_id,
  :status,
  :certificate_pem,
  :owned_by,
  :creation_date,
  :auto_registration_status,
  :last_modified_date,
  :customer_version,
  :generation_id,
  :validity,
  :certificate_mode)
  SENSITIVE = []
  include Aws::Structure
end