Class: AWSCDK::HealthLake::CfnFHIRDatastore

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSHealthlake::IFHIRDatastoreRef
Defined in:
health_lake/cfn_fhir_datastore.rb

Overview

Creates a Data Store that can ingest and export FHIR formatted data.

Please note that when a user tries to do an Update operation via CloudFormation, changes to the Data Store name, Type Version, PreloadDataConfig, or SSEConfiguration will delete their existing Data Store for the stack and create a new one. This will lead to potential loss of data.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFHIRDatastore

Create a new AWS::HealthLake::FHIRDatastore.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::HealthLake::CfnFHIRDatastoreProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'health_lake/cfn_fhir_datastore.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::HealthLake::CfnFHIRDatastoreProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaGVhbHRobGFrZS5DZm5GSElSRGF0YXN0b3JlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_fhir_datastore(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'health_lake/cfn_fhir_datastore.rb', line 85

def self.arn_for_fhir_datastore(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19oZWFsdGhsYWtlLklGSElSRGF0YXN0b3JlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_healthlake.CfnFHIRDatastore", "arnForFHIRDatastore", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


218
219
220
 
# File 'health_lake/cfn_fhir_datastore.rb', line 218

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

.from_datastore_id(scope, id, datastore_id) ⇒ AWSCDK::Interfaces::AWSHealthlake::IFHIRDatastoreRef

Creates a new IFHIRDatastoreRef from a datastoreId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • datastore_id (String)

Returns:



96
97
98
99
100
101
 
# File 'health_lake/cfn_fhir_datastore.rb', line 96

def self.from_datastore_id(scope, id, datastore_id)
  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(datastore_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datastoreId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_healthlake.CfnFHIRDatastore", "fromDatastoreId", [scope, id, datastore_id])
end

.from_fhir_datastore_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSHealthlake::IFHIRDatastoreRef

Creates a new IFHIRDatastoreRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



109
110
111
112
113
114
 
# File 'health_lake/cfn_fhir_datastore.rb', line 109

def self.from_fhir_datastore_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_healthlake.CfnFHIRDatastore", "fromFHIRDatastoreArn", [scope, id, arn])
end

.is_cfn_fhir_datastore(x) ⇒ Boolean

Checks whether the given object is a CfnFHIRDatastore.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


120
121
122
123
 
# File 'health_lake/cfn_fhir_datastore.rb', line 120

def self.is_cfn_fhir_datastore(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_healthlake.CfnFHIRDatastore", "isCfnFHIRDatastore", [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 'health_lake/cfn_fhir_datastore.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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_created_at_nanos => { kind: :property, name: "attrCreatedAtNanos", is_optional: false },
    :attr_created_at_seconds => { kind: :property, name: "attrCreatedAtSeconds", is_optional: false },
    :attr_datastore_arn => { kind: :property, name: "attrDatastoreArn", is_optional: false },
    :attr_datastore_endpoint => { kind: :property, name: "attrDatastoreEndpoint", is_optional: false },
    :attr_datastore_id => { kind: :property, name: "attrDatastoreId", is_optional: false },
    :attr_datastore_status => { kind: :property, name: "attrDatastoreStatus", is_optional: false },
    :fhir_datastore_ref => { kind: :property, name: "fhirDatastoreRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :datastore_type_version => { kind: :property, name: "datastoreTypeVersion", is_optional: false },
    :datastore_name => { kind: :property, name: "datastoreName", is_optional: true },
    :identity_provider_configuration => { kind: :property, name: "identityProviderConfiguration", is_optional: true },
    :preload_data_config => { kind: :property, name: "preloadDataConfig", is_optional: true },
    :sse_configuration => { kind: :property, name: "sseConfiguration", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



397
398
399
400
 
# File 'health_lake/cfn_fhir_datastore.rb', line 397

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:



409
410
411
412
 
# File 'health_lake/cfn_fhir_datastore.rb', line 409

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:



419
420
421
422
 
# File 'health_lake/cfn_fhir_datastore.rb', line 419

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:



430
431
432
433
434
 
# File 'health_lake/cfn_fhir_datastore.rb', line 430

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.


487
488
489
490
491
 
# File 'health_lake/cfn_fhir_datastore.rb', line 487

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.



497
498
499
500
 
# File 'health_lake/cfn_fhir_datastore.rb', line 497

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.



509
510
511
512
513
 
# File 'health_lake/cfn_fhir_datastore.rb', line 509

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:



522
523
524
525
 
# File 'health_lake/cfn_fhir_datastore.rb', line 522

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:



544
545
546
547
548
549
 
# File 'health_lake/cfn_fhir_datastore.rb', line 544

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_created_at ⇒ AWSCDK::IResolvable

The time that a Data Store was created.

Returns:



225
226
227
 
# File 'health_lake/cfn_fhir_datastore.rb', line 225

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_created_at_nanos ⇒ Numeric

Returns:

  • (Numeric) 


230
231
232
 
# File 'health_lake/cfn_fhir_datastore.rb', line 230

def attr_created_at_nanos()
  jsii_get_property("attrCreatedAtNanos")
end

#attr_created_at_seconds ⇒ String

Returns:

  • (String) 


235
236
237
 
# File 'health_lake/cfn_fhir_datastore.rb', line 235

def attr_created_at_seconds()
  jsii_get_property("attrCreatedAtSeconds")
end

#attr_datastore_arn ⇒ String

The Data Store ARN is generated during the creation of the Data Store and can be found in the output from the initial Data Store creation request.

Returns:

  • (String) 


242
243
244
 
# File 'health_lake/cfn_fhir_datastore.rb', line 242

def attr_datastore_arn()
  jsii_get_property("attrDatastoreArn")
end

#attr_datastore_endpoint ⇒ String

The endpoint for the created Data Store.

Returns:

  • (String) 


249
250
251
 
# File 'health_lake/cfn_fhir_datastore.rb', line 249

def attr_datastore_endpoint()
  jsii_get_property("attrDatastoreEndpoint")
end

#attr_datastore_id ⇒ String

The Amazon generated Data Store id.

This id is in the output from the initial Data Store creation call.

Returns:

  • (String) 


258
259
260
 
# File 'health_lake/cfn_fhir_datastore.rb', line 258

def attr_datastore_id()
  jsii_get_property("attrDatastoreId")
end

#attr_datastore_status ⇒ String

The status of the FHIR Data Store.

Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.

Returns:

  • (String) 


267
268
269
 
# File 'health_lake/cfn_fhir_datastore.rb', line 267

def attr_datastore_status()
  jsii_get_property("attrDatastoreStatus")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



171
172
173
 
# File 'health_lake/cfn_fhir_datastore.rb', line 171

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


176
177
178
 
# File 'health_lake/cfn_fhir_datastore.rb', line 176

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


553
554
555
556
 
# File 'health_lake/cfn_fhir_datastore.rb', line 553

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}) 


181
182
183
 
# File 'health_lake/cfn_fhir_datastore.rb', line 181

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


188
189
190
 
# File 'health_lake/cfn_fhir_datastore.rb', line 188

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


133
134
135
 
# File 'health_lake/cfn_fhir_datastore.rb', line 133

def creation_stack()
  jsii_get_property("creationStack")
end

#datastore_name ⇒ String?

The data store name (user-generated).

Returns:

  • (String, nil) 


300
301
302
 
# File 'health_lake/cfn_fhir_datastore.rb', line 300

def datastore_name()
  jsii_get_property("datastoreName")
end

#datastore_name=(value) ⇒ Object 



304
305
306
307
 
# File 'health_lake/cfn_fhir_datastore.rb', line 304

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

#datastore_type_version ⇒ String

The FHIR release version supported by the data store.

Returns:

  • (String) 


288
289
290
 
# File 'health_lake/cfn_fhir_datastore.rb', line 288

def datastore_type_version()
  jsii_get_property("datastoreTypeVersion")
end

#datastore_type_version=(value) ⇒ Object 



292
293
294
295
 
# File 'health_lake/cfn_fhir_datastore.rb', line 292

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



193
194
195
 
# File 'health_lake/cfn_fhir_datastore.rb', line 193

def env()
  jsii_get_property("env")
end

#fhir_datastore_ref ⇒ AWSCDK::Interfaces::AWSHealthlake::FHIRDatastoreReference

A reference to a FHIRDatastore resource.

Returns:



274
275
276
 
# File 'health_lake/cfn_fhir_datastore.rb', line 274

def fhir_datastore_ref()
  jsii_get_property("fhirDatastoreRef")
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:



566
567
568
569
570
 
# File 'health_lake/cfn_fhir_datastore.rb', line 566

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:



577
578
579
580
 
# File 'health_lake/cfn_fhir_datastore.rb', line 577

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

#identity_provider_configuration ⇒ AWSCDK::IResolvable, ...

The identity provider configuration selected when the data store was created.

Returns:



312
313
314
 
# File 'health_lake/cfn_fhir_datastore.rb', line 312

def identity_provider_configuration()
  jsii_get_property("identityProviderConfiguration")
end

#identity_provider_configuration=(value) ⇒ Object 



316
317
318
319
320
 
# File 'health_lake/cfn_fhir_datastore.rb', line 316

def identity_provider_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::HealthLake::CfnFHIRDatastore::IdentityProviderConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19oZWFsdGhsYWtlLkNmbkZISVJEYXRhc3RvcmUuSWRlbnRpdHlQcm92aWRlckNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "identityProviderConfiguration") unless value.nil?
  jsii_set_property("identityProviderConfiguration", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



647
648
649
650
 
# File 'health_lake/cfn_fhir_datastore.rb', line 647

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


145
146
147
 
# File 'health_lake/cfn_fhir_datastore.rb', line 145

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


128
129
130
 
# File 'health_lake/cfn_fhir_datastore.rb', line 128

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:



588
589
590
 
# File 'health_lake/cfn_fhir_datastore.rb', line 588

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:



595
596
597
 
# File 'health_lake/cfn_fhir_datastore.rb', line 595

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
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.



388
389
390
391
 
# File 'health_lake/cfn_fhir_datastore.rb', line 388

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

#preload_data_config ⇒ AWSCDK::IResolvable, ...

The preloaded Synthea data configuration for the data store.

Returns:



325
326
327
 
# File 'health_lake/cfn_fhir_datastore.rb', line 325

def preload_data_config()
  jsii_get_property("preloadDataConfig")
end

#preload_data_config=(value) ⇒ Object 



329
330
331
332
333
 
# File 'health_lake/cfn_fhir_datastore.rb', line 329

def preload_data_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::HealthLake::CfnFHIRDatastore::PreloadDataConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19oZWFsdGhsYWtlLkNmbkZISVJEYXRhc3RvcmUuUHJlbG9hZERhdGFDb25maWdQcm9wZXJ0eSJ9XX19")), "preloadDataConfig") unless value.nil?
  jsii_set_property("preloadDataConfig", value)
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) 


164
165
166
 
# File 'health_lake/cfn_fhir_datastore.rb', line 164

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:



606
607
608
609
 
# File 'health_lake/cfn_fhir_datastore.rb', line 606

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}) 


