Class: AWSCDK::Datasync::CfnLocationSMB::CmkSecretConfigProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Datasync::CfnLocationSMB::CmkSecretConfigProperty

Defined in:

datasync/cfn_location_smb.rb

Overview

Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-cmksecretconfig.html

Instance Attribute Summary

• #kms_key_arn ⇒ String^? readonly

  Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn .

• #secret_arn ⇒ String^? readonly

  Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(kms_key_arn: nil, secret_arn: nil) ⇒ CmkSecretConfigProperty constructor

  A new instance of CmkSecretConfigProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(kms_key_arn: nil, secret_arn: nil) ⇒ CmkSecretConfigProperty

Returns a new instance of CmkSecretConfigProperty.

Parameters:

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

  Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn .

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

  Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.

# File 'datasync/cfn_location_smb.rb', line 726

def initialize(kms_key_arn: nil, secret_arn: nil)
  @kms_key_arn = kms_key_arn
  Jsii::Type.check_type(@kms_key_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyArn") unless @kms_key_arn.nil?
  @secret_arn = secret_arn
  Jsii::Type.check_type(@secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretArn") unless @secret_arn.nil?
end

Instance Attribute Details

#kms_key_arn ⇒ String^? (readonly)

Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn .

DataSync provides this key to AWS Secrets Manager .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-cmksecretconfig.html#cfn-datasync-locationsmb-cmksecretconfig-kmskeyarn

# File 'datasync/cfn_location_smb.rb', line 739

def kms_key_arn
  @kms_key_arn
end

#secret_arn ⇒ String^? (readonly)

Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.

This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-cmksecretconfig.html#cfn-datasync-locationsmb-cmksecretconfig-secretarn

# File 'datasync/cfn_location_smb.rb', line 746

def secret_arn
  @secret_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'datasync/cfn_location_smb.rb', line 748

def self.jsii_properties
  {
    :kms_key_arn => "kmsKeyArn",
    :secret_arn => "secretArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'datasync/cfn_location_smb.rb', line 755

def to_jsii
  result = {}
  result.merge!({
    "kmsKeyArn" => @kms_key_arn,
    "secretArn" => @secret_arn,
  })
  result.compact
end