Class: AWSCDK::HealthLake::CfnFHIRDatastore::KMSEncryptionConfigProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::HealthLake::CfnFHIRDatastore::KMSEncryptionConfigProperty

Defined in:

health_lake/cfn_fhir_datastore.rb

Overview

The customer-managed-key(CMK) used when creating a Data Store.

If a customer owned key is not specified, an Amazon owned key will be used for encryption.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-kmsencryptionconfig.html

Instance Attribute Summary

• #cmk_type ⇒ String readonly

  The type of customer-managed-key(CMK) used for encryption.

• #kms_key_id ⇒ String^? readonly

  The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at rest.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(cmk_type:, kms_key_id: nil) ⇒ KMSEncryptionConfigProperty constructor

  A new instance of KMSEncryptionConfigProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(cmk_type:, kms_key_id: nil) ⇒ KMSEncryptionConfigProperty

Returns a new instance of KMSEncryptionConfigProperty.

Parameters:

• cmk_type (String) —

  The type of customer-managed-key(CMK) used for encryption.

• kms_key_id (String, nil) (defaults to: nil) —

  The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at rest.

# File 'health_lake/cfn_fhir_datastore.rb', line 788

def initialize(cmk_type:, kms_key_id: nil)
  @cmk_type = cmk_type
  Jsii::Type.check_type(@cmk_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cmkType")
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
end

Instance Attribute Details

#cmk_type ⇒ String (readonly)

The type of customer-managed-key(CMK) used for encryption.

The two types of supported CMKs are customer owned CMKs and Amazon owned CMKs. For more information on CMK types, see KmsEncryptionConfig .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-kmsencryptionconfig.html#cfn-healthlake-fhirdatastore-kmsencryptionconfig-cmktype

# File 'health_lake/cfn_fhir_datastore.rb', line 801

def cmk_type
  @cmk_type
end

#kms_key_id ⇒ String^? (readonly)

The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at rest.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-kmsencryptionconfig.html#cfn-healthlake-fhirdatastore-kmsencryptionconfig-kmskeyid

# File 'health_lake/cfn_fhir_datastore.rb', line 806

def kms_key_id
  @kms_key_id
end

Class Method Details

.jsii_properties ⇒ Object

# File 'health_lake/cfn_fhir_datastore.rb', line 808

def self.jsii_properties
  {
    :cmk_type => "cmkType",
    :kms_key_id => "kmsKeyId",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'health_lake/cfn_fhir_datastore.rb', line 815

def to_jsii
  result = {}
  result.merge!({
    "cmkType" => @cmk_type,
    "kmsKeyId" => @kms_key_id,
  })
  result.compact
end