Class: AWSCDK::Comprehend::CfnDocumentClassifier

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSComprehend::IDocumentClassifierRef
Defined in:
comprehend/cfn_document_classifier.rb

Overview

This resource creates and trains a document classifier to categorize documents.

You provide a set of training documents that are labeled with the categories that you want to identify. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDocumentClassifier

Create a new AWS::Comprehend::DocumentClassifier.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Comprehend::CfnDocumentClassifierProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'comprehend/cfn_document_classifier.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Comprehend::CfnDocumentClassifierProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29tcHJlaGVuZC5DZm5Eb2N1bWVudENsYXNzaWZpZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_document_classifier(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'comprehend/cfn_document_classifier.rb', line 85

def self.arn_for_document_classifier(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb21wcmVoZW5kLklEb2N1bWVudENsYXNzaWZpZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_comprehend.CfnDocumentClassifier", "arnForDocumentClassifier", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


192
193
194
 
# File 'comprehend/cfn_document_classifier.rb', line 192

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_comprehend.CfnDocumentClassifier", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_document_classifier(x) ⇒ Boolean

Checks whether the given object is a CfnDocumentClassifier.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


94
95
96
97
 
# File 'comprehend/cfn_document_classifier.rb', line 94

def self.is_cfn_document_classifier(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_comprehend.CfnDocumentClassifier", "isCfnDocumentClassifier", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'comprehend/cfn_document_classifier.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :document_classifier_ref => { kind: :property, name: "documentClassifierRef", is_optional: false },
    :data_access_role_arn => { kind: :property, name: "dataAccessRoleArn", is_optional: false },
    :document_classifier_name => { kind: :property, name: "documentClassifierName", is_optional: false },
    :input_data_config => { kind: :property, name: "inputDataConfig", is_optional: false },
    :language_code => { kind: :property, name: "languageCode", is_optional: false },
    :mode => { kind: :property, name: "mode", is_optional: true },
    :model_kms_key_id => { kind: :property, name: "modelKmsKeyId", is_optional: true },
    :model_policy => { kind: :property, name: "modelPolicy", is_optional: true },
    :output_data_config => { kind: :property, name: "outputDataConfig", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :version_name => { kind: :property, name: "versionName", is_optional: true },
    :volume_kms_key_id => { kind: :property, name: "volumeKmsKeyId", is_optional: true },
    :vpc_config => { kind: :property, name: "vpcConfig", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



401
402
403
404
 
# File 'comprehend/cfn_document_classifier.rb', line 401

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



413
414
415
416
 
# File 'comprehend/cfn_document_classifier.rb', line 413

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



423
424
425
426
 
# File 'comprehend/cfn_document_classifier.rb', line 423

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



434
435
436
437
438
 
# File 'comprehend/cfn_document_classifier.rb', line 434

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


491
492
493
494
495
 
# File 'comprehend/cfn_document_classifier.rb', line 491

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



501
502
503
504
 
# File 'comprehend/cfn_document_classifier.rb', line 501

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



513
514
515
516
517
 
# File 'comprehend/cfn_document_classifier.rb', line 513

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



526
527
528
529
 
# File 'comprehend/cfn_document_classifier.rb', line 526

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



548
549
550
551
552
553
 
# File 'comprehend/cfn_document_classifier.rb', line 548

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the document classifier.

Returns:

  • (String) 


199
200
201
 
# File 'comprehend/cfn_document_classifier.rb', line 199

def attr_arn()
  jsii_get_property("attrArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



206
207
208
 
# File 'comprehend/cfn_document_classifier.rb', line 206

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



145
146
147
 
# File 'comprehend/cfn_document_classifier.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


150
151
152
 
# File 'comprehend/cfn_document_classifier.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


557
558
559
560
 
# File 'comprehend/cfn_document_classifier.rb', line 557

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


155
156
157
 
# File 'comprehend/cfn_document_classifier.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


162
163
164
 
# File 'comprehend/cfn_document_classifier.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


107
108
109
 
# File 'comprehend/cfn_document_classifier.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Returns:

  • (String) 


220
221
222
 
# File 'comprehend/cfn_document_classifier.rb', line 220

def data_access_role_arn()
  jsii_get_property("dataAccessRoleArn")
end

#data_access_role_arn=(value) ⇒ Object 



224
225
226
227
 
# File 'comprehend/cfn_document_classifier.rb', line 224

def data_access_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataAccessRoleArn")
  jsii_set_property("dataAccessRoleArn", value)
end

#document_classifier_name ⇒ String

The name of the document classifier.

Returns:

  • (String) 


232
233
234
 
# File 'comprehend/cfn_document_classifier.rb', line 232

def document_classifier_name()
  jsii_get_property("documentClassifierName")
end

#document_classifier_name=(value) ⇒ Object 



236
237
238
239
 
# File 'comprehend/cfn_document_classifier.rb', line 236

def document_classifier_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "documentClassifierName")
  jsii_set_property("documentClassifierName", value)
end

#document_classifier_ref ⇒ AWSCDK::Interfaces::AWSComprehend::DocumentClassifierReference

A reference to a DocumentClassifier resource.

Returns:



213
214
215
 
# File 'comprehend/cfn_document_classifier.rb', line 213

def document_classifier_ref()
  jsii_get_property("documentClassifierRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



167
168
169
 
# File 'comprehend/cfn_document_classifier.rb', line 167

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



570
571
572
573
574
 
# File 'comprehend/cfn_document_classifier.rb', line 570

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



581
582
583
584
 
# File 'comprehend/cfn_document_classifier.rb', line 581

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#input_data_config ⇒ AWSCDK::IResolvable, AWSCDK::Comprehend::CfnDocumentClassifier::DocumentClassifierInputDataConfigProperty

Specifies the format and location of the input data for the job.

Returns:



244
245
246
 
# File 'comprehend/cfn_document_classifier.rb', line 244

def input_data_config()
  jsii_get_property("inputDataConfig")
end

#input_data_config=(value) ⇒ Object 



248
249
250
251
252
 
# File 'comprehend/cfn_document_classifier.rb', line 248

def input_data_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Comprehend::CfnDocumentClassifier::DocumentClassifierInputDataConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb21wcmVoZW5kLkNmbkRvY3VtZW50Q2xhc3NpZmllci5Eb2N1bWVudENsYXNzaWZpZXJJbnB1dERhdGFDb25maWdQcm9wZXJ0eSJ9XX19")), "inputDataConfig")
  jsii_set_property("inputDataConfig", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



651
652
653
654
 
# File 'comprehend/cfn_document_classifier.rb', line 651

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#language_code ⇒ String

The language of the input documents.

Returns:

  • (String) 


257
258
259
 
# File 'comprehend/cfn_document_classifier.rb', line 257

def language_code()
  jsii_get_property("languageCode")
end

#language_code=(value) ⇒ Object 



261
262
263
264
 
# File 'comprehend/cfn_document_classifier.rb', line 261

def language_code=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "languageCode")
  jsii_set_property("languageCode", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


119
120
121
 
# File 'comprehend/cfn_document_classifier.rb', line 119

def logical_id()
  jsii_get_property("logicalId")
end

#mode ⇒ String?

Indicates the mode in which the classifier will be trained.

Returns:

  • (String, nil) 


269
270
271
 
# File 'comprehend/cfn_document_classifier.rb', line 269

def mode()
  jsii_get_property("mode")
end

#mode=(value) ⇒ Object 



273
274
275
276
 
# File 'comprehend/cfn_document_classifier.rb', line 273

def mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mode") unless value.nil?
  jsii_set_property("mode", value)
end

#model_kms_key_id ⇒ String?

ID for the AWS key that Amazon Comprehend uses to encrypt trained custom models.

Returns:

  • (String, nil) 


281
282
283
 
# File 'comprehend/cfn_document_classifier.rb', line 281

def model_kms_key_id()
  jsii_get_property("modelKmsKeyId")
end

#model_kms_key_id=(value) ⇒ Object 



285
286
287
288
 
# File 'comprehend/cfn_document_classifier.rb', line 285

def model_kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelKmsKeyId") unless value.nil?
  jsii_set_property("modelKmsKeyId", value)
end

#model_policy ⇒ String?

The resource-based policy to attach to your custom document classifier model.

Returns:

  • (String, nil) 


293
294
295
 
# File 'comprehend/cfn_document_classifier.rb', line 293

def model_policy()
  jsii_get_property("modelPolicy")
end

#model_policy=(value) ⇒ Object 



297
298
299
300
 
# File 'comprehend/cfn_document_classifier.rb', line 297

def model_policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelPolicy") unless value.nil?
  jsii_set_property("modelPolicy", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


102
103
104
 
# File 'comprehend/cfn_document_classifier.rb', line 102

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



592
593
594
 
# File 'comprehend/cfn_document_classifier.rb', line 592

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



599
600
601
 
# File 'comprehend/cfn_document_classifier.rb', line 599

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#output_data_config ⇒ AWSCDK::IResolvable, ...

Provides output results configuration parameters for custom classifier jobs.

Returns:



305
306
307
 
# File 'comprehend/cfn_document_classifier.rb', line 305

def output_data_config()
  jsii_get_property("outputDataConfig")
end

#output_data_config=(value) ⇒ Object 



309
310
311
312
313
 
# File 'comprehend/cfn_document_classifier.rb', line 309

def output_data_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Comprehend::CfnDocumentClassifier::DocumentClassifierOutputDataConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb21wcmVoZW5kLkNmbkRvY3VtZW50Q2xhc3NpZmllci5Eb2N1bWVudENsYXNzaWZpZXJPdXRwdXREYXRhQ29uZmlnUHJvcGVydHkifV19fQ==")), "outputDataConfig") unless value.nil?
  jsii_set_property("outputDataConfig", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



392
393
394
395
 
# File 'comprehend/cfn_document_classifier.rb', line 392

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


138
139
140
 
# File 'comprehend/cfn_document_classifier.rb', line 138

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



610
611
612
613
 
# File 'comprehend/cfn_document_classifier.rb', line 610

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


617
618
619
620
 
# File 'comprehend/cfn_document_classifier.rb', line 617

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



627
628
629
630
631
 
# File 'comprehend/cfn_document_classifier.rb', line 627

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



636
637
638
 
# File 'comprehend/cfn_document_classifier.rb', line 636

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



128
129
130
 
# File 'comprehend/cfn_document_classifier.rb', line 128

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

Tags to associate with the document classifier.

Returns:



318
319
320
 
# File 'comprehend/cfn_document_classifier.rb', line 318

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



322
323
324
325
326
 
# File 'comprehend/cfn_document_classifier.rb', line 322

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



368
369
370
 
# File 'comprehend/cfn_document_classifier.rb', line 368

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


175
176
177
 
# File 'comprehend/cfn_document_classifier.rb', line 175

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


185
186
187
 
# File 'comprehend/cfn_document_classifier.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


642
643
644
645
 
# File 'comprehend/cfn_document_classifier.rb', line 642

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#version_name ⇒ String?

The version name given to the newly created classifier.

Returns:

  • (String, nil) 


331
332
333
 
# File 'comprehend/cfn_document_classifier.rb', line 331

def version_name()
  jsii_get_property("versionName")
end

#version_name=(value) ⇒ Object 



335
336
337
338
 
# File 'comprehend/cfn_document_classifier.rb', line 335

def version_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionName") unless value.nil?
  jsii_set_property("versionName", value)
end

#volume_kms_key_id ⇒ String?

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.

Returns:

  • (String, nil) 


343
344
345
 
# File 'comprehend/cfn_document_classifier.rb', line 343

def volume_kms_key_id()
  jsii_get_property("volumeKmsKeyId")
end

#volume_kms_key_id=(value) ⇒ Object 



347
348
349
350
 
# File 'comprehend/cfn_document_classifier.rb', line 347

def volume_kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "volumeKmsKeyId") unless value.nil?
  jsii_set_property("volumeKmsKeyId", value)
end

#vpc_config ⇒ AWSCDK::IResolvable, ...

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

Returns:



355
356
357
 
# File 'comprehend/cfn_document_classifier.rb', line 355

def vpc_config()
  jsii_get_property("vpcConfig")
end

#vpc_config=(value) ⇒ Object 



359
360
361
362
363
 
# File 'comprehend/cfn_document_classifier.rb', line 359

def vpc_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Comprehend::CfnDocumentClassifier::VPCConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb21wcmVoZW5kLkNmbkRvY3VtZW50Q2xhc3NpZmllci5WcGNDb25maWdQcm9wZXJ0eSJ9XX19")), "vpcConfig") unless value.nil?
  jsii_set_property("vpcConfig", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


381
382
383
384
385
386
 
# File 'comprehend/cfn_document_classifier.rb', line 381

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end