Amazonka.IoT.RegisterCACertificate

Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.

Requires permission to access the RegisterCACertificate action.

Creating a Request

data RegisterCACertificate

The input to the RegisterCACertificate operation.

See: newRegisterCACertificate smart constructor.

Constructors

RegisterCACertificate'

Fields

• allowAutoRegistration :: Maybe Bool

  Allows this CA certificate to be used for auto registration of device certificates.

• certificateMode :: Maybe CertificateMode

  Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

• registrationConfig :: Maybe RegistrationConfig

  Information about the registration configuration.

• setAsActive :: Maybe Bool

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

  Valid values: ACTIVE | INACTIVE

• tags :: Maybe [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..."

• verificationCertificate :: Maybe Text

  The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

• caCertificate :: Text

  The CA certificate.

Instances

ToJSON RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Methods

toJSON :: RegisterCACertificate -> Value

toEncoding :: RegisterCACertificate -> Encoding

toJSONList :: [RegisterCACertificate] -> Value

toEncodingList :: [RegisterCACertificate] -> Encoding

ToHeaders RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Methods

toHeaders :: RegisterCACertificate -> [Header]

ToPath RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Methods

toPath :: RegisterCACertificate -> ByteString

ToQuery RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Methods

toQuery :: RegisterCACertificate -> QueryString

AWSRequest RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Associated Types

type AWSResponse RegisterCACertificate

Methods

request :: (Service -> Service) -> RegisterCACertificate -> Request RegisterCACertificate

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterCACertificate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterCACertificate)))

Generic RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Associated Types

type Rep RegisterCACertificate :: Type -> Type

Methods

from :: RegisterCACertificate -> Rep RegisterCACertificate x

to :: Rep RegisterCACertificate x -> RegisterCACertificate

Read RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Methods

readsPrec :: Int -> ReadS RegisterCACertificate

readList :: ReadS [RegisterCACertificate]

readPrec :: ReadPrec RegisterCACertificate

readListPrec :: ReadPrec [RegisterCACertificate]

Show RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Methods

showsPrec :: Int -> RegisterCACertificate -> ShowS

show :: RegisterCACertificate -> String

showList :: [RegisterCACertificate] -> ShowS

NFData RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Methods

rnf :: RegisterCACertificate -> ()

Eq RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Methods

(==) :: RegisterCACertificate -> RegisterCACertificate -> Bool

(/=) :: RegisterCACertificate -> RegisterCACertificate -> Bool

Hashable RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

Methods

hashWithSalt :: Int -> RegisterCACertificate -> Int

hash :: RegisterCACertificate -> Int

type AWSResponse RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

type AWSResponse RegisterCACertificate = RegisterCACertificateResponse

type Rep RegisterCACertificate

Defined in Amazonka.IoT.RegisterCACertificate

