Class: AWSCDK::Personalize::CfnDatasetGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
personalize/cfn_dataset_group_props.rb

Overview

Properties for defining a CfnDatasetGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, domain: nil, kms_key_arn: nil, role_arn: nil) ⇒ CfnDatasetGroupProps

Returns a new instance of CfnDatasetGroupProps.

Parameters:

  • name (String) —

    The name of the dataset group.

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

    The domain of a Domain dataset group.

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

    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.

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

    The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key.



13
14
15
16
17
18
19
20
21
22
 
# File 'personalize/cfn_dataset_group_props.rb', line 13

def initialize(name:, domain: nil, kms_key_arn: nil, role_arn: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @domain = domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain") unless @domain.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?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
end

Instance Attribute Details

#domain ⇒ String? (readonly)

The domain of a Domain dataset group.

Returns:

  • (String, nil)

See Also:



33
34
35
 
# File 'personalize/cfn_dataset_group_props.rb', line 33

def domain
  @domain
end

#kms_key_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.

Returns:

  • (String, nil)

See Also:



38
39
40
 
# File 'personalize/cfn_dataset_group_props.rb', line 38

def kms_key_arn
  @kms_key_arn
end

#name ⇒ String (readonly)

The name of the dataset group.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'personalize/cfn_dataset_group_props.rb', line 28

def name
  @name
end

#role_arn ⇒ String? (readonly)

The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key.

Supplying an IAM role is only valid when also specifying a KMS key.

Returns:

  • (String, nil)

See Also:



45
46
47
 
# File 'personalize/cfn_dataset_group_props.rb', line 45

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'personalize/cfn_dataset_group_props.rb', line 47

def self.jsii_properties
  {
    :name => "name",
    :domain => "domain",
    :kms_key_arn => "kmsKeyArn",
    :role_arn => "roleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'personalize/cfn_dataset_group_props.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "domain" => @domain,
    "kmsKeyArn" => @kms_key_arn,
    "roleArn" => @role_arn,
  })
  result.compact
end