613
614
615
616
 
# File 'health_lake/cfn_fhir_datastore.rb', line 613

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:



623
624
625
626
627
 
# File 'health_lake/cfn_fhir_datastore.rb', line 623

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.



632
633
634
 
# File 'health_lake/cfn_fhir_datastore.rb', line 632

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

#sse_configuration ⇒ AWSCDK::IResolvable, ...

The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.

Returns:



338
339
340
 
# File 'health_lake/cfn_fhir_datastore.rb', line 338

def sse_configuration()
  jsii_get_property("sseConfiguration")
end

#sse_configuration=(value) ⇒ Object 



342
343
344
345
346
 
# File 'health_lake/cfn_fhir_datastore.rb', line 342

def sse_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::HealthLake::CfnFHIRDatastore::SseConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19oZWFsdGhsYWtlLkNmbkZISVJEYXRhc3RvcmUuU3NlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "sseConfiguration") unless value.nil?
  jsii_set_property("sseConfiguration", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



154
155
156
 
# File 'health_lake/cfn_fhir_datastore.rb', line 154

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



281
282
283
 
# File 'health_lake/cfn_fhir_datastore.rb', line 281

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



351
352
353
 
# File 'health_lake/cfn_fhir_datastore.rb', line 351

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



355
356
357
358
359
 
# File 'health_lake/cfn_fhir_datastore.rb', line 355

def tags_raw=(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=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



364
365
366
 
# File 'health_lake/cfn_fhir_datastore.rb', line 364

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}) 


201
202
203
 
# File 'health_lake/cfn_fhir_datastore.rb', line 201

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}) 


211
212
213
 
# File 'health_lake/cfn_fhir_datastore.rb', line 211

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


638
639
640
641
 
# File 'health_lake/cfn_fhir_datastore.rb', line 638

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


377
378
379
380
381
382
 
# File 'health_lake/cfn_fhir_datastore.rb', line 377

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