Class: AWSCDK::Comprehend::CfnFlywheelProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
comprehend/cfn_flywheel_props.rb

Overview

Properties for defining a CfnFlywheel.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_access_role_arn:, data_lake_s3_uri:, flywheel_name:, active_model_arn: nil, data_security_config: nil, model_type: nil, tags: nil, task_config: nil) ⇒ CfnFlywheelProps

Returns a new instance of CfnFlywheelProps.

Parameters:

  • data_access_role_arn (String) —

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

  • data_lake_s3_uri (String) —

    Amazon S3 URI of the data lake location.

  • flywheel_name (String) —

    Name for the flywheel.

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

    The Amazon Resource Number (ARN) of the active model version.

  • data_security_config (AWSCDK::IResolvable, AWSCDK::Comprehend::CfnFlywheel::DataSecurityConfigProperty, nil) (defaults to: nil) —

    Data security configuration.

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

    Model type of the flywheel's model.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Tags associated with the endpoint being created.

  • task_config (AWSCDK::IResolvable, AWSCDK::Comprehend::CfnFlywheel::TaskConfigProperty, nil) (defaults to: nil) —

    Configuration about the model associated with a flywheel.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'comprehend/cfn_flywheel_props.rb', line 17

def initialize(data_access_role_arn:, data_lake_s3_uri:, flywheel_name:, active_model_arn: nil, data_security_config: nil, model_type: nil, tags: nil, task_config: nil)
  @data_access_role_arn = data_access_role_arn
  Jsii::Type.check_type(@data_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataAccessRoleArn")
  @data_lake_s3_uri = data_lake_s3_uri
  Jsii::Type.check_type(@data_lake_s3_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataLakeS3Uri")
  @flywheel_name = flywheel_name
  Jsii::Type.check_type(@flywheel_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "flywheelName")
  @active_model_arn = active_model_arn
  Jsii::Type.check_type(@active_model_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "activeModelArn") unless @active_model_arn.nil?
  @data_security_config = data_security_config.is_a?(Hash) ? ::AWSCDK::Comprehend::CfnFlywheel::DataSecurityConfigProperty.new(**data_security_config.transform_keys(&:to_sym)) : data_security_config
  Jsii::Type.check_type(@data_security_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb21wcmVoZW5kLkNmbkZseXdoZWVsLkRhdGFTZWN1cml0eUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "dataSecurityConfig") unless @data_security_config.nil?
  @model_type = model_type
  Jsii::Type.check_type(@model_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelType") unless @model_type.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @task_config = task_config.is_a?(Hash) ? ::AWSCDK::Comprehend::CfnFlywheel::TaskConfigProperty.new(**task_config.transform_keys(&:to_sym)) : task_config
  Jsii::Type.check_type(@task_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb21wcmVoZW5kLkNmbkZseXdoZWVsLlRhc2tDb25maWdQcm9wZXJ0eSJ9XX19")), "taskConfig") unless @task_config.nil?
end

Instance Attribute Details

#active_model_arn ⇒ String? (readonly)

The Amazon Resource Number (ARN) of the active model version.

Returns:

  • (String, nil)

See Also:



55
56
57
 
# File 'comprehend/cfn_flywheel_props.rb', line 55

def active_model_arn
  @active_model_arn
end

#data_access_role_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'comprehend/cfn_flywheel_props.rb', line 40

def data_access_role_arn
  @data_access_role_arn
end

#data_lake_s3_uri ⇒ String (readonly)

Amazon S3 URI of the data lake location.

Returns:

  • (String)

See Also:



45
46
47
 
# File 'comprehend/cfn_flywheel_props.rb', line 45

def data_lake_s3_uri
  @data_lake_s3_uri
end

#data_security_config ⇒ AWSCDK::IResolvable, ... (readonly)

Data security configuration.

Returns:

See Also:



60
61
62
 
# File 'comprehend/cfn_flywheel_props.rb', line 60

def data_security_config
  @data_security_config
end

#flywheel_name ⇒ String (readonly)

Name for the flywheel.

Returns:

  • (String)

See Also:



50
51
52
 
# File 'comprehend/cfn_flywheel_props.rb', line 50

def flywheel_name
  @flywheel_name
end

#model_type ⇒ String? (readonly)

Model type of the flywheel's model.

Returns:

  • (String, nil)

See Also:



65
66
67
 
# File 'comprehend/cfn_flywheel_props.rb', line 65

def model_type
  @model_type
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Tags associated with the endpoint being created.

A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.

Returns:

See Also:



72
73
74
 
# File 'comprehend/cfn_flywheel_props.rb', line 72

def tags
  @tags
end

#task_config ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration about the model associated with a flywheel.

Returns:

See Also:



77
78
79
 
# File 'comprehend/cfn_flywheel_props.rb', line 77

def task_config
  @task_config
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'comprehend/cfn_flywheel_props.rb', line 79

def self.jsii_properties
  {
    :data_access_role_arn => "dataAccessRoleArn",
    :data_lake_s3_uri => "dataLakeS3Uri",
    :flywheel_name => "flywheelName",
    :active_model_arn => "activeModelArn",
    :data_security_config => "dataSecurityConfig",
    :model_type => "modelType",
    :tags => "tags",
    :task_config => "taskConfig",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'comprehend/cfn_flywheel_props.rb', line 92

def to_jsii
  result = {}
  result.merge!({
    "dataAccessRoleArn" => @data_access_role_arn,
    "dataLakeS3Uri" => @data_lake_s3_uri,
    "flywheelName" => @flywheel_name,
    "activeModelArn" => @active_model_arn,
    "dataSecurityConfig" => @data_security_config,
    "modelType" => @model_type,
    "tags" => @tags,
    "taskConfig" => @task_config,
  })
  result.compact
end