type Rep RegisterCACertificate = D1 ('MetaData "RegisterCACertificate" "Amazonka.IoT.RegisterCACertificate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "RegisterCACertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowAutoRegistration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "certificateMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateMode)) :*: S1 ('MetaSel ('Just "registrationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistrationConfig)))) :*: ((S1 ('MetaSel ('Just "setAsActive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "verificationCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "caCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newRegisterCACertificate

Arguments

:: Text

$sel:caCertificate:RegisterCACertificate'

-> RegisterCACertificate

Create a value of RegisterCACertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allowAutoRegistration:RegisterCACertificate', registerCACertificate_allowAutoRegistration - Allows this CA certificate to be used for auto registration of device certificates.

RegisterCACertificate, registerCACertificate_certificateMode - Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

$sel:registrationConfig:RegisterCACertificate', registerCACertificate_registrationConfig - Information about the registration configuration.

$sel:setAsActive:RegisterCACertificate', registerCACertificate_setAsActive - A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

$sel:tags:RegisterCACertificate', registerCACertificate_tags - 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..."

$sel:verificationCertificate:RegisterCACertificate', registerCACertificate_verificationCertificate - The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

$sel:caCertificate:RegisterCACertificate', registerCACertificate_caCertificate - The CA certificate.

Request Lenses

registerCACertificate_allowAutoRegistration :: Lens' RegisterCACertificate (Maybe Bool)

Allows this CA certificate to be used for auto registration of device certificates.

registerCACertificate_certificateMode :: Lens' RegisterCACertificate (Maybe CertificateMode)

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

registerCACertificate_registrationConfig :: Lens' RegisterCACertificate (Maybe RegistrationConfig)

Information about the registration configuration.

registerCACertificate_setAsActive :: Lens' RegisterCACertificate (Maybe Bool)

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

Valid values: ACTIVE | INACTIVE

registerCACertificate_tags :: Lens' RegisterCACertificate (Maybe [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..."

registerCACertificate_verificationCertificate :: Lens' RegisterCACertificate (Maybe Text)

The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

registerCACertificate_caCertificate :: Lens' RegisterCACertificate Text

The CA certificate.

Destructuring the Response

data RegisterCACertificateResponse

The output from the RegisterCACertificateResponse operation.

See: newRegisterCACertificateResponse smart constructor.

Constructors

RegisterCACertificateResponse'

Fields

• certificateArn :: Maybe Text

  The CA certificate ARN.

• certificateId :: Maybe Text

  The CA certificate identifier.

• httpStatus :: Int

  The response's http status code.

Instances

Generic RegisterCACertificateResponse

Defined in Amazonka.IoT.RegisterCACertificate

Associated Types

type Rep RegisterCACertificateResponse :: Type -> Type

Methods

from :: RegisterCACertificateResponse -> Rep RegisterCACertificateResponse x

to :: Rep RegisterCACertificateResponse x -> RegisterCACertificateResponse

Read RegisterCACertificateResponse

Defined in Amazonka.IoT.RegisterCACertificate

Methods

readsPrec :: Int -> ReadS RegisterCACertificateResponse

readList :: ReadS [RegisterCACertificateResponse]

readPrec :: ReadPrec RegisterCACertificateResponse

readListPrec :: ReadPrec [RegisterCACertificateResponse]

Show RegisterCACertificateResponse

Defined in Amazonka.IoT.RegisterCACertificate

Methods

showsPrec :: Int -> RegisterCACertificateResponse -> ShowS

show :: RegisterCACertificateResponse -> String

showList :: [RegisterCACertificateResponse] -> ShowS

NFData RegisterCACertificateResponse

Defined in Amazonka.IoT.RegisterCACertificate

Methods

rnf :: RegisterCACertificateResponse -> ()

Eq RegisterCACertificateResponse

Defined in Amazonka.IoT.RegisterCACertificate

Methods

(==) :: RegisterCACertificateResponse -> RegisterCACertificateResponse -> Bool

(/=) :: RegisterCACertificateResponse -> RegisterCACertificateResponse -> Bool

type Rep RegisterCACertificateResponse

Defined in Amazonka.IoT.RegisterCACertificate

type Rep RegisterCACertificateResponse = D1 ('MetaData "RegisterCACertificateResponse" "Amazonka.IoT.RegisterCACertificate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "RegisterCACertificateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "certificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRegisterCACertificateResponse

Arguments

:: Int

$sel:httpStatus:RegisterCACertificateResponse'

-> RegisterCACertificateResponse

Create a value of RegisterCACertificateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RegisterCACertificateResponse, registerCACertificateResponse_certificateArn - The CA certificate ARN.

RegisterCACertificateResponse, registerCACertificateResponse_certificateId - The CA certificate identifier.

$sel:httpStatus:RegisterCACertificateResponse', registerCACertificateResponse_httpStatus - The response's http status code.

Response Lenses

registerCACertificateResponse_certificateArn :: Lens' RegisterCACertificateResponse (Maybe Text)

The CA certificate ARN.

registerCACertificateResponse_certificateId :: Lens' RegisterCACertificateResponse (Maybe Text)

The CA certificate identifier.

registerCACertificateResponse_httpStatus :: Lens' RegisterCACertificateResponse Int

The response's http status code.