Class: AWSCDK::PCAConnectorAD::CfnTemplate::PrivateKeyAttributesV3Property

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pca_connector_ad/cfn_template.rb

Overview

Defines the attributes of the private key.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(algorithm:, key_spec:, key_usage_property:, minimal_key_length:, crypto_providers: nil) ⇒ PrivateKeyAttributesV3Property

Returns a new instance of PrivateKeyAttributesV3Property.

Parameters:

  • algorithm (String) —

    Defines the algorithm used to generate the private key.

  • key_spec (String) —

    Defines the purpose of the private key.

  • key_usage_property (AWSCDK::IResolvable, AWSCDK::PCAConnectorAD::CfnTemplate::KeyUsagePropertyProperty) —

    The key usage property defines the purpose of the private key contained in the certificate.

  • minimal_key_length (Numeric) —

    Set the minimum key length of the private key.

  • crypto_providers (Array<String>, nil) (defaults to: nil) —

    Defines the cryptographic providers used to generate the private key.



1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
 
# File 'pca_connector_ad/cfn_template.rb', line 1470

def initialize(algorithm:, key_spec:, key_usage_property:, minimal_key_length:, crypto_providers: nil)
  @algorithm = algorithm
  Jsii::Type.check_type(@algorithm, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "algorithm")
  @key_spec = key_spec
  Jsii::Type.check_type(@key_spec, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keySpec")
  @key_usage_property = key_usage_property.is_a?(Hash) ? ::AWSCDK::PCAConnectorAD::CfnTemplate::KeyUsagePropertyProperty.new(**key_usage_property.transform_keys(&:to_sym)) : key_usage_property
  Jsii::Type.check_type(@key_usage_property, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19wY2Fjb25uZWN0b3JhZC5DZm5UZW1wbGF0ZS5LZXlVc2FnZVByb3BlcnR5UHJvcGVydHkifV19fQ==")), "keyUsageProperty")
  @minimal_key_length = minimal_key_length
  Jsii::Type.check_type(@minimal_key_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minimalKeyLength")
  @crypto_providers = crypto_providers
  Jsii::Type.check_type(@crypto_providers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "cryptoProviders") unless @crypto_providers.nil?
end

Instance Attribute Details

#algorithm ⇒ String (readonly)

Defines the algorithm used to generate the private key.

Returns:

  • (String)

See Also:



1487
1488
1489
 
# File 'pca_connector_ad/cfn_template.rb', line 1487

def algorithm
  @algorithm
end

#crypto_providers ⇒ Array<String>? (readonly)

Defines the cryptographic providers used to generate the private key.

Returns:

  • (Array<String>, nil)

See Also:



1511
1512
1513
 
# File 'pca_connector_ad/cfn_template.rb', line 1511

def crypto_providers
  @crypto_providers
end

#key_spec ⇒ String (readonly)

Defines the purpose of the private key.

Set it to "KEY_EXCHANGE" or "SIGNATURE" value.

Returns:

  • (String)

See Also:



1494
1495
1496
 
# File 'pca_connector_ad/cfn_template.rb', line 1494

def key_spec
  @key_spec
end

#key_usage_property ⇒ AWSCDK::IResolvable, AWSCDK::PCAConnectorAD::CfnTemplate::KeyUsagePropertyProperty (readonly)

The key usage property defines the purpose of the private key contained in the certificate.

You can specify specific purposes using property flags or all by using property type ALL.

Returns:

See Also:



1501
1502
1503
 
# File 'pca_connector_ad/cfn_template.rb', line 1501

def key_usage_property
  @key_usage_property
end

#minimal_key_length ⇒ Numeric (readonly)

Set the minimum key length of the private key.

Returns:

  • (Numeric)

See Also:



1506
1507
1508
 
# File 'pca_connector_ad/cfn_template.rb', line 1506

def minimal_key_length
  @minimal_key_length
end

Class Method Details

.jsii_properties ⇒ Object 



1513
1514
1515
1516
1517
1518
1519
1520
1521
 
# File 'pca_connector_ad/cfn_template.rb', line 1513

def self.jsii_properties
  {
    :algorithm => "algorithm",
    :key_spec => "keySpec",
    :key_usage_property => "keyUsageProperty",
    :minimal_key_length => "minimalKeyLength",
    :crypto_providers => "cryptoProviders",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
 
# File 'pca_connector_ad/cfn_template.rb', line 1523

def to_jsii
  result = {}
  result.merge!({
    "algorithm" => @algorithm,
    "keySpec" => @key_spec,
    "keyUsageProperty" => @key_usage_property,
    "minimalKeyLength" => @minimal_key_length,
    "cryptoProviders" => @crypto_providers,
  })
  result.compact
end