Class: Aws::ACMPCA::Types::KeyUsage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb

Overview

Note:

When making an API call, you may pass KeyUsage data as a hash:

{
  digital_signature: false,
  non_repudiation: false,
  key_encipherment: false,
  data_encipherment: false,
  key_agreement: false,
  key_cert_sign: false,
  crl_sign: false,
  encipher_only: false,
  decipher_only: false,
}

Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#crl_signBoolean

Key can be used to sign CRLs.

Returns:

  • (Boolean)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 2314

class KeyUsage < Struct.new(
  :digital_signature,
  :non_repudiation,
  :key_encipherment,
  :data_encipherment,
  :key_agreement,
  :key_cert_sign,
  :crl_sign,
  :encipher_only,
  :decipher_only)
  SENSITIVE = []
  include Aws::Structure
end

#data_enciphermentBoolean

Key can be used to decipher data.

Returns:

  • (Boolean)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 2314

class KeyUsage < Struct.new(
  :digital_signature,
  :non_repudiation,
  :key_encipherment,
  :data_encipherment,
  :key_agreement,
  :key_cert_sign,
  :crl_sign,
  :encipher_only,
  :decipher_only)
  SENSITIVE = []
  include Aws::Structure
end

#decipher_onlyBoolean

Key can be used only to decipher data.

Returns:

  • (Boolean)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 2314

class KeyUsage < Struct.new(
  :digital_signature,
  :non_repudiation,
  :key_encipherment,
  :data_encipherment,
  :key_agreement,
  :key_cert_sign,
  :crl_sign,
  :encipher_only,
  :decipher_only)
  SENSITIVE = []
  include Aws::Structure
end

#digital_signatureBoolean

Key can be used for digital signing.

Returns:

  • (Boolean)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 2314

class KeyUsage < Struct.new(
  :digital_signature,
  :non_repudiation,
  :key_encipherment,
  :data_encipherment,
  :key_agreement,
  :key_cert_sign,
  :crl_sign,
  :encipher_only,
  :decipher_only)
  SENSITIVE = []
  include Aws::Structure
end

#encipher_onlyBoolean

Key can be used only to encipher data.

Returns:

  • (Boolean)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 2314

class KeyUsage < Struct.new(
  :digital_signature,
  :non_repudiation,
  :key_encipherment,
  :data_encipherment,
  :key_agreement,
  :key_cert_sign,
  :crl_sign,
  :encipher_only,
  :decipher_only)
  SENSITIVE = []
  include Aws::Structure
end

#key_agreementBoolean

Key can be used in a key-agreement protocol.

Returns:

  • (Boolean)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 2314

class KeyUsage < Struct.new(
  :digital_signature,
  :non_repudiation,
  :key_encipherment,
  :data_encipherment,
  :key_agreement,
  :key_cert_sign,
  :crl_sign,
  :encipher_only,
  :decipher_only)
  SENSITIVE = []
  include Aws::Structure
end

#key_cert_signBoolean

Key can be used to sign certificates.

Returns:

  • (Boolean)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 2314

class KeyUsage < Struct.new(
  :digital_signature,
  :non_repudiation,
  :key_encipherment,
  :data_encipherment,
  :key_agreement,
  :key_cert_sign,
  :crl_sign,
  :encipher_only,
  :decipher_only)
  SENSITIVE = []
  include Aws::Structure
end

#key_enciphermentBoolean

Key can be used to encipher data.

Returns:

  • (Boolean)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 2314

class KeyUsage < Struct.new(
  :digital_signature,
  :non_repudiation,
  :key_encipherment,
  :data_encipherment,
  :key_agreement,
  :key_cert_sign,
  :crl_sign,
  :encipher_only,
  :decipher_only)
  SENSITIVE = []
  include Aws::Structure
end

#non_repudiationBoolean

Key can be used for non-repudiation.

Returns:

  • (Boolean)


2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 2314

class KeyUsage < Struct.new(
  :digital_signature,
  :non_repudiation,
  :key_encipherment,
  :data_encipherment,
  :key_agreement,
  :key_cert_sign,
  :crl_sign,
  :encipher_only,
  :decipher_only)
  SENSITIVE = []
  include Aws::Structure
end