Class: AWSCDK::Omics::CfnSequenceStore

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSOmics::ISequenceStoreRef
Defined in:
omics/cfn_sequence_store.rb

Overview

Creates a sequence store.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnSequenceStore

Create a new AWS::Omics::SequenceStore.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Omics::CfnSequenceStoreProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'omics/cfn_sequence_store.rb', line 18

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

Class Method Details

.arn_for_sequence_store(resource) ⇒ String

Parameters:

Returns:

  • (String) 


87
88
89
90
 
# File 'omics/cfn_sequence_store.rb', line 87

def self.arn_for_sequence_store(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19vbWljcy5JU2VxdWVuY2VTdG9yZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_omics.CfnSequenceStore", "arnForSequenceStore", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


220
221
222
 
# File 'omics/cfn_sequence_store.rb', line 220

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

.from_sequence_store_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSOmics::ISequenceStoreRef

Creates a new ISequenceStoreRef from an ARN.

Parameters:

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

Returns:



98
99
100
101
102
103
 
# File 'omics/cfn_sequence_store.rb', line 98

def self.from_sequence_store_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_omics.CfnSequenceStore", "fromSequenceStoreArn", [scope, id, arn])
end

.from_sequence_store_id(scope, id, sequence_store_id) ⇒ AWSCDK::Interfaces::AWSOmics::ISequenceStoreRef

Creates a new ISequenceStoreRef from a sequenceStoreId.

Parameters:

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

Returns:



111
112
113
114
115
116
 
# File 'omics/cfn_sequence_store.rb', line 111

def self.from_sequence_store_id(scope, id, sequence_store_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(sequence_store_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sequenceStoreId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_omics.CfnSequenceStore", "fromSequenceStoreId", [scope, id, sequence_store_id])
end

.is_cfn_sequence_store(x) ⇒ Boolean

Checks whether the given object is a CfnSequenceStore.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


122
123
124
125
 
# File 'omics/cfn_sequence_store.rb', line 122

def self.is_cfn_sequence_store(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_omics.CfnSequenceStore", "isCfnSequenceStore", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
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
82
83
 
# File 'omics/cfn_sequence_store.rb', line 26

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 },
    :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_s3_access_point_arn => { kind: :property, name: "attrS3AccessPointArn", is_optional: false },
    :attr_s3_uri => { kind: :property, name: "attrS3Uri", is_optional: false },
    :attr_sequence_store_id => { kind: :property, name: "attrSequenceStoreId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_message => { kind: :property, name: "attrStatusMessage", is_optional: false },
    :attr_update_time => { kind: :property, name: "attrUpdateTime", is_optional: false },
    :sequence_store_ref => { kind: :property, name: "sequenceStoreRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :s3_access_policy => { kind: :property, name: "s3AccessPolicy", is_optional: false },
    :access_log_location => { kind: :property, name: "accessLogLocation", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :e_tag_algorithm_family => { kind: :property, name: "eTagAlgorithmFamily", is_optional: true },
    :fallback_location => { kind: :property, name: "fallbackLocation", is_optional: true },
    :propagated_set_level_tags => { kind: :property, name: "propagatedSetLevelTags", is_optional: true },
    :sse_config => { kind: :property, name: "sseConfig", 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

#access_log_location ⇒ String?

Location of the access logs.

Returns:

  • (String, nil) 


321
322
323
 
# File 'omics/cfn_sequence_store.rb', line 321

def access_log_location()
  jsii_get_property("accessLogLocation")
end

#access_log_location=(value) ⇒ Object 



325
326
327
328
 
# File 'omics/cfn_sequence_store.rb', line 325

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

#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.



439
440
441
442
 
# File 'omics/cfn_sequence_store.rb', line 439

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:



451
452
453
454
 
# File 'omics/cfn_sequence_store.rb', line 451

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:



461
462
463
464
 
# File 'omics/cfn_sequence_store.rb', line 461

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:



472
473
474
475
476
 
# File 'omics/cfn_sequence_store.rb', line 472

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.


529
530
531
532
533
 
# File 'omics/cfn_sequence_store.rb', line 529

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.



539
540
541
542
 
# File 'omics/cfn_sequence_store.rb', line 539

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.



551
552
553
554
555
 
# File 'omics/cfn_sequence_store.rb', line 551

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:



564
565
566
567
 
# File 'omics/cfn_sequence_store.rb', line 564

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:



586
587
588
589
590
591
 
# File 'omics/cfn_sequence_store.rb', line 586

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 store's ARN.

Returns:

  • (String) 


227
228
229
 
# File 'omics/cfn_sequence_store.rb', line 227

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_creation_time ⇒ String

When the store was created.

Returns:

  • (String) 


234
235
236
 
# File 'omics/cfn_sequence_store.rb', line 234

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_s3_access_point_arn ⇒ String

This is ARN of the access point associated with the S3 bucket storing read sets.

Returns:

  • (String) 


241
242
243
 
# File 'omics/cfn_sequence_store.rb', line 241

def attr_s3_access_point_arn()
  jsii_get_property("attrS3AccessPointArn")
end

#attr_s3_uri ⇒ String

The S3 URI of the sequence store.

Returns:

  • (String) 


248
249
250
 
# File 'omics/cfn_sequence_store.rb', line 248

def attr_s3_uri()
  jsii_get_property("attrS3Uri")
end

#attr_sequence_store_id ⇒ String

The store's ID.

Returns:

  • (String) 


255
256
257
 
# File 'omics/cfn_sequence_store.rb', line 255

def attr_sequence_store_id()
  jsii_get_property("attrSequenceStoreId")
end

#attr_status ⇒ String

Status of the sequence store.

Returns:

  • (String) 


262
263
264
 
# File 'omics/cfn_sequence_store.rb', line 262

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_message ⇒ String

The status message of the sequence store.

Returns:

  • (String) 


269
270
271
 
# File 'omics/cfn_sequence_store.rb', line 269

def attr_status_message()
  jsii_get_property("attrStatusMessage")
end

#attr_update_time ⇒ String

The last-updated time of the Sequence Store.

Returns:

  • (String) 


276
277
278
 
# File 'omics/cfn_sequence_store.rb', line 276

def attr_update_time()
  jsii_get_property("attrUpdateTime")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



173
174
175
 
# File 'omics/cfn_sequence_store.rb', line 173

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


178
179
180
 
# File 'omics/cfn_sequence_store.rb', line 178

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


595
596
597
598
 
# File 'omics/cfn_sequence_store.rb', line 595

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


183
184
185
 
# File 'omics/cfn_sequence_store.rb', line 183

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


190
191
192
 
# File 'omics/cfn_sequence_store.rb', line 190

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


135
136
137
 
# File 'omics/cfn_sequence_store.rb', line 135

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description for the store.

Returns:

  • (String, nil) 


333
334
335
 
# File 'omics/cfn_sequence_store.rb', line 333

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



337
338
339
340
 
# File 'omics/cfn_sequence_store.rb', line 337

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

#e_tag_algorithm_family ⇒ String?

The algorithm family of the ETag.

Returns:

  • (String, nil) 


345
346
347
 
# File 'omics/cfn_sequence_store.rb', line 345

def e_tag_algorithm_family()
  jsii_get_property("eTagAlgorithmFamily")
end

#e_tag_algorithm_family=(value) ⇒ Object 



349
350
351
352
 
# File 'omics/cfn_sequence_store.rb', line 349

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



195
196
197
 
# File 'omics/cfn_sequence_store.rb', line 195

def env()
  jsii_get_property("env")
end

#fallback_location ⇒ String?

An S3 location that is used to store files that have failed a direct upload.

Returns:

  • (String, nil) 


357
358
359
 
# File 'omics/cfn_sequence_store.rb', line 357

def fallback_location()
  jsii_get_property("fallbackLocation")
end

#fallback_location=(value) ⇒ Object 



361
362
363
364
 
# File 'omics/cfn_sequence_store.rb', line 361

def fallback_location=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fallbackLocation") unless value.nil?
  jsii_set_property("fallbackLocation", value)
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:



608
609
610
611
612
 
# File 'omics/cfn_sequence_store.rb', line 608

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:



619
620
621
622
 
# File 'omics/cfn_sequence_store.rb', line 619

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



689
690
691
692
 
# File 'omics/cfn_sequence_store.rb', line 689

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) 


147
148
149
 
# File 'omics/cfn_sequence_store.rb', line 147

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

A name for the store.

Returns:

  • (String) 


297
298
299
 
# File 'omics/cfn_sequence_store.rb', line 297

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



301
302
303
304
 
# File 'omics/cfn_sequence_store.rb', line 301

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


130
131
132
 
# File 'omics/cfn_sequence_store.rb', line 130

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:



630
631
632
 
# File 'omics/cfn_sequence_store.rb', line 630

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:



637
638
639
 
# File 'omics/cfn_sequence_store.rb', line 637

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.



430
431
432
433
 
# File 'omics/cfn_sequence_store.rb', line 430

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

#propagated_set_level_tags ⇒ Array<String>?

The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

Returns:

  • (Array<String>, nil) 


369
370
371
 
# File 'omics/cfn_sequence_store.rb', line 369

def propagated_set_level_tags()
  jsii_get_property("propagatedSetLevelTags")
end

#propagated_set_level_tags=(value) ⇒ Object 



373
374
375
376
 
# File 'omics/cfn_sequence_store.rb', line 373

def propagated_set_level_tags=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "propagatedSetLevelTags") unless value.nil?
  jsii_set_property("propagatedSetLevelTags", 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) 


166
167
168
 
# File 'omics/cfn_sequence_store.rb', line 166

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:



648
649
650
651
 
# File 'omics/cfn_sequence_store.rb', line 648

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


655
656
657
658
 
# File 'omics/cfn_sequence_store.rb', line 655

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:



665
666
667
668
669
 
# File 'omics/cfn_sequence_store.rb', line 665

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

#s3_access_policy ⇒ Object

The resource policy that controls S3 access on the store.

Returns:

  • (Object) 


309
310
311
 
# File 'omics/cfn_sequence_store.rb', line 309

def s3_access_policy()
  jsii_get_property("s3AccessPolicy")
end

#s3_access_policy=(value) ⇒ Object 



313
314
315
316
 
# File 'omics/cfn_sequence_store.rb', line 313

def s3_access_policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "s3AccessPolicy")
  jsii_set_property("s3AccessPolicy", value)
end

#sequence_store_ref ⇒ AWSCDK::Interfaces::AWSOmics::SequenceStoreReference

A reference to a SequenceStore resource.

Returns:



283
284
285
 
# File 'omics/cfn_sequence_store.rb', line 283

def sequence_store_ref()
  jsii_get_property("sequenceStoreRef")
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.



674
675
676
 
# File 'omics/cfn_sequence_store.rb', line 674

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

#sse_config ⇒ AWSCDK::IResolvable, ...

Server-side encryption (SSE) settings for the store.

Returns:



381
382
383
 
# File 'omics/cfn_sequence_store.rb', line 381

def sse_config()
  jsii_get_property("sseConfig")
end

#sse_config=(value) ⇒ Object 



385
386
387
388
389
 
# File 'omics/cfn_sequence_store.rb', line 385

def sse_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Omics::CfnSequenceStore::SseConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vbWljcy5DZm5TZXF1ZW5jZVN0b3JlLlNzZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "sseConfig") unless value.nil?
  jsii_set_property("sseConfig", 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:



156
157
158
 
# File 'omics/cfn_sequence_store.rb', line 156

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



290
291
292
 
# File 'omics/cfn_sequence_store.rb', line 290

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

Tags for the store.

Returns:

  • (Hash{String => String}, nil) 


394
395
396
 
# File 'omics/cfn_sequence_store.rb', line 394

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



398
399
400
401
 
# File 'omics/cfn_sequence_store.rb', line 398

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "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



406
407
408
 
# File 'omics/cfn_sequence_store.rb', line 406

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


203
204
205
 
# File 'omics/cfn_sequence_store.rb', line 203

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


213
214
215
 
# File 'omics/cfn_sequence_store.rb', line 213

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


680
681
682
683
 
# File 'omics/cfn_sequence_store.rb', line 680

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) 


419
420
421
422
423
424
 
# File 'omics/cfn_sequence_store.rb', line 419

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